#include <sprk.h>

Public Member Functions | |
BooleanMetadata () | |
BooleanMetadata (Metadata const &in_that) | |
BooleanMetadata (BooleanMetadata const &in_that) | |
BooleanMetadata (BooleanMetadata &&in_that) | |
BooleanMetadata (char const *in_name, bool in_value) | |
bool | GetValue () const |
HPS::Type | ObjectType () const |
BooleanMetadata & | operator= (BooleanMetadata &&in_that) |
void | SetValue (bool 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 |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Detailed Description
The BooleanMetadata class is a smart pointer. It represents a piece of boolean Metadata.
Constructor & Destructor Documentation
HPS::BooleanMetadata::BooleanMetadata | ( | ) |
The default constructor creates an uninitialized BooleanMetadata object. The Type() function will return Type::None.
HPS::BooleanMetadata::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.
HPS::BooleanMetadata::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.
HPS::BooleanMetadata::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.
HPS::BooleanMetadata::BooleanMetadata | ( | char const * | in_name, |
bool | in_value | ||
) |
This constructor creates a BooleanMetadata with a given name and value.
- Parameters
-
in_name The UTF8-encoded name for this BooleanMetadata. in_value The boolean value for this BooleanMetadata.
Member Function Documentation
bool HPS::BooleanMetadata::GetValue | ( | ) | const |
Gets the boolean value for this BooleanMetadata.
- Returns
- The boolean value for this BooleanMetadata.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Metadata.
BooleanMetadata& HPS::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 HPS::BooleanMetadata::SetValue | ( | bool | in_value | ) |
Sets the boolean value for this BooleanMetadata.
- Parameters
-
in_value The boolean value for this BooleanMetadata.
The documentation for this class was generated from the following file:
- include/sprk.h