HPS::Exchange::ExportXMLOptionsKit Class Reference

#include <sprk_exchange.h>

Inheritance diagram for HPS::Exchange::ExportXMLOptionsKit:

Public Member Functions
bool	Empty () const
bool	Equals (ExportXMLOptionsKit const &in_kit) const
	ExportXMLOptionsKit ()
	ExportXMLOptionsKit (ExportXMLOptionsKit const &in_kit)
	ExportXMLOptionsKit (ExportXMLOptionsKit &&in_that)
HPS::Type	ObjectType () const
bool	operator!= (ExportXMLOptionsKit const &in_kit) const
ExportXMLOptionsKit &	operator= (ExportXMLOptionsKit const &in_kit)
ExportXMLOptionsKit &	operator= (ExportXMLOptionsKit &&in_that)
bool	operator== (ExportXMLOptionsKit const &in_kit) const
void	Set (ExportXMLOptionsKit const &in_kit)
ExportXMLOptionsKit &	SetMaterials (bool in_state)
ExportXMLOptionsKit &	SetMetadata (bool in_state)
ExportXMLOptionsKit &	SetTransformations (bool in_state)
void	Show (ExportXMLOptionsKit &out_kit) const
bool	ShowMaterials (bool &out_state) const
bool	ShowMetadata (bool &out_state) const
bool	ShowTransformations (bool &out_state) const
ExportXMLOptionsKit &	UnsetEverything ()
ExportXMLOptionsKit &	UnsetMaterials ()
ExportXMLOptionsKit &	UnsetMetadata ()
ExportXMLOptionsKit &	UnsetTransformations ()
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 Member Functions
static ExportXMLOptionsKit	GetDefault ()
Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t	ClassID ()

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

Additional Inherited Members
Protected Member Functions inherited from HPS::SprocketKit
SprocketKit &	operator= (SprocketKit &&in_that)
	SprocketKit (SprocketKit &&in_that)

Detailed Description

The HPS::Exchange::ExportXMLOptionsKit class is a user space object. It contains settings controlling how XML data is exported via Exchange. Calling HPS::Exchange::ExportXMLOptionsKit::GetDefault() will return an options kit with values found in here.

Constructor & Destructor Documentation

ExportXMLOptionsKit() [1/3]

HPS::Exchange::ExportXMLOptionsKit::ExportXMLOptionsKit

(

)

The default constructor creates an empty ExportXMLOptionsKit object.

ExportXMLOptionsKit() [2/3]

HPS::Exchange::ExportXMLOptionsKit::ExportXMLOptionsKit

(

ExportXMLOptionsKit const &

in_kit

)

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

Parameters

in_kit

The source ExportXMLOptionsKit to copy.

ExportXMLOptionsKit() [3/3]

HPS::Exchange::ExportXMLOptionsKit::ExportXMLOptionsKit

(

ExportXMLOptionsKit &&

in_that

)

The move constructor creates an ExportXMLOptionsKit by transferring the underlying object of the rvalue reference to this ExportXMLOptionsKit.

Parameters

in_that

An rvalue reference to an ExportXMLOptionsKit to take the underlying object from.

Member Function Documentation

Empty()

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

virtual

Indicates whether this ExportXMLOptionsKit has any values set on it.

Returns

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

Reimplemented from HPS::Object.

Equals()

bool HPS::Exchange::ExportXMLOptionsKit::Equals

(

ExportXMLOptionsKit const &

in_kit

)

const

Check if the source ExportXMLOptionsKit is equivalent to this ExportXMLOptionsKit.

Parameters

in_kit

The source ExportXMLOptionsKit to compare to this ExportXMLOptionsKit.

Returns

true if the objects are equivalent, false otherwise.

GetDefault()

static ExportXMLOptionsKit HPS::Exchange::ExportXMLOptionsKit::GetDefault ( )

static

Creates an ExportXMLOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default. These values will be used for import unless an option is overridden by the options passed to File::ExportXML.

Returns

An ExportXMLOptionsKit with the default settings.

ObjectType()

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

operator!=()

bool HPS::Exchange::ExportXMLOptionsKit::operator!=

(

ExportXMLOptionsKit const &

in_kit

)

const

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

Parameters

in_kit

The source ExportXMLOptionsKit to compare to this ExportXMLOptionsKit.

Returns

true if the objects are not equivalent, false otherwise.

operator=() [1/2]

ExportXMLOptionsKit& HPS::Exchange::ExportXMLOptionsKit::operator=

(

ExportXMLOptionsKit const &

in_kit

)

Copies the source ExportXMLOptionsKit into this ExportXMLOptionsKit.

Parameters

in_kit

The source ExportXMLOptionsKit to copy.

Returns

A reference to this ExportXMLOptionsKit.

operator=() [2/2]

ExportXMLOptionsKit& HPS::Exchange::ExportXMLOptionsKit::operator=

(

ExportXMLOptionsKit &&

in_that

)

The move assignment operator transfers the underlying object of the rvalue reference to this ExportXMLOptionsKit.

Parameters

in_that

An rvalue reference to an ExportXMLOptionsKit to take the underlying object from.

Returns

A reference to this ExportXMLOptionsKit.

operator==()

bool HPS::Exchange::ExportXMLOptionsKit::operator==

(

ExportXMLOptionsKit const &

in_kit

)

const

Check if the source ExportXMLOptionsKit is equivalent to this ExportXMLOptionsKit.

Parameters

in_kit

The source ExportXMLOptionsKit to compare to this ExportXMLOptionsKit.

Returns

true if the objects are equivalent, false otherwise.

Set()

void HPS::Exchange::ExportXMLOptionsKit::Set

(

ExportXMLOptionsKit const &

in_kit

)

Copies the source ExportXMLOptionsKit into this ExportXMLOptionsKit.

Parameters

in_kit

The source ExportXMLOptionsKit to copy.

SetMaterials()

ExportXMLOptionsKit& HPS::Exchange::ExportXMLOptionsKit::SetMaterials

(

bool

in_state

)

Sets whether to export materials. This corresponds to the value that will be passed to A3DRWParamsExportXMLData::m_bExportColorMaterial.

Parameters

in_state

Whether to export materials.

Returns

A reference to this ExportXMLOptionsKit.

See also

Default value

SetMetadata()

ExportXMLOptionsKit& HPS::Exchange::ExportXMLOptionsKit::SetMetadata

(

bool

in_state

)

Sets whether to export metadata. This corresponds to the value that will be passed to A3DRWParamsExportXMLData::m_bExportMetadata.

Parameters

in_state

Whether to export metadata.

Returns

A reference to this ExportXMLOptionsKit.

See also

Default value

SetTransformations()

ExportXMLOptionsKit& HPS::Exchange::ExportXMLOptionsKit::SetTransformations

(

bool

in_state

)

Sets whether to export transformations. This corresponds to the value that will be passed to A3DRWParamsExportXMLData::m_bExportTransformations.

Parameters

in_state

Whether to export transformations.

Returns

A reference to this ExportXMLOptionsKit.

See also

Default value

Show()

void HPS::Exchange::ExportXMLOptionsKit::Show

(

ExportXMLOptionsKit &

out_kit

)

const

Copies this ExportXMLOptionsKit into the given ExportXMLOptionsKit.

Parameters

out_kit

The ExportXMLOptionsKit to populate with the contents of this ExportXMLOptionsKit.

ShowMaterials()

bool HPS::Exchange::ExportXMLOptionsKit::ShowMaterials

(

bool &

out_state

)

const

Shows the material export setting.

Parameters

out_state

Whether to export materials.

Returns

true if a material export setting was specified, false otherwise.

ShowMetadata()

bool HPS::Exchange::ExportXMLOptionsKit::ShowMetadata

(

bool &

out_state

)

const

Shows the metadata export setting.

Parameters

out_state

Whether to export metadata.

Returns

true if a metadata export setting was specified, false otherwise.

ShowTransformations()

bool HPS::Exchange::ExportXMLOptionsKit::ShowTransformations

(

bool &

out_state

)

const

Shows the transformation export setting.

Parameters

out_state

Whether to export transformations.

Returns

true if a transformation export setting was specified, false otherwise.

UnsetEverything()

ExportXMLOptionsKit& HPS::Exchange::ExportXMLOptionsKit::UnsetEverything

(

)

Removes all settings from this ExportXMLOptionsKit.

Returns

A reference to this ExportXMLOptionsKit.

UnsetMaterials()

ExportXMLOptionsKit& HPS::Exchange::ExportXMLOptionsKit::UnsetMaterials

(

)

Removes the material export setting.

Returns

A reference to this ExportXMLOptionsKit.

UnsetMetadata()

ExportXMLOptionsKit& HPS::Exchange::ExportXMLOptionsKit::UnsetMetadata

(

)

Removes the metadata export setting.

Returns

A reference to this ExportXMLOptionsKit.

UnsetTransformations()

ExportXMLOptionsKit& HPS::Exchange::ExportXMLOptionsKit::UnsetTransformations

(

)

Removes the transformation export setting.

Returns

A reference to this ExportXMLOptionsKit.

---

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

• include/sprk_exchange.h