The Metadata class is a smart pointer. It represents a variety of metadata, i.e., a (name, value) pair, which might be associated with a Component, e.g., IDs, names, layers, user-defined or format-specific attributes, etc.
More...
|
override void | Dispose () |
|
| 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...
|
|
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...
|
|
override void | Dispose () |
|
| 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...
|
|
|
override void | deleteCptr () |
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
enum | UpdateType { Synchronous = 0,
Asynchronous = 1
} |
| The type of update to perform, either synchronous or asynchronous. More...
|
|
HandleRef | cptr |
|
HandleRef | scptr |
|
bool | cMemOwn |
|
The Metadata class is a smart pointer. It represents a variety of metadata, i.e., a (name, value) pair, which might be associated with a Component, e.g., IDs, names, layers, user-defined or format-specific attributes, etc.
HPS.Metadata.Metadata |
( |
| ) |
|
|
inline |
The default constructor creates an uninitialized Metadata object. The Type() function will return Type::None.
The copy constructor creates a Metadata object that shares the underlying smart-pointer of the source Metadata.
- Parameters
-
in_that | The source <ref refid="class_h_p_s_1_1_metadata" kindref="compound">Metadata</ref> to copy. |
HPS.Metadata.Metadata |
( |
string |
in_name | ) |
|
|
inline |
This constructor creates a Metadata with a given name.
- Parameters
-
in_name | The UTF8-encoded name for this <ref refid="class_h_p_s_1_1_metadata" kindref="compound">Metadata</ref>. |
Share the underlying smart-pointer of the Metadata source.
- Parameters
-
in_that | The <ref refid="class_h_p_s_1_1_metadata" kindref="compound">Metadata</ref> source of the assignment. |
- Returns
- A reference to this Metadata.
Check if the source Metadata points to the same underlying impl as this Metadata.
- Parameters
-
in_that | The source <ref refid="class_h_p_s_1_1_metadata" kindref="compound">Metadata</ref> to compare to this <ref refid="class_h_p_s_1_1_metadata" kindref="compound">Metadata</ref>. |
- Returns
- true if the objects reference the same impl, false otherwise.
string HPS.Metadata.GetName |
( |
| ) |
|
|
inline |
override HPS.Type HPS.Metadata.ObjectType |
( |
| ) |
|
|
inlinevirtual |
void HPS.Metadata.SetName |
( |
string |
in_name | ) |
|
|
inline |
Sets the name for this Metadata.
- Parameters
-
in_name | A UTF8-encoded name for this <ref refid="class_h_p_s_1_1_metadata" kindref="compound">Metadata</ref>. |
The documentation for this class was generated from the following file:
- internals/hps_sprk/source/cs/HPS.Metadata.cs