Public Member Functions | Protected Member Functions | List of all members
HPS.IntegerMetadata Class Reference

The IntegerMetadata class is a smart pointer. It represents a piece of integer Metadata. More...

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

Public Member Functions

override void Dispose ()
 
 IntegerMetadata ()
 The default constructor creates an uninitialized IntegerMetadata object. The Type() function will return Type::None. More...
 
 IntegerMetadata (HPS.Metadata in_that)
 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. More...
 
 IntegerMetadata (HPS.IntegerMetadata in_that)
 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. More...
 
 IntegerMetadata (string in_name, int in_value)
 This constructor creates an IntegerMetadata with a given name and value. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
int GetValue ()
 Gets the integer value for this IntegerMetadata. More...
 
void SetValue (int in_value)
 Sets the integer value for this IntegerMetadata. More...
 
- Public Member Functions inherited from HPS.Sprocket
override void Dispose ()
 
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
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...
 
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. 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

- Public Types inherited from HPS.Sprocket
enum  UpdateType { Synchronous = 0, Asynchronous = 1 }
 The type of update to perform, either synchronous or asynchronous. More...
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

Detailed Description

The IntegerMetadata class is a smart pointer. It represents a piece of integer Metadata.

Constructor & Destructor Documentation

HPS.IntegerMetadata.IntegerMetadata ( )
inline

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

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 <ref refid="class_h_p_s_1_1_metadata" kindref="compound">Metadata</ref> to copy.
HPS.IntegerMetadata.IntegerMetadata ( HPS.IntegerMetadata  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 <ref refid="class_h_p_s_1_1_metadata" kindref="compound">Metadata</ref> to copy.
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 <ref refid="class_h_p_s_1_1_integer_metadata" kindref="compound">IntegerMetadata</ref>.
in_valueThe integer value for this <ref refid="class_h_p_s_1_1_integer_metadata" kindref="compound">IntegerMetadata</ref>.

Member Function Documentation

int HPS.IntegerMetadata.GetValue ( )
inline

Gets the integer value for this IntegerMetadata.

Returns
The integer value for this IntegerMetadata.
override HPS.Type HPS.IntegerMetadata.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

void HPS.IntegerMetadata.SetValue ( int  in_value)
inline

Sets the integer value for this IntegerMetadata.

Parameters
in_valueThe integer value for this <ref refid="class_h_p_s_1_1_integer_metadata" kindref="compound">IntegerMetadata</ref>.

The documentation for this class was generated from the following file: