smjg.libs.util.datetime.DateTimeInterval Struct Reference

The smjg.libs.util.datetime.DateTimeInterval structure represents an interval in both date and time. More...

List of all members.

Public Member Functions

Properties
DateTimeInterval normalise ()
 Normalises this DateTimeInterval in place.
long milliseconds ()
 The value of this DateTimeInterval in milliseconds.
int hour ()
int minute ()
int second ()
int millisecond ()
string toString ()
Operators
DateTimeInterval opAdd (DateTimeInterval di)
DateTimeInterval opAdd (DateInterval di)
DateTimeInterval opAdd (TimeInterval ti)
DateTimeInterval opSub (DateTimeInterval di)
DateTimeInterval opSub (DateInterval di)
DateTimeInterval opSub (TimeInterval ti)
DateTimeInterval opMul (int i)
DateTimeInterval opMul (real r)
DateTimeInterval opDiv (int i)
DateTimeInterval opDiv (real r)
real opDiv (DateTimeInterval dti)
DateTimeInterval opAddAssign (DateInterval di)
DateTimeInterval opAddAssign (TimeInterval ti)
DateTimeInterval opSubAssign (DateInterval di)
DateTimeInterval opSubAssign (TimeInterval ti)
DateTimeInterval opAddAssign (DateTimeInterval di)
DateTimeInterval opSubAssign (DateTimeInterval di)
DateTimeInterval opMulAssign (int i)
DateTimeInterval opMulAssign (real r)
DateTimeInterval opDivAssign (int i)
DateTimeInterval opDivAssign (real r)
DateTimeInterval opAddAssign (DateTimeInterval di)
DateTimeInterval opSubAssign (DateTimeInterval di)
DateTimeInterval opMulAssign (int i)
DateTimeInterval opMulAssign (real r)
DateTimeInterval opDivAssign (int i)
DateTimeInterval opDivAssign (real r)

Static Public Member Functions

Pseudo-constructors
static DateTimeInterval opCall (int days, int millis)
 Constructs a DateTimeInterval from the given date and time intervals.
static DateTimeInterval opCall (DateInterval days)
 Constructs a DateTimeInterval equal to a given date interval.
static DateTimeInterval opCall (TimeInterval millis)
 Constructs a DateTimeInterval equal to a given time interval.
static DateTimeInterval opCall (long millis)
 Constructs a DateTimeInterval equal to a given value in milliseconds.

Public Attributes

DateInterval datePart
 The date component of the interval in days.
TimeInterval timePart
 The time component of the interval in milliseconds.


Detailed Description

The smjg.libs.util.datetime.DateTimeInterval structure represents an interval in both date and time.


Member Function Documentation

static DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opCall ( int  days,
int  millis 
) [static]

Constructs a DateTimeInterval from the given date and time intervals.

Parameters:
days date interval in days.
millis time interval in milliseconds.

static DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opCall ( DateInterval  days  )  [static]

Constructs a DateTimeInterval equal to a given date interval.

static DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opCall ( TimeInterval  millis  )  [static]

Constructs a DateTimeInterval equal to a given time interval.

static DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opCall ( long  millis  )  [static]

Constructs a DateTimeInterval equal to a given value in milliseconds.

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.normalise (  ) 

Normalises this DateTimeInterval in place.

The timePart will be normalised to the range [0..TimeValue.DAY), and datePart will be adjusted accordingly.

All methods of DateTimeInterval (except for adding or subtracting a DateInterval from an already unnormalised DateTimeInterval) return a normalised interval where applicable. This method is provided so that you can normalise the interval after modifying timePart directly.

Returns:
this interval.

long smjg.libs.util.datetime.DateTimeInterval.milliseconds (  ) 

The value of this DateTimeInterval in milliseconds.

int smjg.libs.util.datetime.DateTimeInterval.hour (  ) 

int smjg.libs.util.datetime.DateTimeInterval.minute (  ) 

int smjg.libs.util.datetime.DateTimeInterval.second (  ) 

int smjg.libs.util.datetime.DateTimeInterval.millisecond (  ) 

string smjg.libs.util.datetime.DateTimeInterval.toString (  ) 

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opAdd ( DateTimeInterval  di  ) 

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opAdd ( DateInterval  di  ) 

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opAdd ( TimeInterval  ti  ) 

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opSub ( DateTimeInterval  di  ) 

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opSub ( DateInterval  di  ) 

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opSub ( TimeInterval  ti  ) 

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opMul ( int  i  ) 

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opMul ( real  r  ) 

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opDiv ( int  i  ) 

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opDiv ( real  r  ) 

real smjg.libs.util.datetime.DateTimeInterval.opDiv ( DateTimeInterval  dti  ) 

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opAddAssign ( DateInterval  di  ) 

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opAddAssign ( TimeInterval  ti  ) 

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opSubAssign ( DateInterval  di  ) 

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opSubAssign ( TimeInterval  ti  ) 

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opAddAssign ( DateTimeInterval  di  ) 

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opSubAssign ( DateTimeInterval  di  ) 

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opMulAssign ( int  i  ) 

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opMulAssign ( real  r  ) 

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opDivAssign ( int  i  ) 

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opDivAssign ( real  r  ) 

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opAddAssign ( DateTimeInterval  di  ) 

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opSubAssign ( DateTimeInterval  di  ) 

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opMulAssign ( int  i  ) 

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opMulAssign ( real  r  ) 

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opDivAssign ( int  i  ) 

DateTimeInterval smjg.libs.util.datetime.DateTimeInterval.opDivAssign ( real  r  ) 


Member Data Documentation

DateInterval smjg.libs.util.datetime.DateTimeInterval.datePart

The date component of the interval in days.

TimeInterval smjg.libs.util.datetime.DateTimeInterval.timePart

The time component of the interval in milliseconds.

In a normalised interval, this value will be in the interval [0..TimeValue.DAY).


The documentation for this struct was generated from the following file:
Generated on Sun Sep 13 19:50:35 2009 for Stewart's Utility Library by  doxygen 1.5.4