HPS.Exchange.ExportJTOptionsKit

class HPS.Exchange.ExportJTOptionsKit : public HPS.SprocketKit

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

Public Functions

override bool Empty ()

Indicates whether this ExportJTOptionsKit has any values set on it.

Return

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

bool Equals (HPS.Exchange.ExportJTOptionsKit in_kit)

Check if the source ExportJTOptionsKit is equivalent to this ExportJTOptionsKit.

Param in_kit

The source ExportJTOptionsKit to compare to this ExportJTOptionsKit.

Return

true if the objects are equivalent, false otherwise.

ExportJTOptionsKit ()

The default constructor creates an empty ExportJTOptionsKit object.

ExportJTOptionsKit (HPS.Exchange.ExportJTOptionsKit in_kit)

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

Param in_kit

The source ExportJTOptionsKit to copy.

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

Copies the source ExportJTOptionsKit into this ExportJTOptionsKit.

Param in_kit

The source ExportJTOptionsKit to copy.

HPS.Exchange.ExportJTOptionsKit SetContent (HPS.Exchange.JT.Content in_content)

Sets the type of data to export. This corresponds to the value that will be passed to A3DRWParamsExportJTData::m_eWriteGeomTessMode.

See

Default value

Param in_content

The type of data to export.

Return

A reference to this ExportJTOptionsKit.

HPS.Exchange.ExportJTOptionsKit SetHiddenObjects (bool in_state)

Sets whether to export hidden objects. This corresponds to the value that will be passed to A3DRWParamsExportJTData::m_bWriteHiddenObjects.

See

Default value

Param in_state

Whether to export hidden objects.

Return

A reference to this ExportJTOptionsKit.

HPS.Exchange.ExportJTOptionsKit SetPMI (bool in_state)

Sets whether to export PMI. This corresponds to the value that will be passed to A3DRWParamsExportJTData::m_bWritePMI.

See

Default value

Param in_state

Whether to export PMI.

Return

A reference to this ExportJTOptionsKit.

HPS.Exchange.ExportJTOptionsKit SetVersion (HPS.Exchange.JT.Version in_version)

Sets the version of the JT format to export. This corresponds to the value that will be passed to A3DRWParamsExportJTData::m_eJTVersion.

See

Default value

Param in_version

The version of the JT format to export.

Return

A reference to this ExportJTOptionsKit.

void Show (out HPS.Exchange.ExportJTOptionsKit out_kit)

Copies this ExportJTOptionsKit into the given ExportJTOptionsKit.

Param out_kit

The ExportJTOptionsKit to populate with the contents of this ExportJTOptionsKit.

bool ShowContent (out HPS.Exchange.JT.Content out_content)

Shows the content export setting.

Param out_content

The type of data to export.

Return

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

bool ShowHiddenObjects (out bool out_state)

Shows the hidden object export setting.

Param out_state

Whether to export hidden objects.

Return

true if a hidden object export setting was specified, false otherwise.

bool ShowPMI (out bool out_state)

Shows the PMI export setting.

Param out_state

Whether to export PMI.

Return

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

bool ShowVersion (out HPS.Exchange.JT.Version out_version)

Shows the version export setting.

Param out_version

The version of the JT format to export.

Return

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

HPS.Exchange.ExportJTOptionsKit UnsetContent ()

Removes the content export setting.

Return

A reference to this ExportJTOptionsKit.

HPS.Exchange.ExportJTOptionsKit UnsetEverything ()

Removes all settings from this ExportJTOptionsKit.

Return

A reference to this ExportJTOptionsKit.

HPS.Exchange.ExportJTOptionsKit UnsetHiddenObjects ()

Removes the hidden objects export setting.

Return

A reference to this ExportJTOptionsKit.

HPS.Exchange.ExportJTOptionsKit UnsetPMI ()

Removes the PMI export setting.

Return

A reference to this ExportJTOptionsKit.

HPS.Exchange.ExportJTOptionsKit UnsetVersion ()

Removes the version export setting.

Return

A reference to this ExportJTOptionsKit.

Public Static Functions

HPS.Exchange.ExportJTOptionsKit GetDefault ()

Creates an ExportJTOptionsKit 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.ExportJT.

Return

An ExportJTOptionsKit with the default settings.