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(char const *in_name)

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

Parameters: in_name – UTF8-encoded string with the name for this Configuration.

Configuration(char const *in_name, ConfigurationArray const &in_subconfigurations)

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

Parameters

in_name – UTF8-encoded string with the name for this Configuration.
in_subconfigurations – The subconfigurations for this Configuration.

Configuration(char const *in_name, size_t in_count, Configuration const in_subconfigurations[])

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

Parameters

in_name – UTF8-encoded string with the name for this Configuration.
in_count – Size of the following array.
in_subconfigurations – The subconfigurations for this Configuration.

Configuration(Configuration &&in_that)

The move constructor creates an Configuration by transferring the underlying impl of the rvalue reference to this Configuration thereby avoiding a copy and allocation.

Parameters: in_that – An rvalue reference to an Configuration to take the impl from.

Configuration(Configuration const &in_configuration)

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

Parameters: in_configuration – The source Configuration to copy.

virtual bool Empty() const

Indicates whether this Configuration has any values set on it.

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

bool Equals(Configuration const &in_kit) const

Check if the source Configuration is equivalent to this Configuration.

Parameters: in_kit – The source Configuration to compare to this Configuration.
Returns: true if the objects are equivalent, false otherwise.

HPS::UTF8 GetName() const

Gets the name for this Configuration.

Returns: The name for this Configuration.

ConfigurationArray GetSubconfigurations() const

Gets the subconfigurations for this Configuration.

Returns: The subconfigurations for this Configuration.

inline virtual HPS::Type ObjectType() const

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.

bool operator!=(Configuration const &in_kit) const

Check if the source Configuration is not equivalent to this Configuration.

Parameters: in_kit – The source Configuration to compare to this Configuration.
Returns: true if the objects are not equivalent, false otherwise.

Configuration &operator=(Configuration &&in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this Configuration thereby avoiding a copy.

Parameters: in_that – An rvalue reference to an Configuration to take the impl from.
Returns: A reference to this Configuration.

Configuration &operator=(Configuration const &in_kit)

Copies the source Configuration into this Configuration.

Parameters: in_kit – The source Configuration to copy.
Returns: A reference to this Configuration.

bool operator==(Configuration const &in_kit) const

Check if the source Configuration is equivalent to this Configuration.

Parameters: in_kit – The source Configuration to compare to this Configuration.
Returns: true if the objects are equivalent, false otherwise.

void Set(Configuration const &in_kit)

Copies the source Configuration into this Configuration.

Parameters: in_kit – The source Configuration to copy.

void Show(Configuration &out_kit) const

Copies this Configuration into the given Configuration.

Parameters: out_kit – The Configuration to populate with the contents of this Configuration.

virtual ~Configuration()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::ExchangeConfiguration