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

virtual bool Empty() const

Indicates whether this ExportJTOptionsKit has any values set on it.

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

bool Equals(ExportJTOptionsKit const &in_kit) const

Check if the source ExportJTOptionsKit is equivalent to this ExportJTOptionsKit.

Parameters: in_kit – The source ExportJTOptionsKit to compare to this ExportJTOptionsKit.
Returns: true if the objects are equivalent, false otherwise.

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

ExportJTOptionsKit(ExportJTOptionsKit &&in_that)

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

Parameters: in_that – An rvalue reference to an ExportJTOptionsKit to take the underlying object from.

ExportJTOptionsKit(ExportJTOptionsKit const &in_kit)

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

Parameters: in_kit – The source ExportJTOptionsKit 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!=(ExportJTOptionsKit const &in_kit) const

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

Parameters: in_kit – The source ExportJTOptionsKit to compare to this ExportJTOptionsKit.
Returns: true if the objects are not equivalent, false otherwise.

ExportJTOptionsKit &operator=(ExportJTOptionsKit &&in_that)

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

Parameters: in_that – An rvalue reference to an ExportJTOptionsKit to take the underlying object from.
Returns: A reference to this ExportJTOptionsKit.

ExportJTOptionsKit &operator=(ExportJTOptionsKit const &in_kit)

Copies the source ExportJTOptionsKit into this ExportJTOptionsKit.

Parameters: in_kit – The source ExportJTOptionsKit to copy.
Returns: A reference to this ExportJTOptionsKit.

bool operator==(ExportJTOptionsKit const &in_kit) const

Check if the source ExportJTOptionsKit is equivalent to this ExportJTOptionsKit.

Parameters: in_kit – The source ExportJTOptionsKit to compare to this ExportJTOptionsKit.
Returns: true if the objects are equivalent, false otherwise.

void Set(ExportJTOptionsKit const &in_kit)

Copies the source ExportJTOptionsKit into this ExportJTOptionsKit.

Parameters: in_kit – The source ExportJTOptionsKit to copy.

ExportJTOptionsKit &SetContent(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

Parameters: in_content – The type of data to export.
Returns: A reference to this ExportJTOptionsKit.

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

Parameters: in_state – Whether to export hidden objects.
Returns: A reference to this ExportJTOptionsKit.

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

Parameters: in_state – Whether to export PMI.
Returns: A reference to this ExportJTOptionsKit.

ExportJTOptionsKit &SetVersion(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

Parameters: in_version – The version of the JT format to export.
Returns: A reference to this ExportJTOptionsKit.

void Show(ExportJTOptionsKit &out_kit) const

Copies this ExportJTOptionsKit into the given ExportJTOptionsKit.

Parameters: out_kit – The ExportJTOptionsKit to populate with the contents of this ExportJTOptionsKit.

bool ShowContent(JT::Content &out_content) const

Shows the content export setting.

Parameters: out_content – The type of data to export.
Returns: true if a content export setting was specified, false otherwise.

bool ShowHiddenObjects(bool &out_state) const

Shows the hidden object export setting.

Parameters: out_state – Whether to export hidden objects.
Returns: true if a hidden object export setting was specified, false otherwise.

bool ShowPMI(bool &out_state) const

Shows the PMI export setting.

Parameters: out_state – Whether to export PMI.
Returns: true if a PMI export setting was specified, false otherwise.

bool ShowVersion(JT::Version &out_version) const

Shows the version export setting.

Parameters: out_version – The version of the JT format to export.
Returns: true if a version export setting was specified, false otherwise.

ExportJTOptionsKit &UnsetContent()

Removes the content export setting.

Returns: A reference to this ExportJTOptionsKit.

ExportJTOptionsKit &UnsetEverything()

Removes all settings from this ExportJTOptionsKit.

Returns: A reference to this ExportJTOptionsKit.

ExportJTOptionsKit &UnsetHiddenObjects()

Removes the hidden objects export setting.

Returns: A reference to this ExportJTOptionsKit.

ExportJTOptionsKit &UnsetPMI()

Removes the PMI export setting.

Returns: A reference to this ExportJTOptionsKit.

ExportJTOptionsKit &UnsetVersion()

Removes the version export setting.

Returns: A reference to this ExportJTOptionsKit.

virtual ~ExportJTOptionsKit()

Public Static Functions

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

Returns: An ExportJTOptionsKit with the default settings.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::ExchangeExportJTOptionsKit