BooleanMetadata

class HPS.BooleanMetadata : public HPS.Metadata

The BooleanMetadata class is a smart pointer. It represents a piece of boolean Metadata.

Public Functions

BooleanMetadata ()

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

BooleanMetadata (HPS.BooleanMetadata in_that)

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

Param in_that

The source BooleanMetadata to copy.

BooleanMetadata (HPS.Metadata in_that)

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

Param in_that

The source Metadata to copy.

BooleanMetadata (string in_name, bool in_value)

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

Param in_name

The UTF8-encoded name for this BooleanMetadata.

Param in_value

The boolean value for this BooleanMetadata.

override void Dispose ()

bool GetValue ()

Gets the boolean value for this BooleanMetadata.

Return

The boolean value for this BooleanMetadata.

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

Sets the boolean value for this BooleanMetadata.

Param in_value

The boolean value for this BooleanMetadata.