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.5 and 1.34

version 1.5, 2001/05/24 00:48:35

version 1.34, 2003/03/12 21:02:53

Line 1

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

// The Open Group, Tivoli Systems

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

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

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

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

// to deal in the Software without restriction, including without limitation

// deal in the Software without restriction, including without limitation the

// the rights to use, copy, modify, merge, publish, distribute, sublicense,

// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or

// and/or sell copies of the Software, and to permit persons to whom the

// sell copies of the Software, and to permit persons to whom the Software is

// Software is furnished to do so, subject to the following conditions:

// furnished to do so, subject to the following conditions:

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN

// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED

// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL

// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT

// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR

// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER

// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN

// DEALINGS IN THE SOFTWARE.

// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION

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

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

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

// Modified By:

// 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)

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

Line 30

Line 37

#include <Pegasus/Common/Config.h>

#include <Pegasus/Common/Array.h>

#include <iostream>

#include <Pegasus/Common/Linkage.h>

PEGASUS_NAMESPACE_BEGIN

class CIMDateTimeRep;

/**

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 which represents the time as a formatted

fixedplength string.

fixed length string.

<PRE>

A date has the following form:

Line 46

Line 55

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 UTC sign

utc = UTC offset (same as GMT offset).

utc = UTC offset (same as GMT offset)

An interval has the following form:

Line 63

Line 72

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

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

better to think of an interval as specifying time elapsed since

some event.

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

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

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.

ATTN: Add inequalities.

class PEGASUS_COMMON_LINKAGE CIMDateTime

{

public:

enum { FORMAT_LENGTH = 25 };

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

/// CIMDateTime CIMMethod

CIMDateTime();

/** CIMDateTime CIMMethod creates the CIM CIMDateTime from a string

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

constant.

the CIM DateTime-formatted datetime.

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.

CIMDateTime(const char* str);

CIMDateTime(const String & str);

/** CIMDateTime CIMMethod - Creates the CIMDateTime instance from another

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

CIMDateTime instance

@param x CIMDateTime object to be copied.

CIMDateTime(const CIMDateTime& x);

/** Destructor. */

/** CIMDateTime Destructor. */

~CIMDateTime() { }

~CIMDateTime();

/** CIMDateTime method again

/** Assign one CIMDateTime object to another.

@param x The CIMDateTime Object to assign.

CIMDateTime& operator=(const CIMDateTime& x);

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

<PRE>

CIMDateTime dt;

CIMDateTime d1;

dt.clear();

CIMDateTime d2 = "00000000000000.000000:000";

assert(dt.isNull());

d1 = d1;

</PRE>

@return This method returns true of the contents are

"00000000000000.000000:000". Else it returns false

Boolean isNull() const;

CIMDateTime& operator=(const CIMDateTime& x);

/// method getString

const char* getString() const;

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

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

the input string constant which must be

CIMDateTime Object.

@return String representing the DateTime value.

String toString () const;

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

the input parameter.

@param str String constant containing the datetime

in the datetime format.

<PRE>

Line 140

Line 142

dt.set("19991224120000.000000+360");

</PRE>

@return On format error, CIMDateTime set throws the exception

@exception InvalidDateTimeFormatException on format error.

BadDateTimeFormat

@exception Throws exception BadDateTimeFormat on format error.

void set(const char* str);

void set(const String & str);

/// CIMDateTime method clear - Clears the datetime class instance.

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

a zero interval value.

void clear();

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

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

equality

@return CIMDateTime object containing the current datetime.

PEGASUS_COMMON_LINKAGE friend Boolean operator==(

static CIMDateTime getCurrentDateTime();

const CIMDateTime& x,

const CIMDateTime& y);

/** 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 Interger containing the difference between the two datetimes

in microseconds.

@exception InvalidDateTimeFormatException If one argument is a datetime

and one is an interval.

@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 the approximate range of dates allowed are within the

range of 1901 and 2038.

static Sint64 getDifference(CIMDateTime startTime, CIMDateTime finishTime);

/** Checks whether the datetime is an interval.

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

Boolean isInterval();

/** 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, false otherwise.

Boolean equal (const CIMDateTime & x) const;

private:

Boolean _set(const char* str);

CIMDateTimeRep* _rep;

char _rep[FORMAT_LENGTH + 1];

Boolean _set(const String & dateTimeStr);

};

PEGASUS_COMMON_LINKAGE Boolean operator==(

const CIMDateTime& x,

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

Legend:

Removed from v.1.5
changed lines
	Added in v.1.34

No CVS admin address has been configured