The StringMetadata class is a smart pointer. It represents a piece of string Metadata. More...
Public Member Functions | |
override void | Dispose () |
StringMetadata () | |
The default constructor creates an uninitialized StringMetadata object. The Type() function will return Type::None. More... | |
StringMetadata (HPS.Metadata in_that) | |
This constructor creates a StringMetadata 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 StringMetadata object. Otherwise the copy will fail and the resulting StringMetadata will be invalid. More... | |
StringMetadata (HPS.StringMetadata in_that) | |
This constructor creates a StringMetadata 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 StringMetadata object. Otherwise the copy will fail and the resulting StringMetadata will be invalid. More... | |
StringMetadata (string in_name, string in_value) | |
This constructor creates a StringMetadata 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... | |
string | GetValue () |
Gets the string value for this StringMetadata. More... | |
void | SetValue (string in_value) |
Sets the string value for this StringMetadata. 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... | |
virtual void | Assign (HPS.Metadata in_that) |
Share the underlying smart-pointer of the Metadata source. More... | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
bool | Equals (HPS.Metadata in_that) |
Check if the source Metadata points to the same underlying impl as this Metadata. More... | |
string | GetName () |
Gets the name for this Metadata. More... | |
void | SetName (string in_name) |
Sets the name for this Metadata. More... | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
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 () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous = 0, Asynchronous = 1 } |
The type of update to perform, either synchronous or asynchronous. More... | |
![]() | |
static bool | operator== (HPS.Metadata a, HPS.Metadata b) |
static bool | operator!= (HPS.Metadata a, HPS.Metadata b) |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
The StringMetadata class is a smart pointer. It represents a piece of string Metadata.
|
inline |
The default constructor creates an uninitialized StringMetadata object. The Type() function will return Type::None.
|
inline |
This constructor creates a StringMetadata 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 StringMetadata object. Otherwise the copy will fail and the resulting StringMetadata will be invalid.
in_that | The source <ref refid="class_h_p_s_1_1_metadata" kindref="compound">Metadata</ref> to copy. |
|
inline |
This constructor creates a StringMetadata 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 StringMetadata object. Otherwise the copy will fail and the resulting StringMetadata will be invalid.
in_that | The source <ref refid="class_h_p_s_1_1_metadata" kindref="compound">Metadata</ref> to copy. |
|
inline |
This constructor creates a StringMetadata with a given name and value.
in_name | The UTF8-encoded name for this <ref refid="class_h_p_s_1_1_string_metadata" kindref="compound">StringMetadata</ref>. |
in_value | The UTF8-encoded string value for this <ref refid="class_h_p_s_1_1_string_metadata" kindref="compound">StringMetadata</ref>. |
|
inline |
Gets the string value for this StringMetadata.
|
inlinevirtual |
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.
|
inline |
Sets the string value for this StringMetadata.
in_value | The UTF8-encoded string value for this <ref refid="class_h_p_s_1_1_string_metadata" kindref="compound">StringMetadata</ref>. |