HPS::UnsignedIntegerMetadata Class Reference

#include <sprk.h>

Inheritance diagram for HPS::UnsignedIntegerMetadata:
HPS::Metadata HPS::Sprocket HPS::Object

Public Member Functions

unsigned int GetValue () const
 
HPS::Type ObjectType () const
 
UnsignedIntegerMetadataoperator= (UnsignedIntegerMetadata &&in_that)
 
void SetValue (unsigned int in_value)
 
 UnsignedIntegerMetadata ()
 
 UnsignedIntegerMetadata (Metadata const &in_that)
 
 UnsignedIntegerMetadata (UnsignedIntegerMetadata const &in_that)
 
 UnsignedIntegerMetadata (UnsignedIntegerMetadata &&in_that)
 
 UnsignedIntegerMetadata (char const *in_name, unsigned int in_value)
 
- Public Member Functions inherited from HPS::Sprocket
Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::UnsignedIntegerMetadata
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

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

Constructor & Destructor Documentation

◆ UnsignedIntegerMetadata() [1/5]

HPS::UnsignedIntegerMetadata::UnsignedIntegerMetadata ( )

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

◆ UnsignedIntegerMetadata() [2/5]

HPS::UnsignedIntegerMetadata::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_thatThe source Metadata to copy.

◆ UnsignedIntegerMetadata() [3/5]

HPS::UnsignedIntegerMetadata::UnsignedIntegerMetadata ( UnsignedIntegerMetadata const &  in_that)

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

Parameters
in_thatThe source UnsignedIntegerMetadata to copy.

◆ UnsignedIntegerMetadata() [4/5]

HPS::UnsignedIntegerMetadata::UnsignedIntegerMetadata ( UnsignedIntegerMetadata &&  in_that)

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

Parameters
in_thatAn rvalue reference to an UnsignedIntegerMetadata to take the underlying object from.

◆ UnsignedIntegerMetadata() [5/5]

HPS::UnsignedIntegerMetadata::UnsignedIntegerMetadata ( char const *  in_name,
unsigned int  in_value 
)

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

Parameters
in_nameThe UTF8-encoded name for this UnsignedIntegerMetadata.
in_valueThe unsigned integer value for this UnsignedIntegerMetadata.

Member Function Documentation

◆ GetValue()

unsigned int HPS::UnsignedIntegerMetadata::GetValue ( ) const

Gets the unsigned integer value for this UnsignedIntegerMetadata.

Returns
The unsigned integer value for this UnsignedIntegerMetadata.

◆ ObjectType()

HPS::Type HPS::UnsignedIntegerMetadata::ObjectType ( ) const
inlinevirtual

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.

Reimplemented from HPS::Metadata.

◆ operator=()

UnsignedIntegerMetadata& HPS::UnsignedIntegerMetadata::operator= ( UnsignedIntegerMetadata &&  in_that)

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

Parameters
in_thatAn rvalue reference to a UnsignedIntegerMetadata to take the underlying object from.
Returns
A reference to this UnsignedIntegerMetadata.

◆ SetValue()

void HPS::UnsignedIntegerMetadata::SetValue ( unsigned int  in_value)

Sets the unsigned integer value for this UnsignedIntegerMetadata.

Parameters
in_valueThe unsigned integer value for this UnsignedIntegerMetadata.

The documentation for this class was generated from the following file: