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

override void Dispose ()

override bool Empty ()

Indicates whether this ExportXMLOptionsKit has any values set on it.

Return

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

bool Equals (HPS.Exchange.ExportXMLOptionsKit in_kit)

Check if the source ExportXMLOptionsKit is equivalent to this ExportXMLOptionsKit.

Param in_kit

The source ExportXMLOptionsKit to compare to this ExportXMLOptionsKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

ExportXMLOptionsKit ()

The default constructor creates an empty ExportXMLOptionsKit object.

ExportXMLOptionsKit (HPS.Exchange.ExportXMLOptionsKit in_kit)

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

Param in_kit

The source ExportXMLOptionsKit to copy.

override int GetHashCode ()

override HPS.Type ObjectType ()

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

Return

The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.Exchange.ExportXMLOptionsKit in_kit)

Copies the source ExportXMLOptionsKit into this ExportXMLOptionsKit.

Param in_kit

The source ExportXMLOptionsKit to copy.

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.

See

Default value

Param in_state

Whether to export materials.

Return

A reference to this 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.

See

Default value

Param in_state

Whether to export metadata.

Return

A reference to this 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.

See

Default value

Param in_state

Whether to export transformations.

Return

A reference to this ExportXMLOptionsKit.

void Show (out HPS.Exchange.ExportXMLOptionsKit out_kit)

Copies this ExportXMLOptionsKit into the given ExportXMLOptionsKit.

Param out_kit

The ExportXMLOptionsKit to populate with the contents of this ExportXMLOptionsKit.

bool ShowMaterials (out bool out_state)

Shows the material export setting.

Param out_state

Whether to export materials.

Return

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

bool ShowMetadata (out bool out_state)

Shows the metadata export setting.

Param out_state

Whether to export metadata.

Return

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

bool ShowTransformations (out bool out_state)

Shows the transformation export setting.

Param out_state

Whether to export transformations.

Return

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

HPS.Exchange.ExportXMLOptionsKit UnsetEverything ()

Removes all settings from this ExportXMLOptionsKit.

Return

A reference to this ExportXMLOptionsKit.

HPS.Exchange.ExportXMLOptionsKit UnsetMaterials ()

Removes the material export setting.

Return

A reference to this ExportXMLOptionsKit.

HPS.Exchange.ExportXMLOptionsKit UnsetMetadata ()

Removes the metadata export setting.

Return

A reference to this ExportXMLOptionsKit.

HPS.Exchange.ExportXMLOptionsKit UnsetTransformations ()

Removes the transformation export setting.

Return

A reference to this ExportXMLOptionsKit.

Public Static Functions

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

Return

An ExportXMLOptionsKit with the default settings.

bool operator!= (HPS.Exchange.ExportXMLOptionsKit a, HPS.Exchange.ExportXMLOptionsKit b)

bool operator== (HPS.Exchange.ExportXMLOptionsKit a, HPS.Exchange.ExportXMLOptionsKit b)