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

Public Member Functions

virtual void Assign (HPS.Metadata in_that)
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Metadata in_that)
 
override int GetHashCode ()
 
string GetName ()
 
 Metadata ()
 
 Metadata (HPS.Metadata in_that)
 
 Metadata (string in_name)
 
override HPS.Type ObjectType ()
 
void SetName (string in_name)
 
- Public Member Functions inherited from HPS.Sprocket
override void Dispose ()
 
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

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

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

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

◆ 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]

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 Metadata to copy.

◆ Metadata() [3/3]

HPS.Metadata.Metadata ( string  in_name)
inline

This constructor creates a Metadata with a given name.

Parameters
in_nameThe UTF8-encoded name for this Metadata.

Member Function Documentation

◆ Assign()

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

Share the underlying smart-pointer of the Metadata source.

Parameters
in_thatThe Metadata source of the assignment.
Returns
A reference to this Metadata.

◆ Equals()

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 Metadata to compare to this Metadata.
Returns
true if the objects reference the same impl, false otherwise.

◆ GetName()

string HPS.Metadata.GetName ( )
inline

Gets the name for this Metadata.

Returns
The name for this Metadata.

◆ 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_nameA 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