pegasus/src/Pegasus/Common/CIMDateTime.h - diff

Return to CIMDateTime.h CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Common

Diff for /pegasus/src/Pegasus/Common/CIMDateTime.h between version 1.12 and 1.39.4.1

version 1.12, 2002/02/18 13:58:02

version 1.39.4.1, 2004/11/05 18:16:21

Line 1

//%/////////////////////////////////////////////////////////////////////////////

//%2003////////////////////////////////////////////////////////////////////////

// Company, L. P., IBM Corp., The Open Group, Tivoli Systems.

// IBM Corp.; EMC Corporation, The Open Group.

// Permission is hereby granted, free of charge, to any person obtaining a copy

// of this software and associated documentation files (the "Software"), to

Line 19

Line 22

// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

//==============================================================================

// Author: Mike Brasher (mbrasher@bmc.com)

// Modified By: Karl Schopmeyer(k.schopmeyer@opengroup.org)

// Modified By:Willis White (whiwill@ibm.com) PEP #192 - changed CIMDateTimeRep,

// added CIMDateTime::toMicroSeconds() and added sub-classes

// dtInterval and dtTimeStamp.

//%/////////////////////////////////////////////////////////////////////////////

Line 31

Line 35

#include <Pegasus/Common/Config.h>

#include <Pegasus/Common/Array.h>

#include <iostream>

#include <Pegasus/Common/Linkage.h>

#include <math.h>

//#include <Pegasus/Common/XmlWriter.h>

PEGASUS_NAMESPACE_BEGIN

/* ATTN: P3. Several functions should be added to this class for datetime manipulation

/* the CIMDateTimeRep class holds the data for the CIMDateTime class as it's protected

including get and set each subcomponent (year, month, etc). isInterval, test for equality,

data members.It also allows for "setting" and "getting" of individual components of

create intervals from absolutes, possibly gett current time, Note that

date time.

the Java rep is probably tostring, not get string,

class CIMDateTimeRep

{

public:

String microSec;

String seconds;

String minutes;

String hours;

String days;

String month;

String year;

String utcOffSet;

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 buffer_day [5];

// sprintf(yearbuf, "%4d", (days_rem+1)); // day of the month is never 0 (1-31)

// ye_mo_da = ye_mo.append(buffer_day);

char data[FORMAT_LENGTH + 1];

Uint64 getMicroSec();

Uint64 getSeconds();

Uint64 getMinutes();

Uint64 getHours();

Uint64 getDays();

Uint64 getMonth();

Uint64 getYear();

Uint64 getUtcOffSet();

Uint16 set_microSec(String & mS);

void set_seconds(String sec);

void set_minutes(String min);

void set_hours(String ho);

void set_days(String da);

void set_month(String mon);

void set_year(String ye);

Boolean set_utcOffSet(String uOff);

void set_data(String vlaue, Uint32 index, Uint32 size);

void copy(CIMDateTimeRep * cTR);

};

/****************************************************************************

/**

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

is an intrinsic CIM data type which represents the time as a formated

is an intrinsic CIM data type that represents the time as a string with a

fixedplength string.

fixed length.

<PRE>

A date has the following form:

Line 53

Line 121

Where

yyyy = year (0-1999)

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.

mmmmmm = microseconds

s = '+' or '-' to represent the UTC sign.

s = '+' or '-' to represent the Coordinated Universal Time (UTC) sign

utc = UTC offset (same as GMT offset).

utc = offset from Coordinated Universal Time (UTC)

(same as Greenwich Mean Time(GMT) offset)

An interval has the following form:

Line 70

Line 139

Where

dddddddd = days

hh = hours

hh = hours (0-23)

mm = minutes

mm = minutes (0-59)

ss = seconds

ss = seconds (0-59)

mmmmmm = microseconds

</PRE>

Note that intervals always end in ":000" (this is how they

Note: Intervals always end in ":000". This distinguishes intervals from dates.

are distinguished from dates).

Intervals are really durations since they do not specify a start and

CIMDateTime objects are constructed from String objects or from

end time (as one expects when speaking about an interval). It is

other CIMDateTime objects. Character strings must be exactly

better to think of an interval as specifying time elapsed since

twenty-five characters in length and conform to either the date or interval

some event.

format.

CIMDateTime objects are constructed from C character strings or from

other CIMDateTime objects. These character strings must be exactly

twenty-five characters and conform to one of the forms idententified

above.

CIMDateTime objects which are not explicitly initialized will be

CIMDateTime objects that are not explicitly initialized will be

implicitly initialized with the null time interval:

implicitly initialized with a zero time interval:

00000000000000.000000:000

Instances can be tested for nullness with the isNull() method.

class PEGASUS_COMMON_LINKAGE CIMDateTime

{

public:

enum { FORMAT_LENGTH = 25 };

/** Creates a new CIMDateTime object with a zero interval value.

/** Create a new CIMDateTime object with NULL DateTime definition.

CIMDateTime();

/** CIMDateTime - Creat a CIM CIMDateTime instance from a string

/** Creates a new CIMDateTime object from a string constant representing

constant representing the CIM DateTime formatted datetime

the CIM DateTime-formatted datetime.

See the class documentation for CIMDateTime for the defintion of the

See the class documentation for CIMDateTime for the definition of the

input string for absolute and interval datetime.

@param str String object containing the CIM DateTime formatted string

@param str String object containing the CIM DateTime-formatted string.

This must contain twenty-five characters.

CIMDateTime(const char* str);

CIMDateTime(const String & str);

/** CIMDateTime Create a CIMDateTime instance from another

/** Creates a CIMDateTime object from another CIMDateTime object.

CIMDateTime object

@param x Specifies the name of the CIMDateTime object to copy.

@param x CIMDateTime object to be copied.

CIMDateTime(const CIMDateTime& x);

/** DateTime Destructor. */

/* Creates a CIMDateTime object from from integer.

~CIMDateTime() { }

@pram microSec is the number of micro Seconds in the epoch 0/0/000 (12 am Jan 1, 1BCE)

@parm interval tells what type will be created. If true an Interval will be created,

/** Assign one DateTime object to another

if false a time stamp will be created.

@param - The DateTime Object to assign

<pre>

CIMDateTime(Uint64 microSec, Boolean interval);

/** CIMDateTime destructor. */

~CIMDateTime();

/** Assigns one instance of the CIMDateTime object to another.

@param x The CIMDateTime Object to assign to the CIMDateTime object.

For example, you can assign the d1 CIMDateTime instance to the d2

CIMDateTime instance.

<PRE>

CIMDateTime d1;

CIMDateTime d2 = "00000000000000.000000:000";

d1 = d1;

d1 = d2;

</pre>

CIMDateTime& operator=(const CIMDateTime& x);

/** CIMDateTime isNull method - Tests for an all zero date time. Note that

today this function checks for absolute datetime == zero, not interval.

<PRE>

CIMDateTime dt;

dt.clear();

assert(dt.isNull());

</PRE>

@return This method returns true of the contents are

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

"00000000000000.000000:000". Else it returns false

Boolean isNull() const;

CIMDateTime& operator=(const CIMDateTime& x);

/** getString - Returns the string representing the DateTime value of the

/** Returns a string representing the DateTime value of the

CIMDateTime Object.

CIMDateTime object.

ATTN: P3 KS. This simply returns a string whether the datetime is a

@return String representing the DateTime value.

real value or the NULL value. It is up to the user to test. Should

this be modified so we do something like an interupt on NULL?

String toString () const;

const char* getString() const;

/** Sets the date and time in the CIMDateTime object from

the input parameter.

/** method set - Sets the date time. Creates the CIMDateTime instance from

@param str String constant containing the datetime

the input string constant which must be

in the datetime format. This must conform the to formatting rules specified

in the datetime format.

in the CIMDateTime class description. For example, the following sets

the date to December 24, 1999 and time to 12:00 P.M.

<PRE>

CIMDateTime dt;

dt.set("19991224120000.000000+360");

</PRE>

@return On format error, CIMDateTime set throws the exception

@exception InvalidDateTimeFormatException because the date and time is not

BadDateTimeFormat

formatted correctly. See the CIMDateTime class decscription for the

@exception Throws exception BadDateTimeFormat on format error.

formatting rules.

void set(const char* str);

void set(const String & str);

/** clear - Clears the datetime class instance. The date time is set to our

/** Clears the datetime class object. The date time is set to

defintion of NULL, absolute zero date time.

a zero interval value.

void clear();

/** CIMDateTime - ATTN: Friend operator Test for CIMDateTime

/** Receives the current time as CIMDateTime. The time is returned as the local time.

equality

@return CIMDateTime object containing the current date and time.

PEGASUS_COMMON_LINKAGE friend Boolean operator==(

static CIMDateTime getCurrentDateTime();

const CIMDateTime& x,

const CIMDateTime& y);

private:

/** Computes the difference in microseconds between two CIMDateTime dates or

two CIMDateTime intervals.

@param startTime Contains the start datetime.

@param finishTime Contains the finish datetime.

@return Integer that contains the difference between the two datetime values

in microseconds is the epoch (UTC).

@exception InvalidDateTimeFormatException If one argument uses the interval

format and the other uses the string format.

Boolean _set(const char* str);

*************************************************************************************

char _rep[FORMAT_LENGTH + 1];

Take out

};

@exception DateTimeOutOfRangeException If differance is negative.

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(const CIMDateTime& startTime, const CIMDateTime& finishTime);

/** Checks whether the datetime is an interval.

@return True if the datetime is an interval; otherwise, false.

Boolean isInterval() const;

/** Compares the CIMDateTime object to another CIMDateTime object for

equality.

@param x CIMDateTime object to be compared.

@return true if the two CIMDateTime objects are equal; otherwise, false.

Boolean equal (const CIMDateTime & x) const;

/*Converts a CIMDateTime object to it's microsecond representaion*/

Uint64 toMicroSeconds();

/* Arithmetic operators

const CIMDateTime operator+(const CIMDateTime & cDT);

void operator+=(const CIMDateTime & cDT);

const CIMDateTime operator-(const CIMDateTime & cDT);

void operator-=(const CIMDateTime & cDT);

const CIMDateTime operator*(Uint64 num);

void operator*=(Uint64 num);

const CIMDateTime operator/(Uint64 num);

void operator/=(Uint64 num);

Uint64 operator/(const CIMDateTime & cdt);

/* Relational operators

const Boolean operator<(const CIMDateTime & cDT);

const Boolean operator<=(const CIMDateTime & cDT);

const Boolean operator>(const CIMDateTime & cDT);

const Boolean operator>=(const CIMDateTime & cDT);

const Boolean operator!=(const CIMDateTime & cDT);

protected: //commented out for testing purposes

CIMDateTimeRep* _rep;

Boolean _set(const String & dateTimeStr);

/* checks to make sure the format of a particulatr field in the DateTime string is correct.

Returns

0 - field contains all wild cards

1 - field contains some wild cards (error)

2 - field contains only digits

Uint64 fieldcheck(String & in_p, String & rep_field);

/* check the micro Seconds field for format errors

Uint64 CIMDateTime::microSecheck(String & in_p);

/* if a field has a wild card then all the fields with lower significance should have wild cards. This

method makes sure of this.

Boolean restOfFields(Uint32 start_position,const String inStr);

Uint64 _toMicroSeconds();

/* converts time stamps to thier UTC (GMT) representaion. For intervals it just retruns a copy of

calling program

CIMDateTime normalizer();

/* sets the utc offf set of the CIMDateTime object. This method does not change the value

of object, it only converts the representaion form UTC (GMT) to the time zonne spcified.

@parm cdt TimeStamp object that will be converted

@parm uct uct offset in minutes that represents the time zone to be converted to

Retruns a copy of the calling object modified to represent the same time in a differnet time zone.

CIMDateTime setUctOffSet(Sint32 utc);

/*inserts wild cards into CIMDateTime object.

@parm index - position to start placing wild card charicters

@parm cdt - object to be modified

Returns a copy of calling object with wild cards starting at position index

@exception InvalidDateTimeFormatException because of invalid index (see rules for wild cards)

CIMDateTime insert_WildCard(Uint32 index);

Uint32 getHighestWildCardPosition(CIMDateTime & cDT_s);

};

/**

Add documentation here.

PEGASUS_COMMON_LINKAGE Boolean operator==(

/**

Add documentation here.

const CIMDateTime& x,

/**

Add documentation here.

const CIMDateTime& y);

PEGASUS_COMMON_LINKAGE PEGASUS_STD(ostream)& operator<<(

PEGASUS_STD(ostream)& os,

const CIMDateTime& x);

#define PEGASUS_ARRAY_T CIMDateTime

# include "ArrayInter.h"

# include <Pegasus/Common/ArrayInter.h>

#undef PEGASUS_ARRAY_T

PEGASUS_NAMESPACE_END

#endif /* Pegasus_DateTime_h */

Legend:

Removed from v.1.12
changed lines
	Added in v.1.39.4.1

No CVS admin address has been configured