Time Class Reference

The Time data type class represents a time value. More...

Inheritance diagram for Time:

Collaboration diagram for Time:

Static Public Member Functions
_.Library.Time	DisplayToLogical (_, _.Library.String val)
	Converts the input value val, which represents a time value,. More...
_.Library.Status	IsValid (_, _.Library.RawString val)
	Tests if the logical value val, which represents a time value. More...
_.Library.String	LogicalToDisplay (_, _.Library.Time val)
	Converts the value of val, which is a logical time value. More...
_.Library.String	LogicalToOdbc (_, _.Library.Time val)
	Converts val, which represents a logical time value. More...
_.Library.String	LogicalToXSD (_, _.Library.Time val)
	Converts the Time value to the canonical SOAP encoded value.
_.Library.Time	Normalize (_, _.Library.RawString val)
	Converts val to a normalized value.
_.Library.Time	OdbcToLogical (_, _.Library.String val)
	Converts val, which represents a time in ODBC format,. More...
_.Library.Time	XSDToLogical (_, _.Library.String val)
	Converts the SOAP encoded input time value into a Time value.

Static Public Attributes
	DISPLAYLIST = None
	The Time data type class represents a time value. More...
	FORMAT = None
	The format specification for the data type's display value. More...
	MAXVAL = None
	The maximum allowed logical value for the data type.
	MINVAL = None
	The minimum allowed logical value for the data type.
	PRECISION = None
	The number of decimal places of precision to keep for Time values. More...
	VALUELIST = None
	Used for enumerated (multiple-choice) attributes. More...
	XMLTIMEZONE = None
	XMLTIMEZONE specifies the handling of timezone part of the XML format dateTime. More...
	XSDTYPE = None
	Declares the XSD type used when projecting XML Schemas.
Static Public Attributes inherited from DataType
	INDEXNULLMARKER = None
	Override this parameter value to specify what value should be used as a null marker when a property of the type is used in a subscript of an index map. More...

Detailed Description

The Time data type class represents a time value.

The logical value of the Time data type is the number of seconds past midnight.

Member Function Documentation

DisplayToLogical()

_.Library.Time DisplayToLogical (   _, _.Library.String  val  )

static

Converts the input value val, which represents a time value,.

into a logical time value (number of seconds since midnight).

Returns the value of the input string val as a logical time value (number of seconds since midnight).

IsValid()

_.Library.Status IsValid (   _, _.Library.RawString  val  )

static

Tests if the logical value val, which represents a time value.

(number of seconds since midnight), is valid. The validation is based on the class parameter settings used for the class attribute this data type is associated with. In this case, MAXVAL and MINVAL.

Reimplemented from DataType.

LogicalToDisplay()

_.Library.String LogicalToDisplay (   _, _.Library.Time  val  )

static

Converts the value of val, which is a logical time value.

(number of seconds since midnight), into a display string. The formatting is based on the value of the FORMAT parameter. Returns the formatted value of val.

LogicalToOdbc()

_.Library.String LogicalToOdbc (   _, _.Library.Time  val  )

static

Converts val, which represents a logical time value.

(number of seconds since midnight), into ODBC time format.

Returns the ODBC time string for the logical time value val.

OdbcToLogical()

_.Library.Time OdbcToLogical (   _, _.Library.String  val  )

static

Converts val, which represents a time in ODBC format,.

into a logical time value (number of seconds since midnight).

Returns the logical time value of the ODBC time string val.

Member Data Documentation

DISPLAYLIST

DISPLAYLIST = None

static

The Time data type class represents a time value.

The logical value of the Time data type is the number of seconds past midnight.

Used for enumerated (multiple-choice) attributes.

Used in conjunction with the VALUELIST parameter for enumerated (multiple-choice) attributes. DISPLAYLIST, if not null, represents the display values for the attribute corresponding with the logical values listed in VALUELIST.

The display values are returned by the LogicalToDisplay method.

FORMAT

FORMAT = None

static

The format specification for the data type's display value.

The value of the FORMAT parameter corresponds to the available parameters of the $ZDATETIME and $ZDATETIMEH functions, which are used to perform the formatting.

PRECISION

PRECISION = None

static

The number of decimal places of precision to keep for Time values.

If "" then keep whatever precision is provided by the caller.

VALUELIST

VALUELIST = None

static

Used for enumerated (multiple-choice) attributes.

VALUELIST is either a null string ("") or a delimiter separated list (where the delimiter is the first character) of logical values. If a non-null value is present, then the attribute is restricted to values in the list, and the validation code simply checks to see if the value is in the list.

XMLTIMEZONE

XMLTIMEZONE = None

static

XMLTIMEZONE specifies the handling of timezone part of the XML format dateTime.

"UTC" means convert to UTC on input. "IGNORE means ignore the timezone.