BooleanMetadata

class 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(BooleanMetadata &&in_that)

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

Parameters:

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

BooleanMetadata(BooleanMetadata const &in_that)

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

Parameters:

in_that – The source BooleanMetadata to copy.

BooleanMetadata(char const *in_name, bool in_value)

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

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

Parameters:

in_that – The source Metadata to copy.

bool GetValue() const

Gets the boolean value for this BooleanMetadata.

Returns:

The boolean value for this BooleanMetadata.

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.

BooleanMetadata &operator=(BooleanMetadata &&in_that)

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

Parameters:

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

Returns:

A reference to this BooleanMetadata.

void SetValue(bool in_value)

Sets the boolean value for this BooleanMetadata.

Parameters:

in_value – The boolean value for this BooleanMetadata.

virtual ~BooleanMetadata()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::BooleanMetadata