TimeMetadata

class HPS.TimeMetadata : HPS.Metadata

The TimeMetadata class is a smart pointer. It represents a piece of time Metadata, i.e., a 32-bit integer to be interpreted as time_t.

Public Functions

override void Dispose ()

uint GetValue ()

Gets the unsigned integer value for this TimeMetadata.

Return:The unsigned integer value for this TimeMetadata.

string GetValueAsString ()

Gets the string represenation of the time value as returned by asctime() for this TimeMetadata.

Return:The string representation of the time value as returned by asctime() for this TimeMetadata.

override HPS.Type ObjectType ()

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Return:The declared type of the object in question, which may differ from the true, underlying type.

void SetValue (uint in_value)

Sets the unsigned integer value (interpreted like time_t) for this TimeMetadata.

Param in_value:The unsigned integer value (interpreted like time_t) for this TimeMetadata.

TimeMetadata ()

The default constructor creates an uninitialized TimeMetadata object. The Type() function will return Type.None.

TimeMetadata (HPS.Metadata in_that)

This constructor creates a TimeMetadata object that shares the underlying smart-pointer of the source Metadata. The copy will only be successful if the source component is really an upcast of a TimeMetadata object. Otherwise the copy will fail and the resulting TimeMetadata will be invalid.

Param in_that:The source Metadata to copy.

TimeMetadata (HPS.TimeMetadata in_that)

The copy constructor creates a TimeMetadata object that shares the underlying smart-pointer of the source TimeMetadata.

Param in_that:The source TimeMetadata to copy.

TimeMetadata (string in_name, uint in_value)

This constructor creates a TimeMetadata with a given name and value.

Param in_name:The UTF8-encoded name for this TimeMetadata. Param in_value:The unsigned integer value (interpreted like time_t) for this TimeMetadata.