#include <sprk.h>

Public Member Functions | |
unsigned int | GetValue () const |
HPS::UTF8 | GetValueAsString () const |
HPS::Type | ObjectType () const |
TimeMetadata & | operator= (TimeMetadata &&in_that) |
void | SetValue (unsigned int in_value) |
TimeMetadata () | |
TimeMetadata (Metadata const &in_that) | |
TimeMetadata (TimeMetadata const &in_that) | |
TimeMetadata (TimeMetadata &&in_that) | |
TimeMetadata (char const *in_name, unsigned 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::TimeMetadata |
![]() | |
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 TimeMetadata class is a smart pointer. It represents a piece of time Metadata, i.e., a 32-bit integer to be interpreted as time_t.
Constructor & Destructor Documentation
HPS::TimeMetadata::TimeMetadata | ( | ) |
The default constructor creates an uninitialized TimeMetadata object. The Type() function will return Type::None.
HPS::TimeMetadata::TimeMetadata | ( | Metadata const & | in_that | ) |
This constructor creates a TimeMetadata 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 TimeMetadata object. Otherwise the copy will fail and the resulting TimeMetadata will be invalid.
- Parameters
-
in_that The source Metadata to copy.
HPS::TimeMetadata::TimeMetadata | ( | TimeMetadata const & | in_that | ) |
The copy constructor creates a TimeMetadata object that shares the underlying smart-pointer of the source TimeMetadata.
- Parameters
-
in_that The source TimeMetadata to copy.
HPS::TimeMetadata::TimeMetadata | ( | TimeMetadata && | in_that | ) |
The move constructor creates a TimeMetadata by transferring the underlying object of the rvalue reference to this TimeMetadata.
- Parameters
-
in_that An rvalue reference to a TimeMetadata to take the underlying object from.
HPS::TimeMetadata::TimeMetadata | ( | char const * | in_name, |
unsigned int | in_value | ||
) |
This constructor creates a TimeMetadata with a given name and value.
- Parameters
-
in_name The UTF8-encoded name for this TimeMetadata. in_value The unsigned integer value (interpreted like time_t) for this TimeMetadata.
Member Function Documentation
unsigned int HPS::TimeMetadata::GetValue | ( | ) | const |
Gets the unsigned integer value for this TimeMetadata.
- Returns
- The unsigned integer value for this TimeMetadata.
HPS::UTF8 HPS::TimeMetadata::GetValueAsString | ( | ) | const |
Gets the string represenation of the time value as returned by asctime() for this TimeMetadata.
- Returns
- The string representation of the time value as returned by asctime() for this TimeMetadata.
TimeMetadata& HPS::TimeMetadata::operator= | ( | TimeMetadata && | in_that | ) |
The move assignment operator transfers the underlying object of the rvalue reference to this TimeMetadata.
- Parameters
-
in_that An rvalue reference to a TimeMetadata to take the underlying object from.
- Returns
- A reference to this TimeMetadata.
void HPS::TimeMetadata::SetValue | ( | unsigned int | in_value | ) |
Sets the unsigned integer value (interpreted like time_t) for this TimeMetadata.
- Parameters
-
in_value The unsigned integer value (interpreted like time_t) for this TimeMetadata.
The documentation for this class was generated from the following file:
- include/sprk.h