Metadata

class HPS.Metadata : public HPS.Sprocket

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.

Subclassed by HPS.BooleanMetadata, HPS.DoubleMetadata, HPS.IntegerMetadata, HPS.StringMetadata, HPS.TimeMetadata, HPS.UnsignedIntegerMetadata

Public Functions

void Assign (HPS.Metadata in_that)

Share the underlying smart-pointer of the Metadata source.

Param in_that

The Metadata source of the assignment.

Return

A reference to this Metadata.

override void Dispose ()

bool Equals (HPS.Metadata in_that)

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

Param in_that

The source Metadata to compare to this Metadata.

Return

true if the objects reference the same impl, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

string GetName ()

Gets the name for this Metadata.

Return

The name for this Metadata.

Metadata ()

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

Metadata (HPS.Metadata in_that)

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

Param in_that

The source Metadata to copy.

Metadata (string in_name)

This constructor creates a Metadata with a given name.

Param in_name

The UTF8-encoded name for this Metadata.

override HPS.Type ObjectType ()

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

Return

The declared type of the object in question, which may differ from the true, underlying type.

void SetName (string in_name)

Sets the name for this Metadata.

Param in_name

A UTF8-encoded name for this Metadata.

Public Static Functions

bool operator!= (HPS.Metadata a, HPS.Metadata b)

bool operator== (HPS.Metadata a, HPS.Metadata b)