REFERENCE MANUAL
The UnsignedIntegerMetadata class is a smart pointer. More...
Public Member Functions | |
override void | Dispose () |
uint | GetValue () |
Gets the unsigned integer value for this UnsignedIntegerMetadata. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | SetValue (uint in_value) |
Sets the unsigned integer value for this UnsignedIntegerMetadata. More... | |
UnsignedIntegerMetadata () | |
The default constructor creates an uninitialized UnsignedIntegerMetadata object. More... | |
UnsignedIntegerMetadata (HPS.Metadata in_that) | |
This constructor creates an UnsignedIntegerMetadata object that shares the underlying smart-pointer of the source Metadata. More... | |
UnsignedIntegerMetadata (HPS.UnsignedIntegerMetadata in_that) | |
This constructor creates an UnsignedIntegerMetadata object that shares the underlying smart-pointer of the source Metadata. More... | |
UnsignedIntegerMetadata (string in_name, uint in_value) | |
This constructor creates an UnsignedIntegerMetadata with a given name and value. More... | |
![]() | |
virtual void | Assign (HPS.Metadata in_that) |
Share the underlying smart-pointer of the Metadata source. More... | |
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. 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... | |
void | SetName (string in_name) |
Sets the name for this Metadata. More... | |
![]() | |
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. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
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... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous = 0, Asynchronous = 1 } |
![]() | |
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 |
HandleRef | scptr |
The UnsignedIntegerMetadata class is a smart pointer.
It represents a piece of unsigned integer Metadata.
HPS.UnsignedIntegerMetadata.UnsignedIntegerMetadata | ( | ) |
The default constructor creates an uninitialized UnsignedIntegerMetadata object.
The Type() function will return Type::None.
HPS.UnsignedIntegerMetadata.UnsignedIntegerMetadata | ( | HPS.Metadata | in_that | ) |
This constructor creates an UnsignedIntegerMetadata 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 UnsignedIntegerMetadata object. Otherwise the copy will fail and the resulting UnsignedIntegerMetadata will be invalid.
in_that | The source <ref refid="class_h_p_s_1_1_metadata" kindref="compound">Metadata</ref> to copy. |
HPS.UnsignedIntegerMetadata.UnsignedIntegerMetadata | ( | HPS.UnsignedIntegerMetadata | in_that | ) |
This constructor creates an UnsignedIntegerMetadata 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 UnsignedIntegerMetadata object. Otherwise the copy will fail and the resulting UnsignedIntegerMetadata will be invalid.
in_that | The source <ref refid="class_h_p_s_1_1_metadata" kindref="compound">Metadata</ref> to copy. |
HPS.UnsignedIntegerMetadata.UnsignedIntegerMetadata | ( | string | in_name, |
uint | in_value | ||
) |
This constructor creates an UnsignedIntegerMetadata with a given name and value.
in_name | The UTF8-encoded name for this <ref refid="class_h_p_s_1_1_unsigned_integer_metadata" kindref="compound">UnsignedIntegerMetadata</ref>. |
in_value | The unsigned integer value for this <ref refid="class_h_p_s_1_1_unsigned_integer_metadata" kindref="compound">UnsignedIntegerMetadata</ref>. |
uint HPS.UnsignedIntegerMetadata.GetValue | ( | ) |
Gets the unsigned integer value for this UnsignedIntegerMetadata.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Metadata.
void HPS.UnsignedIntegerMetadata.SetValue | ( | uint | in_value | ) |
Sets the unsigned integer value for this UnsignedIntegerMetadata.
in_value | The unsigned integer value for this <ref refid="class_h_p_s_1_1_unsigned_integer_metadata" kindref="compound">UnsignedIntegerMetadata</ref>. |