More...

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

Public Member Functions

override void Dispose ()
 
 DoubleMetadata ()
 The default constructor creates an uninitialized DoubleMetadata object. The Type() function will return Type.None. More...
 
 DoubleMetadata (HPS.Metadata in_that)
 This constructor creates a DoubleMetadata 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 DoubleMetadata object. Otherwise the copy will fail and the resulting DoubleMetadata will be invalid. More...
 
 DoubleMetadata (HPS.DoubleMetadata in_that)
 The copy constructor creates a DoubleMetadata object that shares the underlying smart-pointer of the source DoubleMetadata. More...
 
 DoubleMetadata (string in_name, double in_value)
 This constructor creates a DoubleMetadata with a given name and value. More...
 
double GetValue ()
 Gets the double value for this DoubleMetadata. More...
 
override HPS.Type ObjectType ()
 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). More...
 
void SetValue (double in_value)
 Sets the double value for this DoubleMetadata. More...
 
- 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 ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
virtual HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 

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 DoubleMetadata class is a smart pointer. It represents a piece of double Metadata.

Constructor & Destructor Documentation

◆ DoubleMetadata() [1/4]

HPS.DoubleMetadata.DoubleMetadata ( )
inline

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

◆ DoubleMetadata() [2/4]

HPS.DoubleMetadata.DoubleMetadata ( HPS.Metadata  in_that)
inline

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

Parameters
in_thatThe source Metadata to copy.

◆ DoubleMetadata() [3/4]

HPS.DoubleMetadata.DoubleMetadata ( HPS.DoubleMetadata  in_that)
inline

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

Parameters
in_thatThe source DoubleMetadata to copy.

◆ DoubleMetadata() [4/4]

HPS.DoubleMetadata.DoubleMetadata ( string  in_name,
double  in_value 
)
inline

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

Parameters
in_nameThe UTF8-encoded name for this DoubleMetadata.
in_valueThe double value for this DoubleMetadata.

Member Function Documentation

◆ GetValue()

double HPS.DoubleMetadata.GetValue ( )
inline

Gets the double value for this DoubleMetadata.

Returns
The double value for this DoubleMetadata.

◆ ObjectType()

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

Sets the double value for this DoubleMetadata.

Parameters
in_valueThe double value for this DoubleMetadata.

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