|
override void | deleteCptr () |
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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.
◆ Metadata() [1/3]
HPS.Metadata.Metadata |
( |
| ) |
|
|
inline |
The default constructor creates an uninitialized Metadata object. The Type() function will return Type.None.
◆ Metadata() [2/3]
The copy constructor creates a Metadata object that shares the underlying smart-pointer of the source Metadata.
- Parameters
-
◆ Metadata() [3/3]
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 Metadata. |
◆ Assign()
Share the underlying smart-pointer of the Metadata source.
- Parameters
-
in_that | The Metadata source of the assignment. |
- Returns
- A reference to this Metadata.
◆ Equals()
Check if the source Metadata points to the same underlying impl as this Metadata.
- Parameters
-
- Returns
- true if the objects reference the same impl, false otherwise.
◆ GetName()
string HPS.Metadata.GetName |
( |
| ) |
|
|
inline |
◆ ObjectType()
override HPS.Type HPS.Metadata.ObjectType |
( |
| ) |
|
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
Reimplemented in HPS.StringMetadata, HPS.TimeMetadata, and HPS.UnsignedIntegerMetadata.
◆ SetName()
void HPS.Metadata.SetName |
( |
string |
in_name | ) |
|
|
inline |
Sets the name for this Metadata.
- Parameters
-
in_name | A UTF8-encoded name for this Metadata. |
The documentation for this class was generated from the following file:
- internals/hps_sprk/source/cs/HPS.Metadata.cs