DoubleMetadata

class HPS.DoubleMetadata : public HPS.Metadata

The DoubleMetadata class is a smart pointer. It represents a piece of double Metadata.

Public Functions

override void Dispose ()

DoubleMetadata ()

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

DoubleMetadata (HPS.DoubleMetadata in_that)

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

Param in_that

The source DoubleMetadata to copy.

DoubleMetadata (HPS.Metadata in_that)

This constructor creates a DoubleMetadata 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 DoubleMetadata object. Otherwise the copy will fail and the resulting DoubleMetadata will be invalid.

Param in_that

The source Metadata to copy.

DoubleMetadata (string in_name, double in_value)

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

Param in_name

The UTF8-encoded name for this DoubleMetadata.

Param in_value

The double value for this DoubleMetadata.

double GetValue ()

Gets the double value for this DoubleMetadata.

Return

The double value for this DoubleMetadata.

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 (double in_value)

Sets the double value for this DoubleMetadata.

Param in_value

The double value for this DoubleMetadata.