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.8 and 1.32

version 1.8, 2001/06/16 23:09:59

version 1.32, 2002/08/20 17:39:37

Line 1

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

// The Open Group, Tivoli Systems

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

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

Line 22

Line 23

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

Line 37

#include <Pegasus/Common/Config.h>

#include <Pegasus/Common/Array.h>

#include <iostream>

#include <Pegasus/Common/Linkage.h>

PEGASUS_NAMESPACE_BEGIN

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

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

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

the Java rep is probably tostring, not get string,

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 47

Line 61

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 64

Line 78

Where

dddddddd = days

hh = hours

hh = hours (0-23)

mm = minutes

mm = minutes (0-59)

ss = seconds

ss = seconds (0-59)

mmmmmm = microseconds

</PRE>

Line 78

Line 92

better to think of an interval as specifying time elapsed since

some event.

CIMDateTime objects are constructed from C character strings or from

CIMDateTime objects are constructed from String objects 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

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

constant representing the CIM DateTime formatted datetime

constant representing the CIM DateTime-formatted datetime

@param str String object containing the CIM DateTime formatted string

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

/** CIMDateTime Create a CIMDateTime instance from another

CIMDateTime object

@param x CIMDateTime object to be copied.

CIMDateTime(const CIMDateTime& x);

/** Destructor. */

/** DateTime Destructor. */

~CIMDateTime() { }

~CIMDateTime();

/** assign CIMDateTime

/** Assign one DateTime object to another

@param - The DateTime Object to assign

<pre>

CIMDateTime d1;

CIMDateTime d2 = "00000000000000.000000:000";

d1 = d1;

</pre>

CIMDateTime& operator=(const CIMDateTime& x);

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

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

<PRE>

CIMDateTime Object.

CIMDateTime dt;

dt.clear();

assert(dt.isNull());

</PRE>

@return This method returns true of the contents are

"00000000000000.000000:000". Else it returns false

Boolean isNull() const;

String toString () const;

/// method getString

const char* getString() const;

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

the input string constant which must be

Line 143

Line 152

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

/// clear - Clears the datetime class instance.

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

a zero interval value.

void clear();

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

/**

equality

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

@return CIMDateTime Contains the current datetime as a CIMDateTime object.

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 difference Difference between the two datetimes in microseconds

@exception InvalidDateTimeFormatException If one argument is a datetime

and one is an interval

static Sint64 getDifference(CIMDateTime startTime, CIMDateTime finishTime);

/**

Checks whether the datetime is an interval.

@return isInterval True if the datetime is an interval, else false

Boolean isInterval();

/**

Compares the CIMDateTime object to another CIMDateTime object for equality

@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.8
changed lines
	Added in v.1.32

No CVS admin address has been configured