HPS::Exchange::Configuration

class HPS.Exchange.Configuration : public HPS.Sprocket

The Configuration class is a user space object. It is a used to get configuration information for a CAD file.

Public Functions

Configuration ()

The default constructor creates an empty Configuration object.

Configuration (HPS.Exchange.Configuration in_configuration)

The copy constructor creates a new Configuration object that contains the same settings as the source Configuration.

Param in_configuration

The source Configuration to copy.

Configuration (string in_name)

This constructor creates a Configuration with the given name and no subconfigurations.

Param in_name

UTF8-encoded string with the name for this Configuration.

Configuration (string in_name, HPS.Exchange.Configuration[] in_subconfigurations)

This constructor creates a Configuration with the given name and the given subconfigurations

Param in_name

UTF8-encoded string with the name for this Configuration.

Param in_subconfigurations

The subconfigurations for this Configuration.

override void Dispose ()
override bool Empty ()

Indicates whether this Configuration has any values set on it.

Return

true if no values are set on this Configuration, false otherwise.

bool Equals (HPS.Exchange.Configuration in_kit)

Check if the source Configuration is equivalent to this Configuration.

Param in_kit

The source Configuration to compare to this Configuration.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)
override int GetHashCode ()
string GetName ()

Gets the name for this Configuration.

Return

The name for this Configuration.

HPS.Exchange.Configuration[] GetSubconfigurations ()

Gets the subconfigurations for this Configuration.

Return

The subconfigurations for this Configuration.

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 Set (HPS.Exchange.Configuration in_kit)

Copies the source Configuration into this Configuration.

Param in_kit

The source Configuration to copy.

void Show (out HPS.Exchange.Configuration out_kit)

Copies this Configuration into the given Configuration.

Param out_kit

The Configuration to populate with the contents of this Configuration.

Public Static Functions

bool operator!= (HPS.Exchange.Configuration a, HPS.Exchange.Configuration b)
bool operator== (HPS.Exchange.Configuration a, HPS.Exchange.Configuration b)