Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Static Public Member Functions
Quantity_Period Class Reference

Manages date intervals. For example, a Period object
gives the interval between two dates.
A period is expressed in seconds and microseconds.

#include <Quantity_Period.hxx>

Public Member Functions

DEFINE_STANDARD_ALLOC Quantity_Period (const Standard_Integer dd, const Standard_Integer hh, const Standard_Integer mn, const Standard_Integer ss, const Standard_Integer mis=0, const Standard_Integer mics=0)
 Creates a Period
With: 0 <= dd
0 <= hh
0 <= mn
0 <= ss
0 <= mis
0 <= mics

 Quantity_Period (const Standard_Integer ss, const Standard_Integer mics=0)
 Creates a Period with a number of seconds and microseconds.
Exceptions
Quantity_PeriodDefinitionError:

void Values (Standard_Integer &dd, Standard_Integer &hh, Standard_Integer &mn, Standard_Integer &ss, Standard_Integer &mis, Standard_Integer &mics) const
 Decomposes this period into a number of days,hours,
minutes,seconds,milliseconds and microseconds
Example of return values:
2 days, 15 hours, 0 minute , 0 second
0 millisecond and 0 microsecond

void Values (Standard_Integer &ss, Standard_Integer &mics) const
 Returns the number of seconds in Ss and the
number of remainding microseconds in Mics of this period.
Example of return values: 3600 seconds and 0 microseconds

void SetValues (const Standard_Integer dd, const Standard_Integer hh, const Standard_Integer mn, const Standard_Integer ss, const Standard_Integer mis=0, const Standard_Integer mics=0)
 Assigns to this period the time interval defined

void SetValues (const Standard_Integer ss, const Standard_Integer mics=0)
 Assigns to this period the time interval defined

Quantity_Period Subtract (const Quantity_Period &anOther) const
 Subtracts one Period from another and returns the difference.

Quantity_Period operator- (const Quantity_Period &anOther) const
Quantity_Period Add (const Quantity_Period &anOther) const
 Adds one Period to another one.

Quantity_Period operator+ (const Quantity_Period &anOther) const
Standard_Boolean IsEqual (const Quantity_Period &anOther) const
 Returns TRUE if both <me> and <other> are equal.

Standard_Boolean operator== (const Quantity_Period &anOther) const
Standard_Boolean IsShorter (const Quantity_Period &anOther) const
 Returns TRUE if <me> is shorter than <other>.

Standard_Boolean operator< (const Quantity_Period &anOther) const
Standard_Boolean IsLonger (const Quantity_Period &anOther) const
 Returns TRUE if <me> is longer then <other>.

Standard_Boolean operator> (const Quantity_Period &anOther) const
 Quantity_Period ()
Standard_Integer _CSFDB_GetQuantity_PeriodmySec () const
void _CSFDB_SetQuantity_PeriodmySec (const Standard_Integer p)
Standard_Integer _CSFDB_GetQuantity_PeriodmyUSec () const
void _CSFDB_SetQuantity_PeriodmyUSec (const Standard_Integer p)

Static Public Member Functions

static Standard_Boolean IsValid (const Standard_Integer dd, const Standard_Integer hh, const Standard_Integer mn, const Standard_Integer ss, const Standard_Integer mis=0, const Standard_Integer mics=0)
 Checks the validity of a Period in form (dd,hh,mn,ss,mil,mic)
With: 0 <= dd
0 <= hh
0 <= mn
0 <= ss
0 <= mis
0 <= mics

static Standard_Boolean IsValid (const Standard_Integer ss, const Standard_Integer mics=0)
 Checks the validity of a Period in form (ss,mic)
With: 0 <= ss
0 <= mics


Constructor & Destructor Documentation

  • if the number of seconds expressed either by:
    • dd days, hh hours, mn minutes and ss seconds, or
    • Ss
      is less than 0.
  • if the number of microseconds expressed either by:
    • mis milliseconds and mics microseconds, or
    • Mics
      is less than 0.

Member Function Documentation

Quantity_Period Quantity_Period::operator+ ( const Quantity_Period anOther) const [inline]
Quantity_Period Quantity_Period::operator- ( const Quantity_Period anOther) const [inline]
Standard_Boolean Quantity_Period::operator< ( const Quantity_Period anOther) const [inline]
Standard_Boolean Quantity_Period::operator== ( const Quantity_Period anOther) const [inline]
Standard_Boolean Quantity_Period::operator> ( const Quantity_Period anOther) const [inline]
  • with dd days, hh hours, mn minutes, ss
    seconds, mis (defaulted to 0) milliseconds and
    mics (defaulted to 0) microseconds; or
  • with Ss seconds and Mics (defaulted to 0) microseconds.
    Exceptions
    Quantity_PeriodDefinitionError:
  • if the number of seconds expressed either by:
    • dd days, hh hours, mn minutes and ss seconds, or
    • Ss
      is less than 0.
  • if the number of microseconds expressed either by:
    • mis milliseconds and mics microseconds, or
    • Mics
      is less than 0.

The documentation for this class was generated from the following file: