Inheritance diagram for HPS.TimeMetadata:
HPS.Metadata HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
uint GetValue ()
 
string GetValueAsString ()
 
override HPS.Type ObjectType ()
 
void SetValue (uint in_value)
 
 TimeMetadata ()
 
 TimeMetadata (HPS.Metadata in_that)
 
 TimeMetadata (HPS.TimeMetadata in_that)
 
 TimeMetadata (string in_name, uint in_value)
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
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

◆ TimeMetadata() [1/4]

HPS.TimeMetadata.TimeMetadata ( )
inline

The default constructor creates an uninitialized TimeMetadata object. The Type() function will return Type.None.

◆ TimeMetadata() [2/4]

HPS.TimeMetadata.TimeMetadata ( HPS.Metadata  in_that)
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_thatThe source Metadata to copy.

◆ TimeMetadata() [3/4]

HPS.TimeMetadata.TimeMetadata ( HPS.TimeMetadata  in_that)
inline

The copy constructor creates a TimeMetadata object that shares the underlying smart-pointer of the source TimeMetadata.

Parameters
in_thatThe source TimeMetadata to copy.

◆ TimeMetadata() [4/4]

HPS.TimeMetadata.TimeMetadata ( string  in_name,
uint  in_value 
)
inline

This constructor creates a TimeMetadata with a given name and value.

Parameters
in_nameThe UTF8-encoded name for this TimeMetadata.
in_valueThe unsigned integer value (interpreted like time_t) for this TimeMetadata.

Member Function Documentation

◆ GetValue()

uint HPS.TimeMetadata.GetValue ( )
inline

Gets the unsigned integer value for this TimeMetadata.

Returns
The unsigned integer value for this TimeMetadata.

◆ GetValueAsString()

string HPS.TimeMetadata.GetValueAsString ( )
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.

◆ ObjectType()

override HPS.Type HPS.TimeMetadata.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.

◆ SetValue()

void HPS.TimeMetadata.SetValue ( uint  in_value)
inline

Sets the unsigned integer value (interpreted like time_t) for this TimeMetadata.

Parameters
in_valueThe 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