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

Public Member Functions | |
override void | Dispose () |
int | GetValue () |
Gets the integer value for this IntegerMetadata. More... | |
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) | |
The copy constructor creates an IntegerMetadata object that shares the underlying smart-pointer of the source IntegerMetadata. 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... | |
void | SetValue (int in_value) |
Sets the integer value for this IntegerMetadata. More... | |
![]() | |
virtual void | Assign (HPS.Metadata in_that) |
Share the underlying smart-pointer of the Metadata source. More... | |
override void | Dispose () |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Metadata in_that) |
Check if the source Metadata points to the same underlying impl as this Metadata. More... | |
override int | GetHashCode () |
string | GetName () |
Gets the name for this Metadata. More... | |
Metadata () | |
The default constructor creates an uninitialized Metadata object. The Type() function will return Type.None. More... | |
Metadata (HPS.Metadata in_that) | |
The copy constructor creates a Metadata object that shares the underlying smart-pointer of the source Metadata. More... | |
Metadata (string in_name) | |
This constructor creates a Metadata with a given name. 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... | |
void | SetName (string in_name) |
Sets the name for this Metadata. More... | |
![]() | |
override void | Dispose () |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
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... | |
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 () |
![]() | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static bool | operator!= (HPS.Metadata a, HPS.Metadata b) |
static bool | operator== (HPS.Metadata a, HPS.Metadata b) |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The IntegerMetadata class is a smart pointer. It represents a piece of integer Metadata.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an uninitialized IntegerMetadata object. The Type() function will return Type.None.
|
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_that The source Metadata to copy.
|
inline |
The copy constructor creates an IntegerMetadata object that shares the underlying smart-pointer of the source IntegerMetadata.
- Parameters
-
in_that The source IntegerMetadata to copy.
|
inline |
This constructor creates an IntegerMetadata with a given name and value.
- Parameters
-
in_name The UTF8-encoded name for this IntegerMetadata. in_value The integer value for this IntegerMetadata.
Member Function Documentation
|
inline |
Gets the integer value for this IntegerMetadata.
- Returns
- The integer value for this IntegerMetadata.
|
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.
|
inline |
Sets the integer value for this IntegerMetadata.
- Parameters
-
in_value The integer value for this IntegerMetadata.
The documentation for this class was generated from the following file:
- internals/hps_sprk/source/cs/HPS.IntegerMetadata.cs