REFERENCE MANUAL
The Metadata class is a smart pointer. More...
Public Member Functions | |
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. 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. 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. 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... | |
Static Public Member Functions | |
static bool | operator!= (HPS.Metadata a, HPS.Metadata b) |
static bool | operator== (HPS.Metadata a, HPS.Metadata b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous = 0, Asynchronous = 1 } |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
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 | ( | ) |
HPS.Metadata.Metadata | ( | HPS.Metadata | in_that | ) |
HPS.Metadata.Metadata | ( | string | in_name | ) |
|
virtual |
bool HPS.Metadata.Equals | ( | HPS.Metadata | in_that | ) |
Check if the source Metadata points to the same underlying impl as this Metadata.
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>. |
|
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.Object.
Reimplemented in HPS.StringMetadata, HPS.TimeMetadata, and HPS.UnsignedIntegerMetadata.
void HPS.Metadata.SetName | ( | string | in_name | ) |