Hoops Visualize HPS  version 2018-SP2
Hoops Visualize HPS 3D Rendering Engine
Looking for a senior C++ dev?
I'm looking for work. Hire me!
HPS::Exchange::ExportXMLOptionsKit Class Reference

The HPS::Exchange::ExportXMLOptionsKit class is a user space object. More...

#include <sprk_exchange.h>

Inheritance diagram for HPS::Exchange::ExportXMLOptionsKit:
Collaboration diagram for HPS::Exchange::ExportXMLOptionsKit:

Public Member Functions

 ExportXMLOptionsKit ()
 The default constructor creates an empty ExportXMLOptionsKit object. More...
 
 ExportXMLOptionsKit (ExportXMLOptionsKit const &in_kit)
 The copy constructor creates a new ExportXMLOptionsKit object that contains the same settings as the source ExportXMLOptionsKit. More...
 
 ExportXMLOptionsKit (ExportXMLOptionsKit &&in_that)
 The move constructor creates an ExportXMLOptionsKit by transferring the underlying object of the rvalue reference to this ExportXMLOptionsKit. More...
 
virtual ~ExportXMLOptionsKit ()
 
HPS::Type ObjectType () const
 
void Set (ExportXMLOptionsKit const &in_kit)
 Copies the source ExportXMLOptionsKit into this ExportXMLOptionsKit. More...
 
void Show (ExportXMLOptionsKit &out_kit) const
 Copies this ExportXMLOptionsKit into the given ExportXMLOptionsKit. More...
 
ExportXMLOptionsKitoperator= (ExportXMLOptionsKit const &in_kit)
 Copies the source ExportXMLOptionsKit into this ExportXMLOptionsKit. More...
 
ExportXMLOptionsKitoperator= (ExportXMLOptionsKit &&in_that)
 The move assignment operator transfers the underlying object of the rvalue reference to this ExportXMLOptionsKit. More...
 
bool Empty () const
 Indicates whether this ExportXMLOptionsKit has any values set on it. More...
 
bool Equals (ExportXMLOptionsKit const &in_kit) const
 Check if the source ExportXMLOptionsKit is equivalent to this ExportXMLOptionsKit. More...
 
bool operator== (ExportXMLOptionsKit const &in_kit) const
 Check if the source ExportXMLOptionsKit is equivalent to this ExportXMLOptionsKit. More...
 
bool operator!= (ExportXMLOptionsKit const &in_kit) const
 Check if the source ExportXMLOptionsKit is not equivalent to this ExportXMLOptionsKit. More...
 
ExportXMLOptionsKitSetMetadata (bool in_state)
 Sets whether to export metadata. More...
 
ExportXMLOptionsKitSetTransformations (bool in_state)
 Sets whether to export transformations. More...
 
ExportXMLOptionsKitSetMaterials (bool in_state)
 Sets whether to export materials. More...
 
ExportXMLOptionsKitUnsetMetadata ()
 Removes the metadata export setting. More...
 
ExportXMLOptionsKitUnsetTransformations ()
 Removes the transformation export setting. More...
 
ExportXMLOptionsKitUnsetMaterials ()
 Removes the material export setting. More...
 
ExportXMLOptionsKitUnsetEverything ()
 Removes all settings from this ExportXMLOptionsKit. More...
 
bool ShowMetadata (bool &out_state) const
 Shows the metadata export setting. More...
 
bool ShowTransformations (bool &out_state) const
 Shows the transformation export setting. More...
 
bool ShowMaterials (bool &out_state) const
 Shows the material export setting. 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

static ExportXMLOptionsKit GetDefault ()
 Creates an ExportXMLOptionsKit which contains the default settings. More...
 
template<typename T >
static intptr_t ClassID ()
 Unique identifier for this class. More...
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::ExchangeExportXMLOptionsKit
 

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_kitThe 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_thatAn rvalue reference to an ExportXMLOptionsKit to take the underlying object from.

◆ ~ExportXMLOptionsKit()

virtual HPS::Exchange::ExportXMLOptionsKit::~ExportXMLOptionsKit ( )
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::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_kitThe source ExportXMLOptionsKit to compare to this ExportXMLOptionsKit.
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.

◆ 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.

◆ 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.

◆ HasType()

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

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

Parameters
in_maskThe Type mask to check against this Object.
Returns
true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::Exchange::ExportXMLOptionsKit::ObjectType ( ) const
inlinevirtual

Reimplemented from HPS::SprocketKit.

Here is the call graph for this function:

◆ operator!=()

bool HPS::Exchange::ExportXMLOptionsKit::operator!= ( ExportXMLOptionsKit const &  in_kit) const

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

Parameters
in_kitThe 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_kitThe 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_thatAn 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_kitThe source ExportXMLOptionsKit to compare to this ExportXMLOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Reset()

◆ Set()

void HPS::Exchange::ExportXMLOptionsKit::Set ( ExportXMLOptionsKit const &  in_kit)

Copies the source ExportXMLOptionsKit into this ExportXMLOptionsKit.

Parameters
in_kitThe 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_stateWhether 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_stateWhether 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_stateWhether 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_kitThe 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_stateWhether 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_stateWhether 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_stateWhether to export transformations.
Returns
true if a transformation export setting was specified, false otherwise.

◆ Type()

◆ 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.

Member Data Documentation

◆ staticType

const HPS::Type HPS::Exchange::ExportXMLOptionsKit::staticType = HPS::Type::ExchangeExportXMLOptionsKit
static

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