Pegasus Developers Manual

In file ../../src/Pegasus/Common/CIMDateTime.h:

class PEGASUS_COMMON_LINKAGE CIMDateTime

The CIMDateTime class represents the CIM datetime data type as a C++ class CIMDateTime.

Documentation

The CIMDateTime class represents the CIM datetime data type as a C++ class CIMDateTime. A CIM datetime may contain a time stamp or an interval. CIMDateTime is an intrinsic CIM data type that represents the time as a string with a fixed length.
    A time stamp has the following form:
    yyyymmddhhmmss.mmmmmmsutc

    Where

    yyyy = year (1-9999)
    mm = month (1-12)
    dd = day (1-31)
    hh = hour (0-23)
    mm = minute (0-59)
    ss = second (0-59)
    mmmmmm = microseconds
    s = '+' or '-' to represent the Coordinated Universal Time (UTC) sign
    utc = offset from Coordinated Universal Time (UTC)
        (same as Greenwich Mean Time(GMT) offset)

    An interval has the following form:

    ddddddddhhmmss.mmmmmm:000

    Where

    dddddddd = days
    hh = hours (0-23)
    mm = minutes (0-59)
    ss = seconds (0-59)
    mmmmmm = microseconds
    
Note: Intervals always end in ":000". This distinguishes intervals from time stamps.
CIMDateTime objects are constructed from String objects or from other CIMDateTime objects. Character strings must be exactly twenty-five characters in length and conform to either the time stamp or interval format.
CIMDateTime objects that are not explicitly initialized will be implicitly initialized with a zero time interval:
00000000000000.000000:000
The following table shows what arithmetic operations are allowed between CIMDateTime types. The entries in the last four columns define the type of the result when the operation, specified in the column header, is performed on operands, of the types specified in the first two columns.
    LHS - left hand side    TS - time stamp  int - integer
    RHS - right hand side   IV - interval
    X - operation not allowed between types

    LHS     RHS    +       -       *        /
    _____________________________________________
    TS      TS     X       IV      X       X
    TS      IV     TS      TS      X       X
    TS      int    X       X       X       X
    IV      IV     IV      IV      X       int
    IV      TS     X       X       X       X
    IV      int    X       X       IV      IV
    int     TS     X       X       X       X
    int     IV     X       X       X       X
    
The relational operators may only operate on two operands of the same type, i.e. two time stamps or two intervals.

Inheritance:

Public Methods

CIMDateTime()

Creates a new CIMDateTime object with a zero interval value

CIMDateTime(const String & str)

Creates a new CIMDateTime object from a string constant representing the CIM DateTime formatted datetime. See the class documentation for CIMDateTime for the definition of the input string for absolute and interval datetime.


Throws:: InvalidDateTimeFormatException If the input string is not formatted correctly.
Parameters:: str - String object containing the CIMDateTime formatted string. This must contain twenty-five characters.

CIMDateTime(const CIMDateTime& x)

Creates a CIMDateTime object from another CIMDateTime object.


Parameters:: x - Specifies the name of the CIMDateTime object to copy.

CIMDateTime(Uint64 microSec, Boolean interval)

Creates a CIMDateTime object from an integer.


Throws:: DateTimeOutOfRangeException If the microSec value is too large (greater than 317,455,200,000,000,000 for a time stamps or 8,640,000,000,000,000,000 for an interval).
InvalidDateTimeFormatException If the CIMDateTime object is not formed correctly.
Parameters:: microSec - For a time stamp, the number of microseconds since the epoch 0/0/0000 (12 am Jan 1, 1BCE); For an interval, the number of microseconds in the interval.
interval - Specifies whether the CIMDateTime object is to be created as an interval value (true) or a time stamp (false).

~CIMDateTime()

CIMDateTime destructor.

CIMDateTime& operator=(const CIMDateTime& x)

Assigns one instance of the CIMDateTime object to another.

Parameters:

x - The CIMDateTime Object to assign to the CIMDateTime object. For example, you can assign the d1 CIMDateTime instance to the d2 CIMDateTime instance.

CIMDateTime d1;
CIMDateTime d2 = "00000000000000.000000:000";
d1 = d2;

Therefore, d1 is assigned the same "00000000000000.000000:000" value as d2.

String toString() const

Returns a string representing the DateTime value of the CIMDateTime object.


Returns:: String representing the DateTime value.

void set(const String & str)

Sets the datetime value from the input parameter.

Throws:

InvalidDateTimeFormatException If the datetime String is not formatted correctly.

Parameters:

str - String containing the new value in the datetime format (specified in the CIMDateTime class description). For example, the following sets the date to December 24, 1999 and time to 12:00 P.M. EST.

CIMDateTime dt;
dt.set("19991224120000.000000-300");

void clear()

Clears the datetime class object. The date time is set to a zero interval value.

static CIMDateTime getCurrentDateTime()

Returns the current local time in a CIMDateTime object.


Returns:: CIMDateTime object containing the current local date and time.

static Sint64 getDifference(CIMDateTime startTime, CIMDateTime finishTime)

Computes the difference in microseconds between two CIMDateTime time stamps or two CIMDateTime intervals.


Throws:: InvalidDateTimeFormatException If arguments are not the same type of CIMDateTime.
Parameters:: startTime - Contains the start datetime.
finishTime - Contains the finish datetime.
Returns:: An integer that contains the difference between the two datetime values (in microseconds).

Boolean isInterval() const

Checks whether the datetime is an interval. Checks whether the datetime is an interval.


Returns:: True if the datetime is an interval value, false otherwise.
True if the datetime is an interval value, false otherwise.

Boolean equal(const CIMDateTime & x) const

Compares the CIMDateTime object to another CIMDateTime object for equality.


Throws:: TypeMismatchException If arguments are of different types.
Parameters:: x - CIMDateTime object to be compared.
Returns:: true if the two CIMDateTime objects are equal, false otherwise

Uint64 toMicroSeconds() const

Converts a CIMDateTime object to its microsecond representation.


Throws:: DateTimeOutOfRangeException If conversion to UTC (an internal operation) causes an overflow condition.
Returns:: Number of microseconds since the epoch (for time stamps) or in a span of time (for intervals).

CIMDateTime operator+(const CIMDateTime& cDT) const

Adds two CIMDateTime objects and returns a CIMDateTime object that represents the sum.


Throws:: DateTimeOutOfRangeException If the operation causes an overflow condition.
TypeMismatchException If the operands are not type compatible (see table of operations).
Parameters:: cDT - operand on the RHS of the operator
Returns:: A CIMDateTime object that is the result of adding the calling object to the RHS operand

CIMDateTime& operator+=(const CIMDateTime& cDT)

Adds two CIMDateTime objects, returns the sum and changes the value of the calling CIMDateTime object to match the return value.


Throws:: DateTimeOutOfRangeException If the operation causes an overflow condition.
TypeMismatchException If the operands are not type compatible (see table of operations).
Parameters:: cDT - operand on the RHS of the operator
Returns:: A CIMDateTime object that is the result of adding the calling object to the RHS operand

CIMDateTime operator-(const CIMDateTime& cDT) const

Subtracts one CIMDateTime object from another and returns a CIMDateTime object that represents the difference.


Throws:: DateTimeOutOfRangeException If the operation causes an underflow condition or conversion to UTC (an internal operation) causes an overflow condition.
TypeMismatchException If the operands are not type compatible (see table of operations).
Parameters:: cDT - operand on the RHS of the operator
Returns:: A CIMDateTime object that is the result of subtracting the the RHS object from the calling.

CIMDateTime& operator-=(const CIMDateTime& cDT)

Subtracts one CIMDateTime object from another, returns the difference and changes the value of the calling CIMDateTime object to match the return value.


Throws:: DateTimeOutOfRangeException If the operation causes an underflow condition or conversion to UTC (an internal operation) causes an overflow condition.
TypeMismatchException If the operands are not type compatible (see table of operations).
Parameters:: cDT - operand on the RHS of the operator
Returns:: A CIMDateTime object that is the result of subtracting the object on the RHS from the calling object.

CIMDateTime operator*(Uint64 num) const

Multiplies a CIMDateTime object by an integer and returns a CIMDateTime object that represents the product.


Throws:: DateTimeOutOfRangeException If the operation causes an overflow condition.
TypeMismatchException If the operands are not type compatible (see table of operations).
Parameters:: num - integer operand on the RHS of the operator
Returns:: A CIMDateTime object that is the result of multiplying the calling object by the RHS operand.

CIMDateTime& operator*=(Uint64 num)

Multiplies a CIMDateTime object by an integer, returns the product and changes the value of the calling object to match the returned product.


Throws:: DateTimeOutOfRangeException If the operation causes an overflow condition.
TypeMismatchException If the operands are not type compatible (see table of operations).
Parameters:: num - integer operand on the RHS of the operator
Returns:: A CIMDateTime object that is the result of multiplying the calling object by the RHS operand.

CIMDateTime operator/(Uint64 num) const

Divides a CIMDateTime object by an integer and returns a CIMDateTime object that represents the quotient.


Throws:: DateTimeOutOfRangeException If conversion to UTC (an internal operation) causes an overflow condition.
TypeMismatchException If the CIMDateTime object does not hold an interval value (see table of operations).
Exception if param num is zero.
Parameters:: num - integer operand on the RHS of the operator
Returns:: A CIMDateTime object that is the result of dividing the calling object by the RHS operand.

CIMDateTime& operator/=(Uint64 num)

Divides a CIMDateTime object by an integer, returns the quotient and changes the value of the calling object to match the returned quotient.


Throws:: DateTimeOutOfRangeException If conversion to UTC (an internal operation) causes an overflow condition.
TypeMismatchException If the CIMDateTime object does not hold an interval value (see table of operations).
Exception if param num is zero.
Parameters:: num - integer operand on the RHS of the operator
Returns:: A CIMDateTime object that is the result of dividing the calling object by the RHS operand.

Uint64 operator/(const CIMDateTime& cdt) const

Divides a CIMDateTime object by another CIMDateTime object and returns an integer quotient.


Throws:: DateTimeOutOfRangeException If conversion to UTC (an internal operation) causes an overflow condition.
TypeMismatchException If the operands are not type compatible (see table of operations).
Parameters:: cdt - CIMDateTime object on the RHS of the operator
Returns:: An integer that is the result of dividing the number of microseconds represented by the calling CIMDateTime object by the number of microseconds represented by the CIMDateTime object on the RHS of the operator.

Boolean operator<(const CIMDateTime& cDT) const

Compare two CIMDateTime objects and returns true if the LHS is less than the RHS.


Throws:: DateTimeOutOfRangeException If conversion to UTC (an internal operation) causes an overflow condition.
TypeMismatchException if operands are not of the same type.
Parameters:: cDT - operand on the RHS of the operator
Returns:: true if the LHS is less than the RHS, false otherwise.

Boolean operator<=(const CIMDateTime& cDT) const

Compare two CIMDateTime objects and returns true if the LHS is less than or equal to the RHS.


Throws:: DateTimeOutOfRangeException If conversion to UTC (an internal operation) causes an overflow condition.
TypeMismatchException if operands are not of the same type.
Parameters:: cDT - operand on the RHS of the operator
Returns:: true if the LHS is less than or equal to the RHS, false otherwise.

Boolean operator>(const CIMDateTime & cDT) const

Compare two CIMDateTime objects and returns true if the LHS is greater than the RHS.


Throws:: DateTimeOutOfRangeException If conversion to UTC (an internal operation) causes an overflow condition.
TypeMismatchException if operands are not of the same type.
Parameters:: cDT - operand on the RHS of the operator
Returns:: true if the LHS is greater than the RHS, false otherwise.

Boolean operator>=(const CIMDateTime & cDT) const

Compare two CIMDateTime objects and returns true if the LHS is greater than or equal to the RHS.


Throws:: DateTimeOutOfRangeException If conversion to UTC (an internal operation) causes an overflow condition.
TypeMismatchException if operands are not of the same type.
Parameters:: cDT - operand on the RHS of the operator
Returns:: true if the LHS is greater than or equal to the RHS, false otherwise.

Boolean operator!=(const CIMDateTime & cDT) const

Compare two CIMDateTime objects and returns true if the LHS is not equal to the RHS.


Throws:: DateTimeOutOfRangeException If conversion to UTC (an internal operation) causes an overflow condition.
TypeMismatchException if operands are not of the same type.
Parameters:: cDT - operand on the RHS of the operator
Returns:: true if the LHS is not equal to RHS, false otherwise.

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java

class PEGASUS_COMMON_LINKAGE CIMDateTime

Documentation

Inheritance:

Public Methods