(file) Return to CIMDateTime.h CVS log (file) (dir) Up to [Pegasus] / pegasus / src / Pegasus / Common

Diff for /pegasus/src/Pegasus/Common/CIMDateTime.h between version 1.32 and 1.34

version 1.32, 2002/08/20 17:39:37 version 1.34, 2003/03/12 21:02:53
Line 41 
Line 41 
  
 PEGASUS_NAMESPACE_BEGIN 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; class CIMDateTimeRep;
  
 /** /**
Line 87 
Line 81 
     Note that intervals always end in ":000" (this is how they     Note that intervals always end in ":000" (this is how they
     are distinguished from dates).     are distinguished from dates).
  
     Intervals are really durations since they do not specify a start and  
     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 String objects or from     CIMDateTime objects are constructed from String objects or from
     other CIMDateTime objects.  These character strings must be exactly     other CIMDateTime objects.  These character strings must be exactly
     twenty-five characters and conform to one of the forms identified     twenty-five characters and conform to one of the forms identified
Line 107 
Line 96 
 { {
 public: public:
  
     /** Creates a new CIMDateTime object with a zero interval value      /** Creates a new CIMDateTime object with a zero interval value.
     */     */
     CIMDateTime();     CIMDateTime();
  
     /** CIMDateTime - Creates 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 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 CIM DateTime-formatted string.
     */     */
     CIMDateTime(const String & str);     CIMDateTime(const String & str);
  
     /** CIMDateTime Create a CIMDateTime instance from another      /** Creates a CIMDateTime object from another CIMDateTime object.
         CIMDateTime object  
         @param x CIMDateTime object to be copied.         @param x CIMDateTime object to be copied.
     */     */
     CIMDateTime(const CIMDateTime& x);     CIMDateTime(const CIMDateTime& x);
  
     /** DateTime Destructor. */      /** CIMDateTime Destructor. */
     ~CIMDateTime();     ~CIMDateTime();
  
     /**  Assign one DateTime object to another      /** Assign one CIMDateTime object to another.
     @param - The DateTime Object to assign          @param x  The CIMDateTime Object to assign.
     <pre>          <PRE>
     CIMDateTime d1;     CIMDateTime d1;
     CIMDateTime d2 = "00000000000000.000000:000";     CIMDateTime d2 = "00000000000000.000000:000";
     d1 = d1;     d1 = d1;
     </pre>          </PRE>
     */     */
     CIMDateTime& operator=(const CIMDateTime& x);     CIMDateTime& operator=(const CIMDateTime& x);
  
     /** toString - Returns the string representing the DateTime value of the      /** Returns a string representing the DateTime value of the
         CIMDateTime Object.         CIMDateTime Object.
           @return String representing the DateTime value.
     */     */
     String toString () const;     String toString () const;
  
     /** method set - Sets the date time. Creates the CIMDateTime instance from      /** Sets the date time in the CIMDateTime object from
         the input string constant which must be          the input parameter.
           @param str  String constant containing the datetime
         in the datetime format.         in the datetime format.
  
             <PRE>             <PRE>
Line 156 
Line 146 
     */     */
     void set(const String & str);     void set(const String & str);
  
     /**  clear - Clears the datetime class instance.  The date time is set to      /** Clears the datetime class object.  The date time is set to
          a zero interval value.          a zero interval value.
     */     */
     void clear();     void clear();
  
     /**      /** Get current time as CIMDateTime. The time returned is the local time.
     Get current time as CIMDateTime. The time returned is the local time.          @return CIMDateTime object containing the current datetime.
   
     @return CIMDateTime   Contains the current datetime as a CIMDateTime object.  
     */     */
     static CIMDateTime getCurrentDateTime();     static CIMDateTime getCurrentDateTime();
  
     /**      /** Computes the difference in microseconds between two CIMDateTime dates or
     Computes the difference in microseconds between two CIMDateTime dates or          two CIMDateTime intervals.
     two CIMDateTime intervals          @param startTime  Contains the start datetime.
           @param finishTime  Contains the finish datetime.
     @param startTime     Contains the start datetime          @return Interger containing the difference between the two datetimes
           in microseconds.
     @param finishTime    Contains the finish datetime          @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.
  
     @return difference   Difference between the two datetimes in microseconds          On Windows platform, the approximate range is between 1970 to 2038.
  
     @exception InvalidDateTimeFormatException If one argument is a datetime          On Red Hat Linux the approximate range of dates allowed are within the
     and one is an interval          range of 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, false otherwise.
   
     @return isInterval  True if the datetime is an interval, else false  
     */     */
     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.
     @return True if the two CIMDateTime objects are equal,          @return true if the two CIMDateTime objects are equal, false otherwise.
             False otherwise  
     */     */
     Boolean equal (const CIMDateTime & x) const;     Boolean equal (const CIMDateTime & x) const;
  

Legend:
Removed from v.1.32  
changed lines
  Added in v.1.34
No CVS admin address has been configured
 Powered by
ViewCVS 0.9.2