HPS::Exchange::Configuration Class Reference

The Configuration class is a user space object. More...

#include <sprk_exchange.h>

Inheritance diagram for HPS::Exchange::Configuration:

Collaboration diagram for HPS::Exchange::Configuration:

Public Member Functions
	Configuration ()
	The default constructor creates an empty Configuration object. More...
	Configuration (char const *in_name)
	This constructor creates a Configuration with the given name and no subconfigurations. More...
	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. More...
	Configuration (char const *in_name, ConfigurationArray const &in_subconfigurations)
	This constructor creates a Configuration with the given name and the given subconfigurations. More...
	Configuration (Configuration const &in_configuration)
	The copy constructor creates a new Configuration object that contains the same settings as the source Configuration. More...
	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. More...
Configuration &	operator= (Configuration &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this Configuration thereby avoiding a copy. More...
virtual	~Configuration ()
HPS::Type	ObjectType () const
void	Set (Configuration const &in_kit)
	Copies the source Configuration into this Configuration. More...
void	Show (Configuration &out_kit) const
	Copies this Configuration into the given Configuration. More...
Configuration &	operator= (Configuration const &in_kit)
	Copies the source Configuration into this Configuration. More...
bool	Empty () const
	Indicates whether this Configuration has any values set on it. More...
bool	Equals (Configuration const &in_kit) const
	Check if the source Configuration is equivalent to this Configuration. More...
bool	operator== (Configuration const &in_kit) const
	Check if the source Configuration is equivalent to this Configuration. More...
bool	operator!= (Configuration const &in_kit) const
	Check if the source Configuration is not equivalent to this Configuration. More...
HPS::UTF8	GetName () const
	Gets the name for this Configuration. More...
ConfigurationArray	GetSubconfigurations () const
	Gets the subconfigurations for this Configuration. More...
virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...
virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...
bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...
intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...
intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::ExchangeConfiguration

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.

~Configuration()

virtual HPS::Exchange::Configuration::~Configuration ( )

virtual

Member Function Documentation

ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

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.

GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns

A unique value shared by all objects of the same class.

GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns

A value unique to an instance of an object and all objects that are backed by the same database resource.

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.

HasType()

bool HPS::Object::HasType ( HPS::Type  in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask

The Type mask to check against this Object.

Returns

true if this Object has the given Type mask, false otherwise.

ObjectType()

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

inlinevirtual

Reimplemented from HPS::Object.

Here is the call graph for this function:

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.

Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

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.

Type()

virtual HPS::Type HPS::Object::Type ( ) const

virtualinherited

This function returns the true type of the underlying object.

This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Returns

The true type of the object in question.

Reimplemented in HPS::UpdateOptionsControl, HPS::HighlightControl, HPS::SelectionOptionsControl, HPS::OffScreenWindowOptionsControl, HPS::ApplicationWindowOptionsControl, HPS::StandAloneWindowOptionsControl, HPS::AttributeLockControl, HPS::WindowInfoControl, HPS::DebuggingControl, HPS::SubwindowControl, HPS::ContourLineControl, HPS::VisualEffectsControl, HPS::TransformMaskControl, HPS::PostProcessEffectsControl, HPS::DrawingAttributeControl, HPS::HiddenLineAttributeControl, HPS::PerformanceControl, HPS::NURBSSurfaceAttributeControl, HPS::ConditionControl, HPS::StyleControl, HPS::PortfolioControl, HPS::MaterialMappingControl, HPS::TextureMatrixControl, HPS::ModellingMatrixControl, HPS::CurveAttributeControl, HPS::EdgeAttributeControl, HPS::LineAttributeControl, HPS::TextAttributeControl, HPS::CuttingSectionAttributeControl, HPS::CylinderAttributeControl, HPS::LightingAttributeControl, HPS::SphereAttributeControl, HPS::MarkerAttributeControl, HPS::CullingControl, HPS::ColorInterpolationControl, HPS::TransparencyControl, HPS::SelectabilityControl, HPS::CameraControl, HPS::VisibilityControl, HPS::BoundingControl, HPS::Kit, and HPS::Control.

Member Data Documentation

staticType

const HPS::Type HPS::Exchange::Configuration::staticType = HPS::Type::ExchangeConfiguration

static

---

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

• sprk_exchange.h