TimeMetadata

class HPS::TimeMetadata : public 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

unsigned int GetValue() const

Gets the unsigned integer value for this TimeMetadata.

Returns

The unsigned integer value for this TimeMetadata.

HPS::UTF8 GetValueAsString() const

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

Returns

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

inline virtual HPS::Type ObjectType() const

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

Returns

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

TimeMetadata &operator=(TimeMetadata &&in_that)

The move assignment operator transfers the underlying object of the rvalue reference to this TimeMetadata.

Parameters

in_that – An rvalue reference to a TimeMetadata to take the underlying object from.

Returns

A reference to this TimeMetadata.

void SetValue(unsigned int in_value)

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

Parameters

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(char const *in_name, unsigned int in_value)

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

Parameters

  • in_name – The UTF8-encoded name for this TimeMetadata.

  • in_value – The unsigned integer value (interpreted like time_t) for this TimeMetadata.

TimeMetadata(Metadata const &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.

Parameters

in_that – The source Metadata to copy.

TimeMetadata(TimeMetadata &&in_that)

The move constructor creates a TimeMetadata by transferring the underlying object of the rvalue reference to this TimeMetadata.

Parameters

in_that – An rvalue reference to a TimeMetadata to take the underlying object from.

TimeMetadata(TimeMetadata const &in_that)

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

Parameters

in_that – The source TimeMetadata to copy.

virtual ~TimeMetadata()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::TimeMetadata