HPS::Exchange::Configuration Class Reference

#include <sprk_exchange.h>

Inheritance diagram for HPS::Exchange::Configuration:

Public Member Functions
	Configuration ()
	Configuration (char const *in_name)
	Configuration (char const *in_name, size_t in_count, Configuration const in_subconfigurations[])
	Configuration (char const *in_name, ConfigurationArray const &in_subconfigurations)
	Configuration (Configuration const &in_configuration)
	Configuration (Configuration &&in_that)
bool	Empty () const
bool	Equals (Configuration const &in_kit) const
HPS::UTF8	GetName () const
ConfigurationArray	GetSubconfigurations () const
HPS::Type	ObjectType () const
bool	operator!= (Configuration const &in_kit) const
Configuration &	operator= (Configuration &&in_that)
Configuration &	operator= (Configuration const &in_kit)
bool	operator== (Configuration const &in_kit) const
void	Set (Configuration const &in_kit)
void	Show (Configuration &out_kit) const
Public Member Functions inherited from HPS::Sprocket
	Sprocket (Sprocket &&in_that)
Public Member Functions inherited from HPS::Object
intptr_t	GetClassID () const
intptr_t	GetInstanceID () const
bool	HasType (HPS::Type in_mask) const
	Object (Object const &that)
	Object (Object &&in_that)
Object &	operator= (Object const &other_object)
Object &	operator= (Object &&in_that)
virtual void	Reset ()
virtual HPS::Type	Type () const

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::ExchangeConfiguration
Static Public Attributes inherited from HPS::Object
static const HPS::Type	staticType = HPS::Type::None

Additional Inherited Members
Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t	ClassID ()

Detailed Description

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

Constructor & Destructor Documentation

Configuration() [1/6]

HPS::Exchange::Configuration::Configuration

(

)

The default constructor creates an empty Configuration object.

Configuration() [2/6]

HPS::Exchange::Configuration::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() [3/6]

HPS::Exchange::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() [4/6]

HPS::Exchange::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() [5/6]

HPS::Exchange::Configuration::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.

Configuration() [6/6]

HPS::Exchange::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.

Member Function Documentation

Empty()

bool HPS::Exchange::Configuration::Empty ( ) const

virtual

Indicates whether this Configuration has any values set on it.

Returns

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

Reimplemented from HPS::Object.

Equals()

bool HPS::Exchange::Configuration::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.

GetName()

HPS::UTF8 HPS::Exchange::Configuration::GetName

(

)

const

Gets the name for this Configuration.

Returns

The name for this Configuration.

GetSubconfigurations()

ConfigurationArray HPS::Exchange::Configuration::GetSubconfigurations

(

)

const

Gets the subconfigurations for this Configuration.

Returns

The subconfigurations for this Configuration.

ObjectType()

HPS::Type HPS::Exchange::Configuration::ObjectType ( ) const

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.

operator!=()

bool HPS::Exchange::Configuration::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.

operator=() [1/2]

Configuration& HPS::Exchange::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.

operator=() [2/2]

Configuration& HPS::Exchange::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.

operator==()

bool HPS::Exchange::Configuration::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.

Set()

void HPS::Exchange::Configuration::Set

(

Configuration const &

in_kit

)

Copies the source Configuration into this Configuration.

Parameters

in_kit

The source Configuration to copy.

Show()

void HPS::Exchange::Configuration::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.

---

The documentation for this class was generated from the following file:

• include/sprk_exchange.h