StringMetadata

class HPS.StringMetadata : HPS.Metadata

The StringMetadata class is a smart pointer. It represents a piece of string Metadata.

Public Functions

override void Dispose ()

string GetValue ()

Gets the string value for this StringMetadata.

Return:The string value for this StringMetadata.

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

Sets the string value for this StringMetadata.

Param in_value:The UTF8-encoded string value for this StringMetadata.

StringMetadata ()

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

StringMetadata (HPS.Metadata in_that)

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

Param in_that:The source Metadata to copy.

StringMetadata (HPS.StringMetadata in_that)

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

Param in_that:The source StringMetadata to copy.

StringMetadata (string in_name, string in_value)

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

Param in_name:The UTF8-encoded name for this StringMetadata. Param in_value:The UTF8-encoded string value for this StringMetadata.