IntegerMetadata

class HPS.IntegerMetadata : public HPS.Metadata

The IntegerMetadata class is a smart pointer. It represents a piece of integer Metadata.

Public Functions

override void Dispose ()

int GetValue ()

Gets the integer value for this IntegerMetadata.

Return

The integer value for this IntegerMetadata.

IntegerMetadata ()

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

IntegerMetadata (HPS.IntegerMetadata in_that)

The copy constructor creates an IntegerMetadata object that shares the underlying smart-pointer of the source IntegerMetadata.

Param in_that

The source IntegerMetadata to copy.

IntegerMetadata (HPS.Metadata in_that)

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

Param in_that

The source Metadata to copy.

IntegerMetadata (string in_name, int in_value)

This constructor creates an IntegerMetadata with a given name and value.

Param in_name

The UTF8-encoded name for this IntegerMetadata.

Param in_value

The integer value for this IntegerMetadata.

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

Sets the integer value for this IntegerMetadata.

Param in_value

The integer value for this IntegerMetadata.