UnsignedIntegerMetadata

class UnsignedIntegerMetadata : public HPS::Metadata

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

Public Functions

unsigned int GetValue() const

Gets the unsigned integer value for this UnsignedIntegerMetadata.

Returns:

The unsigned integer value for this UnsignedIntegerMetadata.

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.

UnsignedIntegerMetadata &operator=(UnsignedIntegerMetadata &&in_that)

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

Parameters:

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

Returns:

A reference to this UnsignedIntegerMetadata.

void SetValue(unsigned int in_value)

Sets the unsigned integer value for this UnsignedIntegerMetadata.

Parameters:

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

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

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

Parameters:

in_that – The source Metadata to copy.

UnsignedIntegerMetadata(UnsignedIntegerMetadata &&in_that)

The move constructor creates an UnsignedIntegerMetadata by transferring the underlying object of the rvalue reference to this UnsignedIntegerMetadata.

Parameters:

in_that – An rvalue reference to an UnsignedIntegerMetadata to take the underlying object from.

UnsignedIntegerMetadata(UnsignedIntegerMetadata const &in_that)

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

Parameters:

in_that – The source UnsignedIntegerMetadata to copy.

virtual ~UnsignedIntegerMetadata()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::UnsignedIntegerMetadata