UnsignedIntegerMetadata

class HPS.UnsignedIntegerMetadata : public HPS.Metadata

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

Public Functions

override void Dispose ()
uint GetValue ()

Gets the unsigned integer value for this UnsignedIntegerMetadata.

Return

The unsigned integer value for this UnsignedIntegerMetadata.

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 for this UnsignedIntegerMetadata.

Param in_value

The unsigned integer value for this UnsignedIntegerMetadata.

UnsignedIntegerMetadata ()

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

UnsignedIntegerMetadata (HPS.Metadata in_that)

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

Param in_that

The source Metadata to copy.

UnsignedIntegerMetadata (HPS.UnsignedIntegerMetadata in_that)

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

Param in_that

The source UnsignedIntegerMetadata to copy.

UnsignedIntegerMetadata (string in_name, uint in_value)

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

Param in_name

The UTF8-encoded name for this UnsignedIntegerMetadata.

Param in_value

The unsigned integer value for this UnsignedIntegerMetadata.