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

Public Member Functions

override void Dispose ()
 
int GetValue ()
 
 IntegerMetadata ()
 
 IntegerMetadata (HPS.Metadata in_that)
 
 IntegerMetadata (HPS.IntegerMetadata in_that)
 
 IntegerMetadata (string in_name, int in_value)
 
override HPS.Type ObjectType ()
 
void SetValue (int in_value)
 
- Public Member Functions inherited from HPS.Sprocket
override void Dispose ()
 
 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.Sprocket
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 IntegerMetadata class is a smart pointer. It represents a piece of integer Metadata.

Constructor & Destructor Documentation

◆ IntegerMetadata() [1/4]

HPS.IntegerMetadata.IntegerMetadata ( )
inline

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

◆ IntegerMetadata() [2/4]

HPS.IntegerMetadata.IntegerMetadata ( HPS.Metadata  in_that)
inline

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

Parameters
in_thatThe source Metadata to copy.

◆ IntegerMetadata() [3/4]

HPS.IntegerMetadata.IntegerMetadata ( HPS.IntegerMetadata  in_that)
inline

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

Parameters
in_thatThe source IntegerMetadata to copy.

◆ IntegerMetadata() [4/4]

HPS.IntegerMetadata.IntegerMetadata ( string  in_name,
int  in_value 
)
inline

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

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

Member Function Documentation

◆ GetValue()

int HPS.IntegerMetadata.GetValue ( )
inline

Gets the integer value for this IntegerMetadata.

Returns
The integer value for this IntegerMetadata.

◆ ObjectType()

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

◆ SetValue()

void HPS.IntegerMetadata.SetValue ( int  in_value)
inline

Sets the integer value for this IntegerMetadata.

Parameters
in_valueThe integer value for this IntegerMetadata.

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