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

Public Member Functions

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

Constructor & Destructor Documentation

◆ BooleanMetadata() [1/4]

HPS.BooleanMetadata.BooleanMetadata ( )
inline

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

◆ BooleanMetadata() [2/4]

HPS.BooleanMetadata.BooleanMetadata ( HPS.Metadata  in_that)
inline

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

Parameters
in_thatThe source Metadata to copy.

◆ BooleanMetadata() [3/4]

HPS.BooleanMetadata.BooleanMetadata ( HPS.BooleanMetadata  in_that)
inline

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

Parameters
in_thatThe source BooleanMetadata to copy.

◆ BooleanMetadata() [4/4]

HPS.BooleanMetadata.BooleanMetadata ( string  in_name,
bool  in_value 
)
inline

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

Parameters
in_nameThe UTF8-encoded name for this BooleanMetadata.
in_valueThe boolean value for this BooleanMetadata.

Member Function Documentation

◆ GetValue()

bool HPS.BooleanMetadata.GetValue ( )
inline

Gets the boolean value for this BooleanMetadata.

Returns
The boolean value for this BooleanMetadata.

◆ ObjectType()

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

Sets the boolean value for this BooleanMetadata.

Parameters
in_valueThe boolean value for this BooleanMetadata.

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