StringMetadata

class HPS::StringMetadata : public HPS::Metadata

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

Public Functions

UTF8 GetValue() const

Gets the string value for this StringMetadata.

Returns

The string value for this StringMetadata.

inline virtual HPS::Type ObjectType() const

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).

Returns

The declared type of the object in question, which may differ from the true, underlying type.

StringMetadata &operator=(StringMetadata &&in_that)

The move assignment operator transfers the underlying object of the rvalue reference to this StringMetadata.

Parameters

in_that – An rvalue reference to a StringMetadata to take the underlying object from.

Returns

A reference to this StringMetadata.

void SetValue(char const *in_value)

Sets the string value for this StringMetadata.

Parameters

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(char const *in_name, char const *in_value)

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

Parameters
StringMetadata(Metadata const &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.

Parameters

in_that – The source Metadata to copy.

StringMetadata(StringMetadata &&in_that)

The move constructor creates a StringMetadata by transferring the underlying object of the rvalue reference to this StringMetadata.

Parameters

in_that – An rvalue reference to a StringMetadata to take the underlying object from.

StringMetadata(StringMetadata const &in_that)

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

Parameters

in_that – The source StringMetadata to copy.

virtual ~StringMetadata()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::StringMetadata