version 1.38, 2004/05/05 19:43:41
|
version 1.50, 2006/01/30 16:16:46
|
|
|
//%2003//////////////////////////////////////////////////////////////////////// |
//%2006//////////////////////////////////////////////////////////////////////// |
// | // |
// Copyright (c) 2000, 2001, 2002 BMC Software, Hewlett-Packard Development |
// Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development |
// Company, L. P., IBM Corp., The Open Group, Tivoli Systems. |
// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems. |
// Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L. P.; | // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L. P.; |
// IBM Corp.; EMC Corporation, The Open Group. | // IBM Corp.; EMC Corporation, The Open Group. |
|
// Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.; |
|
// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group. |
|
// Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
|
// EMC Corporation; VERITAS Software Corporation; The Open Group. |
|
// Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
|
// EMC Corporation; Symantec Corporation; The Open Group. |
// | // |
// Permission is hereby granted, free of charge, to any person obtaining a copy | // Permission is hereby granted, free of charge, to any person obtaining a copy |
// of this software and associated documentation files (the "Software"), to | // of this software and associated documentation files (the "Software"), to |
|
|
// | // |
//============================================================================== | //============================================================================== |
// | // |
// Author: Mike Brasher (mbrasher@bmc.com) |
|
// |
|
// Modified By: Karl Schopmeyer(k.schopmeyer@opengroup.org) |
|
// Sushma Fernandes, Hewlett Packard Company |
|
// (sushma_fernandes@hp.com) |
|
// Roger Kumpf, Hewlett Packard Company (roger_kumpf@hp.com) |
|
// Carol Ann Krug Graves, Hewlett-Packard Company |
|
// (carolann_graves@hp.com) |
|
// Amit K Arora (amita@in.ibm.com) for PEP-101 |
|
// |
|
//%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
| |
#ifndef Pegasus_DateTime_h | #ifndef Pegasus_DateTime_h |
|
|
#include <Pegasus/Common/Config.h> | #include <Pegasus/Common/Config.h> |
#include <Pegasus/Common/Array.h> | #include <Pegasus/Common/Array.h> |
#include <Pegasus/Common/Linkage.h> | #include <Pegasus/Common/Linkage.h> |
#include <Pegasus/Common/AutoPtr.h> |
|
| |
PEGASUS_NAMESPACE_BEGIN | PEGASUS_NAMESPACE_BEGIN |
| |
class CIMDateTimeRep |
class CIMDateTimeRep; |
{ |
|
public: |
|
enum { FORMAT_LENGTH = 25 }; |
|
|
|
// |
|
// Length of the string required to store only the date and time without |
|
// the UTC sign and UTC offset. |
|
// Format is yyyymmddhhmmss. |
|
// Note : The size does not include the null byte. |
|
// |
|
enum { DATE_TIME_LENGTH = 14 }; |
|
|
|
// |
|
// Length of the string required to store the formatted date and time |
|
// Format is yyyy:mm:dd:hh:mm:ss. |
|
// |
|
enum { FORMATTED_DATE_TIME = 20 }; |
|
|
|
char data[FORMAT_LENGTH + 1]; |
|
}; |
|
|
|
| |
/** | /** |
The CIMDateTime class represents the CIM datetime data type as a C++ class | The CIMDateTime class represents the CIM datetime data type as a C++ class |
CIMDateTime. A CIM datetime may contain a date or an interval. CIMDateTime |
CIMDateTime. A CIM datetime may contain a time stamp or an interval. |
is an intrinsic CIM data type that represents the time as a string with a |
CIMDateTime is an intrinsic CIM data type that represents the time as a |
fixed length. |
string with a fixed length. |
| |
<PRE> | <PRE> |
A date has the following form: |
A time stamp has the following form: |
yyyymmddhhmmss.mmmmmmsutc | yyyymmddhhmmss.mmmmmmsutc |
| |
Where | Where |
|
|
mmmmmm = microseconds | mmmmmm = microseconds |
</PRE> | </PRE> |
| |
Note: Intervals always end in ":000". This distinguishes intervals from dates. |
Note: Intervals always end in ":000". This distinguishes intervals from |
|
time stamps. |
| |
CIMDateTime objects are constructed from String objects or from | CIMDateTime objects are constructed from String objects or from |
other CIMDateTime objects. Character strings must be exactly | other CIMDateTime objects. Character strings must be exactly |
twenty-five characters in length and conform to either the date or interval |
twenty-five characters in length and conform to either the time stamp |
format. |
or interval format. |
| |
CIMDateTime objects that are not explicitly initialized will be | CIMDateTime objects that are not explicitly initialized will be |
implicitly initialized with a zero time interval: | implicitly initialized with a zero time interval: |
| |
00000000000000.000000:000 | 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. |
|
|
|
<PRE> |
|
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 |
|
</PRE> |
|
|
|
The relational operators may only operate on two operands of the same type, |
|
i.e. two time stamps or two intervals. |
*/ | */ |
class PEGASUS_COMMON_LINKAGE CIMDateTime | class PEGASUS_COMMON_LINKAGE CIMDateTime |
{ | { |
|
|
CIMDateTime(); | CIMDateTime(); |
| |
/** Creates a new CIMDateTime object from a string constant representing | /** Creates a new CIMDateTime object from a string constant representing |
the CIM DateTime-formatted datetime. |
the CIM DateTime formatted datetime. |
See the class documentation for CIMDateTime for the definition of the | See the class documentation for CIMDateTime for the definition of the |
input string for absolute and interval datetime. | input string for absolute and interval datetime. |
@param str String object containing the CIM DateTime-formatted string. |
@param str String object containing the CIMDateTime formatted string. |
This must contain twenty-five characters. | This must contain twenty-five characters. |
|
@exception InvalidDateTimeFormatException If the input string is not |
|
formatted correctly. |
*/ | */ |
CIMDateTime(const String & str); | CIMDateTime(const String & str); |
| |
|
|
*/ | */ |
CIMDateTime(const CIMDateTime& x); | CIMDateTime(const CIMDateTime& x); |
| |
|
/** Creates a CIMDateTime object from an integer. |
|
@param 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. |
|
@param interval Specifies whether the CIMDateTime object is to be |
|
created as an interval value (true) or a time stamp (false). |
|
@exception 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). |
|
@exception InvalidDateTimeFormatException If the CIMDateTime object is |
|
not formed correctly. |
|
*/ |
|
CIMDateTime(Uint64 microSec, Boolean interval); |
|
|
|
/** CIMDateTime destructor. */ |
|
~CIMDateTime(); |
| |
/** Assigns one instance of the CIMDateTime object to another. | /** Assigns one instance of the CIMDateTime object to another. |
@param x The CIMDateTime Object to assign to the CIMDateTime object. | @param x The CIMDateTime Object to assign to the CIMDateTime object. |
|
|
*/ | */ |
String toString () const; | String toString () const; |
| |
/** Sets the date and time in the CIMDateTime object from |
/** Sets the datetime value from the input parameter. |
the input parameter. |
@param str String containing the new value in the datetime format |
@param str String constant containing the datetime |
(specified in the CIMDateTime class description). For example, the |
in the datetime format. This must conform the to formatting rules specified |
following sets the date to December 24, 1999 and time to 12:00 P.M. |
in the CIMDateTime class description. For example, the following sets |
EST. |
the date to December 24, 1999 and time to 12:00 P.M. |
|
| |
<PRE> | <PRE> |
CIMDateTime dt; | CIMDateTime dt; |
dt.set("19991224120000.000000+360"); |
dt.set("19991224120000.000000-300"); |
</PRE> | </PRE> |
| |
@exception InvalidDateTimeFormatException because the date and time is not |
@exception InvalidDateTimeFormatException If the datetime String is not |
formatted correctly. See the CIMDateTime class decscription for the |
formatted correctly. |
formatting rules. |
|
*/ | */ |
void set(const String & str); | void set(const String & str); |
| |
|
|
*/ | */ |
void clear(); | void clear(); |
| |
/** Receives the current time as CIMDateTime. The time is returned as the local time. |
/** Returns the current local time in a CIMDateTime object. |
@return CIMDateTime object containing the current date and time. |
@return CIMDateTime object containing the current local date and time. |
*/ | */ |
static CIMDateTime getCurrentDateTime(); | static CIMDateTime getCurrentDateTime(); |
| |
/** Computes the difference in microseconds between two CIMDateTime dates or |
/** Computes the difference in microseconds between two CIMDateTime time |
two CIMDateTime intervals. |
stamps or two CIMDateTime intervals. |
@param startTime Contains the start datetime. | @param startTime Contains the start datetime. |
@param finishTime Contains the finish datetime. | @param finishTime Contains the finish datetime. |
@return Integer that contains the difference between the two datetime values |
@return An integer that contains the difference between the two |
in microseconds. |
datetime values (in microseconds). |
@exception InvalidDateTimeFormatException If one argument uses the interval |
@exception InvalidDateTimeFormatException If arguments are not the same |
format and the other uses the string format. |
type of CIMDateTime. |
@exception DateTimeOutOfRangeException If datetime is outside the allowed |
|
range. |
|
|
|
Note: The behavior on HP-UX and Windows platform is to throw an exception |
|
when the dates are out of range. Red Hat Linux platform normalizes the |
|
dates when they are outside their legal interval and will not throw an |
|
exception. |
|
|
|
Allowed Date Range: |
|
The mktime (3C) man page on HP-UX does not document the allowed range. |
|
The approximate range of dates allowed on HP-UX is between |
|
1901 and 2038. |
|
|
|
On Windows platform, the approximate range is between 1970 to 2038. |
|
|
|
On Red Hat Linux platform the approximate range is between 1901 and 2038. |
|
*/ | */ |
static Sint64 getDifference(CIMDateTime startTime, CIMDateTime finishTime); | static Sint64 getDifference(CIMDateTime startTime, CIMDateTime finishTime); |
| |
/** Checks whether the datetime is an interval. | /** Checks whether the datetime is an interval. |
@return True if the datetime is an interval; otherwise, false. |
@return True if the datetime is an interval value, false otherwise. |
*/ | */ |
|
Boolean isInterval() const; |
Boolean isInterval(); | Boolean isInterval(); |
| |
/** Compares the CIMDateTime object to another CIMDateTime object for | /** Compares the CIMDateTime object to another CIMDateTime object for |
equality. | equality. |
@param x CIMDateTime object to be compared. | @param x CIMDateTime object to be compared. |
@return true if the two CIMDateTime objects are equal; otherwise, false. |
@return true if the two CIMDateTime objects are equal, false otherwise |
|
@exception TypeMismatchException If arguments are of different types. |
*/ | */ |
Boolean equal (const CIMDateTime & x) const; | Boolean equal (const CIMDateTime & x) const; |
| |
|
/** Converts a CIMDateTime object to its microsecond representation. |
|
@return Number of microseconds since the epoch (for time stamps) or |
|
in a span of time (for intervals). |
|
@exception DateTimeOutOfRangeException If conversion to UTC (an |
|
internal operation) causes an overflow condition. |
|
*/ |
|
Uint64 toMicroSeconds() const; |
|
|
|
/** Adds two CIMDateTime objects and returns a CIMDateTime object that |
|
represents the sum. |
|
@param cDT operand on the RHS of the operator |
|
@return A CIMDateTime object that is the result of adding the calling |
|
object to the RHS operand |
|
@exception DateTimeOutOfRangeException If the operation causes an |
|
overflow condition. |
|
@exception TypeMismatchException If the operands are not type |
|
compatible (see table of operations). |
|
*/ |
|
CIMDateTime operator+(const CIMDateTime& cDT) const; |
|
|
|
/** Adds two CIMDateTime objects, returns the sum and changes |
|
the value of the calling CIMDateTime object to match the return value. |
|
@param cDT operand on the RHS of the operator |
|
@return A CIMDateTime object that is the result of adding the calling |
|
object to the RHS operand |
|
@exception DateTimeOutOfRangeException If the operation causes an |
|
overflow condition. |
|
@exception TypeMismatchException If the operands are not type |
|
compatible (see table of operations). |
|
*/ |
|
CIMDateTime & operator+=(const CIMDateTime& cDT); |
|
|
|
/** Subtracts one CIMDateTime object from another and returns a |
|
CIMDateTime object that represents the difference. |
|
@param cDT operand on the RHS of the operator |
|
@return A CIMDateTime object that is the result of subtracting the |
|
the RHS object from the calling. |
|
@exception DateTimeOutOfRangeException If the operation causes an |
|
underflow condition or conversion to UTC (an internal operation) |
|
causes an overflow condition. |
|
@exception TypeMismatchException If the operands are not type |
|
compatible (see table of operations). |
|
*/ |
|
CIMDateTime operator-(const CIMDateTime& cDT) const; |
|
|
|
/** Subtracts one CIMDateTime object from another, returns the difference |
|
and changes the value of the calling CIMDateTime object to match the |
|
return value. |
|
@param cDT operand on the RHS of the operator |
|
@return A CIMDateTime object that is the result of subtracting the |
|
object on the RHS from the calling object. |
|
@exception DateTimeOutOfRangeException If the operation causes an |
|
underflow condition or conversion to UTC (an internal operation) |
|
causes an overflow condition. |
|
@exception TypeMismatchException If the operands are not type |
|
compatible (see table of operations). |
|
*/ |
|
CIMDateTime & operator-=(const CIMDateTime& cDT); |
|
|
|
/** Multiplies a CIMDateTime object by an integer and returns a CIMDateTime |
|
object that represents the product. |
|
@param num integer operand on the RHS of the operator |
|
@return A CIMDateTime object that is the result of multiplying the |
|
calling object by the RHS operand. |
|
@exception DateTimeOutOfRangeException If the operation causes an |
|
overflow condition. |
|
@exception TypeMismatchException If the operands are not type |
|
compatible (see table of operations). |
|
*/ |
|
CIMDateTime operator*(Uint64 num) const; |
|
|
|
/** Multiplies a CIMDateTime object by an integer, returns the product |
|
and changes the value of the calling object to match the returned |
|
product. |
|
@param num integer operand on the RHS of the operator |
|
@return A CIMDateTime object that is the result of multiplying the |
|
calling object by the RHS operand. |
|
@exception DateTimeOutOfRangeException If the operation causes an |
|
overflow condition. |
|
@exception TypeMismatchException If the operands are not type |
|
compatible (see table of operations). |
|
*/ |
|
CIMDateTime & operator*=(Uint64 num); |
|
|
|
/** Divides a CIMDateTime object by an integer and returns a CIMDateTime |
|
object that represents the quotient. |
|
@param num integer operand on the RHS of the operator |
|
@return A CIMDateTime object that is the result of dividing the calling |
|
object by the RHS operand. |
|
@exception DateTimeOutOfRangeException If conversion to UTC (an |
|
internal operation) causes an overflow condition. |
|
@exception TypeMismatchException If the CIMDateTime object does not |
|
hold an interval value (see table of operations). |
|
@exception Exception if param num is zero. |
|
*/ |
|
CIMDateTime operator/(Uint64 num) const; |
|
|
|
/** Divides a CIMDateTime object by an integer, returns the quotient |
|
and changes the value of the calling object to match the returned |
|
quotient. |
|
@param num integer operand on the RHS of the operator |
|
@return A CIMDateTime object that is the result of dividing the calling |
|
object by the RHS operand. |
|
@exception DateTimeOutOfRangeException If conversion to UTC (an |
|
internal operation) causes an overflow condition. |
|
@exception TypeMismatchException If the CIMDateTime object does not |
|
hold an interval value (see table of operations). |
|
@exception Exception if param num is zero. |
|
*/ |
|
CIMDateTime & operator/=(Uint64 num); |
|
|
|
/** Divides a CIMDateTime object by another CIMDateTime object and returns |
|
an integer quotient. |
|
@param cdt CIMDateTime object on the RHS of the operator |
|
@return 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. |
|
@exception DateTimeOutOfRangeException If conversion to UTC (an |
|
internal operation) causes an overflow condition. |
|
@exception TypeMismatchException If the operands are not type |
|
compatible (see table of operations). |
|
*/ |
|
Uint64 operator/(const CIMDateTime& cdt) const; |
|
|
|
/** Compare two CIMDateTime objects and returns true if the LHS is |
|
less than the RHS. |
|
@param cDT operand on the RHS of the operator |
|
@return true if the LHS is less than the RHS, false otherwise. |
|
@exception DateTimeOutOfRangeException If conversion to UTC (an |
|
internal operation) causes an overflow condition. |
|
@exception TypeMismatchException if operands are not of the same |
|
type. |
|
*/ |
|
Boolean operator<(const CIMDateTime& cDT) const; |
|
|
|
/** Compare two CIMDateTime objects and returns true if the LHS is |
|
less than or equal to the RHS. |
|
@param cDT operand on the RHS of the operator |
|
@return true if the LHS is less than or equal to the RHS, false |
|
otherwise. |
|
@exception DateTimeOutOfRangeException If conversion to UTC (an |
|
internal operation) causes an overflow condition. |
|
@exception TypeMismatchException if operands are not of the same |
|
type. |
|
*/ |
|
Boolean operator<=(const CIMDateTime& cDT) const; |
|
|
|
/** Compare two CIMDateTime objects and returns true if the LHS is |
|
greater than the RHS. |
|
@param cDT operand on the RHS of the operator |
|
@return true if the LHS is greater than the RHS, false otherwise. |
|
@exception DateTimeOutOfRangeException If conversion to UTC (an |
|
internal operation) causes an overflow condition. |
|
@exception TypeMismatchException if operands are not of the same |
|
type. |
|
*/ |
|
Boolean operator>(const CIMDateTime & cDT) const; |
|
|
|
/** Compare two CIMDateTime objects and returns true if the LHS is |
|
greater than or equal to the RHS. |
|
@param cDT operand on the RHS of the operator |
|
@return true if the LHS is greater than or equal to the RHS, false |
|
otherwise. |
|
@exception DateTimeOutOfRangeException If conversion to UTC (an |
|
internal operation) causes an overflow condition. |
|
@exception TypeMismatchException if operands are not of the same |
|
type. |
|
*/ |
|
Boolean operator>=(const CIMDateTime & cDT) const; |
|
|
|
/** Compare two CIMDateTime objects and returns true if the LHS is |
|
not equal to the RHS. |
|
@param cDT operand on the RHS of the operator |
|
@return true if the LHS is not equal to RHS, false otherwise. |
|
@exception DateTimeOutOfRangeException If conversion to UTC (an |
|
internal operation) causes an overflow condition. |
|
@exception TypeMismatchException if operands are not of the same |
|
type. |
|
*/ |
|
Boolean operator!=(const CIMDateTime & cDT) const; |
|
|
private: | private: |
| |
AutoPtr<CIMDateTimeRep> _rep;//PEP101 |
CIMDateTimeRep* _rep; |
Boolean _set(const String & dateTimeStr); | Boolean _set(const String & dateTimeStr); |
|
enum Field {ONLY_WILD_CARDS, SOME_WILD_CARDS, ONLY_DIGITS, ERR}; |
|
|
|
Field fieldcheck(const String & in_p, String & rep_field); |
|
|
|
Boolean restOfFields(Uint32 start_position,const String & inStr); |
|
|
|
Uint64 _toMicroSeconds(); |
|
|
|
void convertToUTC(); |
|
|
|
void setUtcOffSet(Sint32 utc); |
|
|
|
void insert_WildCard(Uint32 index); |
|
|
|
Uint32 getHighestWildCardPosition(const CIMDateTime & cDT_s); |
}; | }; |
/** |
|
Add documentation here. |
/** Compares two CIMDateTime objects and returns true if they represent the |
|
same time or length of time. |
|
@param x one of the CIMDateTime objects to be compared |
|
@param y one of the CIMDateTime objects to be compared |
|
@return true if the two objects passed in represent the same time or |
|
length of time, false otherwise. |
*/ | */ |
PEGASUS_COMMON_LINKAGE Boolean operator==( | PEGASUS_COMMON_LINKAGE Boolean operator==( |
/** |
|
Add documentation here. |
|
*/ |
|
const CIMDateTime& x, | const CIMDateTime& x, |
/** |
|
Add documentation here. |
|
*/ |
|
const CIMDateTime& y); | const CIMDateTime& y); |
| |
#define PEGASUS_ARRAY_T CIMDateTime | #define PEGASUS_ARRAY_T CIMDateTime |
# include <Pegasus/Common/ArrayInter.h> | # include <Pegasus/Common/ArrayInter.h> |
#undef PEGASUS_ARRAY_T | #undef PEGASUS_ARRAY_T |
| |
|
|
PEGASUS_NAMESPACE_END | PEGASUS_NAMESPACE_END |
| |
#endif /* Pegasus_DateTime_h */ | #endif /* Pegasus_DateTime_h */ |