Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
HPS.Metadata Class Reference

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...

Inheritance diagram for HPS.Metadata:
HPS.Sprocket HPS.Object HPS.BooleanMetadata HPS.DoubleMetadata HPS.IntegerMetadata HPS.StringMetadata HPS.TimeMetadata HPS.UnsignedIntegerMetadata

Public Member Functions

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...
 
- Public Member Functions inherited from HPS.Sprocket
override void Dispose ()
 
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
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...
 

Static Public Member Functions

static bool operator== (HPS.Metadata a, HPS.Metadata b)
 
static bool operator!= (HPS.Metadata a, HPS.Metadata b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Sprocket
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Public Types inherited from HPS.Sprocket
enum  UpdateType { Synchronous = 0, Asynchronous = 1 }
 The type of update to perform, either synchronous or asynchronous. More...
 
- Protected Attributes inherited from HPS.Object
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

Detailed Description

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.

Constructor & Destructor Documentation

HPS.Metadata.Metadata ( )
inline

The default constructor creates an uninitialized Metadata object. The Type() function will return Type::None.

HPS.Metadata.Metadata ( HPS.Metadata  in_that)
inline

The copy constructor creates a Metadata object that shares the underlying smart-pointer of the source Metadata.

Parameters
in_thatThe 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_nameThe UTF8-encoded name for this <ref refid="class_h_p_s_1_1_metadata" kindref="compound">Metadata</ref>.

Member Function Documentation

virtual void HPS.Metadata.Assign ( HPS.Metadata  in_that)
inlinevirtual

Share the underlying smart-pointer of the Metadata source.

Parameters
in_thatThe <ref refid="class_h_p_s_1_1_metadata" kindref="compound">Metadata</ref> source of the assignment.
Returns
A reference to this Metadata.
bool HPS.Metadata.Equals ( HPS.Metadata  in_that)
inline

Check if the source Metadata points to the same underlying impl as this Metadata.

Parameters
in_thatThe 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

Gets the name for this Metadata.

Returns
The name for this Metadata.
override HPS.Type HPS.Metadata.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying 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.

void HPS.Metadata.SetName ( string  in_name)
inline

Sets the name for this Metadata.

Parameters
in_nameA 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: