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

Public Member Functions

override void Dispose ()
 
string GetValue ()
 
override HPS.Type ObjectType ()
 
void SetValue (string in_value)
 
 StringMetadata ()
 
 StringMetadata (HPS.Metadata in_that)
 
 StringMetadata (HPS.StringMetadata in_that)
 
 StringMetadata (string in_name, string 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 StringMetadata class is a smart pointer. It represents a piece of string Metadata.

Constructor & Destructor Documentation

◆ StringMetadata() [1/4]

HPS.StringMetadata.StringMetadata ( )
inline

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

◆ StringMetadata() [2/4]

HPS.StringMetadata.StringMetadata ( HPS.Metadata  in_that)
inline

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

Parameters
in_thatThe source Metadata to copy.

◆ StringMetadata() [3/4]

HPS.StringMetadata.StringMetadata ( HPS.StringMetadata  in_that)
inline

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

Parameters
in_thatThe source StringMetadata to copy.

◆ StringMetadata() [4/4]

HPS.StringMetadata.StringMetadata ( string  in_name,
string  in_value 
)
inline

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

Parameters
in_nameThe UTF8-encoded name for this StringMetadata.
in_valueThe UTF8-encoded string value for this StringMetadata.

Member Function Documentation

◆ GetValue()

string HPS.StringMetadata.GetValue ( )
inline

Gets the string value for this StringMetadata.

Returns
The string value for this StringMetadata.

◆ ObjectType()

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

Sets the string value for this StringMetadata.

Parameters
in_valueThe UTF8-encoded string value for this StringMetadata.

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