HPS.UnsignedIntegerMetadata Class Reference
Inheritance diagram for HPS.UnsignedIntegerMetadata:
HPS.Metadata HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
uint GetValue ()
 
override HPS.Type ObjectType ()
 
void SetValue (uint in_value)
 
 UnsignedIntegerMetadata ()
 
 UnsignedIntegerMetadata (HPS.Metadata in_that)
 
 UnsignedIntegerMetadata (HPS.UnsignedIntegerMetadata in_that)
 
 UnsignedIntegerMetadata (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 UnsignedIntegerMetadata class is a smart pointer. It represents a piece of unsigned integer Metadata.

Constructor & Destructor Documentation

◆ UnsignedIntegerMetadata() [1/4]

HPS.UnsignedIntegerMetadata.UnsignedIntegerMetadata ( )
inline

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

◆ UnsignedIntegerMetadata() [2/4]

HPS.UnsignedIntegerMetadata.UnsignedIntegerMetadata ( HPS.Metadata  in_that)
inline

This constructor creates an UnsignedIntegerMetadata 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 an UnsignedIntegerMetadata object. Otherwise the copy will fail and the resulting UnsignedIntegerMetadata will be invalid.

Parameters
in_thatThe source Metadata to copy.

◆ UnsignedIntegerMetadata() [3/4]

HPS.UnsignedIntegerMetadata.UnsignedIntegerMetadata ( HPS.UnsignedIntegerMetadata  in_that)
inline

The copy constructor creates an UnsignedIntegerMetadata object that shares the underlying smart-pointer of the source UnsignedIntegerMetadata.

Parameters
in_thatThe source UnsignedIntegerMetadata to copy.

◆ UnsignedIntegerMetadata() [4/4]

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

This constructor creates an UnsignedIntegerMetadata with a given name and value.

Parameters
in_nameThe UTF8-encoded name for this UnsignedIntegerMetadata.
in_valueThe unsigned integer value for this UnsignedIntegerMetadata.

Member Function Documentation

◆ GetValue()

uint HPS.UnsignedIntegerMetadata.GetValue ( )
inline

Gets the unsigned integer value for this UnsignedIntegerMetadata.

Returns
The unsigned integer value for this UnsignedIntegerMetadata.

◆ ObjectType()

override HPS.Type HPS.UnsignedIntegerMetadata.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.UnsignedIntegerMetadata.SetValue ( uint  in_value)
inline

Sets the unsigned integer value for this UnsignedIntegerMetadata.

Parameters
in_valueThe unsigned integer value for this UnsignedIntegerMetadata.

The documentation for this class was generated from the following file:
  • internals/hps_sprk/source/cs/HPS.UnsignedIntegerMetadata.cs