#include <sprk.h>
|
static const HPS::Type | staticType = HPS::Type::Metadata |
|
static const HPS::Type | staticType = HPS::Type::None |
|
|
template<typename T > |
static intptr_t | ClassID () |
|
The Metadata class is a smart pointer. It represents a variety of metadata, i.e., a (name, value) pair, which might be associated with a Component, e.g., IDs, names, layers, user-defined or format-specific attributes, etc.
◆ Metadata() [1/4]
HPS::Metadata::Metadata |
( |
| ) |
|
The default constructor creates an uninitialized Metadata object. The Type() function will return Type::None.
◆ Metadata() [2/4]
HPS::Metadata::Metadata |
( |
Metadata const & |
in_that | ) |
|
The copy constructor creates a Metadata object that shares the underlying smart-pointer of the source Metadata.
- Parameters
-
◆ Metadata() [3/4]
HPS::Metadata::Metadata |
( |
Metadata && |
in_that | ) |
|
The move constructor creates a Metadata by transferring the underlying object of the rvalue reference to this Metadata.
- Parameters
-
in_that | An rvalue reference to a Metadata to take the underlying object from. |
◆ Metadata() [4/4]
HPS::Metadata::Metadata |
( |
char const * |
in_name | ) |
|
This constructor creates a Metadata with a given name.
- Parameters
-
in_name | The UTF8-encoded name for this Metadata. |
◆ Assign()
virtual void HPS::Metadata::Assign |
( |
Metadata const & |
in_that | ) |
|
|
virtual |
Share the underlying smart-pointer of the Metadata source.
- Parameters
-
in_that | The Metadata source of the assignment. |
- Returns
- A reference to this Metadata.
◆ Equals()
bool HPS::Metadata::Equals |
( |
Metadata const & |
in_that | ) |
const |
Check if the source Metadata points to the same underlying impl as this Metadata.
- Parameters
-
- Returns
- true if the objects reference the same impl, false otherwise.
◆ GetName()
◆ ObjectType()
HPS::Type HPS::Metadata::ObjectType |
( |
| ) |
const |
|
inlinevirtual |
◆ operator!=()
bool HPS::Metadata::operator!= |
( |
Metadata const & |
in_that | ) |
const |
Check if the source Metadata points to a different impl than this Metadata.
- Parameters
-
- Returns
- true if the objects reference different impls, false otherwise.
◆ operator=() [1/2]
Share the underlying smart-pointer of the Metadata source.
- Parameters
-
in_that | The Metadata source of the assignment. |
- Returns
- A reference to this Metadata.
◆ operator=() [2/2]
The move assignment operator transfers the underlying object of the rvalue reference to this Metadata.
- Parameters
-
in_that | An rvalue reference to a Metadata to take the underlying object from. |
- Returns
- A reference to this Metadata.
◆ operator==()
bool HPS::Metadata::operator== |
( |
Metadata const & |
in_that | ) |
const |
Check if the source Metadata points to the same underlying impl as this Metadata.
- Parameters
-
- Returns
- true if the objects reference the same impl, false otherwise.
◆ SetName()
void HPS::Metadata::SetName |
( |
char const * |
in_name | ) |
|
Sets the name for this Metadata.
- Parameters
-
in_name | A UTF8-encoded name for this Metadata. |
The documentation for this class was generated from the following file: