#include <sprk.h>

Public Member Functions | |
int | GetValue () const |
IntegerMetadata () | |
IntegerMetadata (Metadata const &in_that) | |
IntegerMetadata (IntegerMetadata const &in_that) | |
IntegerMetadata (IntegerMetadata &&in_that) | |
IntegerMetadata (char const *in_name, int in_value) | |
HPS::Type | ObjectType () const |
IntegerMetadata & | operator= (IntegerMetadata &&in_that) |
void | SetValue (int in_value) |
![]() | |
virtual void | Assign (Metadata const &in_that) |
bool | Equals (Metadata const &in_that) const |
HPS::UTF8 | GetName () const |
Metadata () | |
Metadata (Metadata const &in_that) | |
Metadata (Metadata &&in_that) | |
Metadata (char const *in_name) | |
bool | operator!= (Metadata const &in_that) const |
Metadata & | operator= (Metadata const &in_that) |
Metadata & | operator= (Metadata &&in_that) |
bool | operator== (Metadata const &in_that) const |
void | SetName (char const *in_name) |
![]() | |
Sprocket (Sprocket &&in_that) | |
![]() | |
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) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
virtual HPS::Type | Type () const |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::IntegerMetadata |
![]() | |
static const HPS::Type | staticType = HPS::Type::Metadata |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Detailed Description
The IntegerMetadata class is a smart pointer. It represents a piece of integer Metadata.
Constructor & Destructor Documentation
◆ IntegerMetadata() [1/5]
HPS::IntegerMetadata::IntegerMetadata | ( | ) |
The default constructor creates an uninitialized IntegerMetadata object. The Type() function will return Type::None.
◆ IntegerMetadata() [2/5]
HPS::IntegerMetadata::IntegerMetadata | ( | Metadata const & | in_that | ) |
This constructor creates an IntegerMetadata 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 IntegerMetadata object. Otherwise the copy will fail and the resulting IntegerMetadata will be invalid.
- Parameters
-
in_that The source Metadata to copy.
◆ IntegerMetadata() [3/5]
HPS::IntegerMetadata::IntegerMetadata | ( | IntegerMetadata const & | in_that | ) |
The copy constructor creates an IntegerMetadata object that shares the underlying smart-pointer of the source IntegerMetadata.
- Parameters
-
in_that The source IntegerMetadata to copy.
◆ IntegerMetadata() [4/5]
HPS::IntegerMetadata::IntegerMetadata | ( | IntegerMetadata && | in_that | ) |
The move constructor creates an IntegerMetadata by transferring the underlying object of the rvalue reference to this IntegerMetadata.
- Parameters
-
in_that An rvalue reference to an IntegerMetadata to take the underlying object from.
◆ IntegerMetadata() [5/5]
HPS::IntegerMetadata::IntegerMetadata | ( | char const * | in_name, |
int | in_value | ||
) |
This constructor creates an IntegerMetadata with a given name and value.
- Parameters
-
in_name The UTF8-encoded name for this IntegerMetadata. in_value The integer value for this IntegerMetadata.
Member Function Documentation
◆ GetValue()
int HPS::IntegerMetadata::GetValue | ( | ) | const |
Gets the integer value for this IntegerMetadata.
- Returns
- The integer value for this IntegerMetadata.
◆ ObjectType()
|
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=()
IntegerMetadata& HPS::IntegerMetadata::operator= | ( | IntegerMetadata && | in_that | ) |
The move assignment operator transfers the underlying object of the rvalue reference to this IntegerMetadata.
- Parameters
-
in_that An rvalue reference to an IntegerMetadata to take the underlying object from.
- Returns
- A reference to this IntegerMetadata.
◆ SetValue()
void HPS::IntegerMetadata::SetValue | ( | int | in_value | ) |
Sets the integer value for this IntegerMetadata.
- Parameters
-
in_value The integer value for this IntegerMetadata.
The documentation for this class was generated from the following file:
- include/sprk.h