
Public Member Functions | |
override void | Dispose () |
uint | GetValue () |
Gets the unsigned integer value for this TimeMetadata. More... | |
string | GetValueAsString () |
Gets the string represenation of the time value as returned by asctime() for this TimeMetadata. More... | |
override HPS.Type | ObjectType () |
void | SetValue (uint in_value) |
Sets the unsigned integer value (interpreted like time_t) for this TimeMetadata. More... | |
TimeMetadata () | |
The default constructor creates an uninitialized TimeMetadata object. The Type() function will return Type.None. More... | |
TimeMetadata (HPS.Metadata 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. More... | |
TimeMetadata (HPS.TimeMetadata in_that) | |
The copy constructor creates a TimeMetadata object that shares the underlying smart-pointer of the source TimeMetadata. More... | |
TimeMetadata (string in_name, uint in_value) | |
This constructor creates a TimeMetadata with a given name and value. More... | |
![]() | |
virtual void | Assign (HPS.Metadata in_that) |
Share the underlying smart-pointer of the Metadata source. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Metadata in_that) |
Check if the source Metadata points to the same underlying impl as this Metadata. More... | |
override int | GetHashCode () |
string | GetName () |
Gets the name for this Metadata. More... | |
Metadata () | |
The default constructor creates an uninitialized Metadata object. The Type() function will return Type.None. More... | |
Metadata (HPS.Metadata in_that) | |
The copy constructor creates a Metadata object that shares the underlying smart-pointer of the source Metadata. More... | |
Metadata (string in_name) | |
This constructor creates a Metadata with a given name. More... | |
void | SetName (string in_name) |
Sets the name for this Metadata. More... | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
virtual HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static bool | operator!= (HPS.Metadata a, HPS.Metadata b) |
static bool | operator== (HPS.Metadata a, HPS.Metadata b) |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
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
|
inline |
The default constructor creates an uninitialized TimeMetadata object. The Type() function will return Type.None.
|
inline |
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.
|
inline |
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.
|
inline |
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
|
inline |
Gets the unsigned integer value for this TimeMetadata.
- Returns
- The unsigned integer value for this TimeMetadata.
|
inline |
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.
|
inline |
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:
- internals/hps_sprk/source/cs/HPS.TimeMetadata.cs