HPS::Exchange::ExportXMLOptionsKit

class HPS::Exchange::ExportXMLOptionsKit : public HPS::SprocketKit

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.

Public Functions

virtual bool Empty() const

Indicates whether this ExportXMLOptionsKit has any values set on it.

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

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

ExportXMLOptionsKit(): The default constructor creates an empty ExportXMLOptionsKit object.

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.

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.

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!=(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.

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.

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.

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

void Set(ExportXMLOptionsKit const &in_kit)

Copies the source ExportXMLOptionsKit into this ExportXMLOptionsKit.

Parameters: in_kit – The source ExportXMLOptionsKit to copy.

ExportXMLOptionsKit &SetMaterials(bool in_state)

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

See: Default value

Parameters: in_state – Whether to export materials.
Returns: A reference to this ExportXMLOptionsKit.

ExportXMLOptionsKit &SetMetadata(bool in_state)

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

See: Default value

Parameters: in_state – Whether to export metadata.
Returns: A reference to this ExportXMLOptionsKit.

ExportXMLOptionsKit &SetTransformations(bool in_state)

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

See: Default value

Parameters: in_state – Whether to export transformations.
Returns: A reference to this ExportXMLOptionsKit.

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

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

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

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

ExportXMLOptionsKit &UnsetEverything()

Removes all settings from this ExportXMLOptionsKit.

Returns: A reference to this ExportXMLOptionsKit.

ExportXMLOptionsKit &UnsetMaterials()

Removes the material export setting.

Returns: A reference to this ExportXMLOptionsKit.

ExportXMLOptionsKit &UnsetMetadata()

Removes the metadata export setting.

Returns: A reference to this ExportXMLOptionsKit.

ExportXMLOptionsKit &UnsetTransformations()

Removes the transformation export setting.

Returns: A reference to this ExportXMLOptionsKit.

Public Static Functions

static ExportXMLOptionsKit GetDefault()

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.