Open CASCADE Technology Reference Manual 8.0.0
Loading...
Searching...
No Matches
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. More...

#include <Quantity_Period.hxx>

Public Member Functions

 Quantity_Period (const int dd, const int hh, const int mn, const int ss, const int mis=0, const int mics=0)
 Creates a Period With: 0 <= dd 0 <= hh 0 <= mn 0 <= ss 0 <= mis 0 <= mics.
 
 Quantity_Period (const int ss, const int mics=0)
 Creates a Period with a number of seconds and microseconds. Exceptions Quantity_PeriodDefinitionError:
 
void Values (int &dd, int &hh, int &mn, int &ss, int &mis, int &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 (int &ss, int &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 int dd, const int hh, const int mn, const int ss, const int mis=0, const int mics=0)
 Assigns to this period the time interval defined.
 
void SetValues (const int ss, const int 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
 
constexpr bool IsEqual (const Quantity_Period &anOther) const noexcept
 Returns TRUE if both <me> and <other> are equal.
 
constexpr bool operator== (const Quantity_Period &anOther) const noexcept
 
constexpr bool IsShorter (const Quantity_Period &anOther) const noexcept
 Returns TRUE if <me> is shorter than <other>.
 
constexpr bool operator< (const Quantity_Period &anOther) const noexcept
 
constexpr bool IsLonger (const Quantity_Period &anOther) const noexcept
 Returns TRUE if <me> is longer then <other>.
 
constexpr bool operator> (const Quantity_Period &anOther) const noexcept
 

Static Public Member Functions

static bool IsValid (const int dd, const int hh, const int mn, const int ss, const int mis=0, const int 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 bool IsValid (const int ss, const int mics=0)
 Checks the validity of a Period in form (ss,mic) With: 0 <= ss 0 <= mics.
 

Detailed Description

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

Constructor & Destructor Documentation

◆ Quantity_Period() [1/2]

Quantity_Period::Quantity_Period ( const int dd,
const int hh,
const int mn,
const int ss,
const int mis = 0,
const int mics = 0 )

Creates a Period With: 0 <= dd 0 <= hh 0 <= mn 0 <= ss 0 <= mis 0 <= mics.

◆ Quantity_Period() [2/2]

Quantity_Period::Quantity_Period ( const int ss,
const int mics = 0 )

Creates a Period with a number of seconds and 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.

Member Function Documentation

◆ Add()

Quantity_Period Quantity_Period::Add ( const Quantity_Period & anOther) const

Adds one Period to another one.

◆ IsEqual()

constexpr bool Quantity_Period::IsEqual ( const Quantity_Period & anOther) const
inlineconstexprnoexcept

Returns TRUE if both <me> and <other> are equal.

◆ IsLonger()

constexpr bool Quantity_Period::IsLonger ( const Quantity_Period & anOther) const
inlineconstexprnoexcept

Returns TRUE if <me> is longer then <other>.

◆ IsShorter()

constexpr bool Quantity_Period::IsShorter ( const Quantity_Period & anOther) const
inlineconstexprnoexcept

Returns TRUE if <me> is shorter than <other>.

◆ IsValid() [1/2]

static bool Quantity_Period::IsValid ( const int dd,
const int hh,
const int mn,
const int ss,
const int mis = 0,
const int mics = 0 )
static

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.

◆ IsValid() [2/2]

static bool Quantity_Period::IsValid ( const int ss,
const int mics = 0 )
static

Checks the validity of a Period in form (ss,mic) With: 0 <= ss 0 <= mics.

◆ operator+()

Quantity_Period Quantity_Period::operator+ ( const Quantity_Period & anOther) const
inline

◆ operator-()

Quantity_Period Quantity_Period::operator- ( const Quantity_Period & anOther) const
inline

◆ operator<()

constexpr bool Quantity_Period::operator< ( const Quantity_Period & anOther) const
inlineconstexprnoexcept

◆ operator==()

constexpr bool Quantity_Period::operator== ( const Quantity_Period & anOther) const
inlineconstexprnoexcept

◆ operator>()

constexpr bool Quantity_Period::operator> ( const Quantity_Period & anOther) const
inlineconstexprnoexcept

◆ SetValues() [1/2]

void Quantity_Period::SetValues ( const int dd,
const int hh,
const int mn,
const int ss,
const int mis = 0,
const int mics = 0 )

Assigns to this period the time interval defined.

  • with dd days, hh hours, mn minutes, ss seconds, mis (defaulted to 0) milliseconds and mics (defaulted to 0) microseconds; or

◆ SetValues() [2/2]

void Quantity_Period::SetValues ( const int ss,
const int mics = 0 )

Assigns to this period the time interval defined.

  • 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.

◆ Subtract()

Quantity_Period Quantity_Period::Subtract ( const Quantity_Period & anOther) const

Subtracts one Period from another and returns the difference.

◆ Values() [1/2]

void Quantity_Period::Values ( int & dd,
int & hh,
int & mn,
int & ss,
int & mis,
int & 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.

◆ Values() [2/2]

void Quantity_Period::Values ( int & ss,
int & 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.

The documentation for this class was generated from the following file:
Generated by doxygen 1.10.0