HPS::Exchange::ExportACISOptionsKit

class HPS::Exchange::ExportACISOptionsKit : public HPS::SprocketKit

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

Public Functions

virtual bool Empty() const

Indicates whether this ExportACISOptionsKit has any values set on it.

Returns

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

bool Equals(ExportACISOptionsKit const &in_kit) const

Check if the source ExportACISOptionsKit is equivalent to this ExportACISOptionsKit.

Parameters

in_kit – The source ExportACISOptionsKit to compare to this ExportACISOptionsKit.

Returns

true if the objects are equivalent, false otherwise.

ExportACISOptionsKit()

The default constructor creates an empty ExportACISOptionsKit object.

ExportACISOptionsKit(ExportACISOptionsKit &&in_that)

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

Parameters

in_that – An rvalue reference to an ExportACISOptionsKit to take the underlying object from.

ExportACISOptionsKit(ExportACISOptionsKit const &in_kit)

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

Parameters

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

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

Parameters

in_kit – The source ExportACISOptionsKit to compare to this ExportACISOptionsKit.

Returns

true if the objects are not equivalent, false otherwise.

ExportACISOptionsKit &operator=(ExportACISOptionsKit &&in_that)

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

Parameters

in_that – An rvalue reference to an ExportACISOptionsKit to take the underlying object from.

Returns

A reference to this ExportACISOptionsKit.

ExportACISOptionsKit &operator=(ExportACISOptionsKit const &in_kit)

Copies the source ExportACISOptionsKit into this ExportACISOptionsKit.

Parameters

in_kit – The source ExportACISOptionsKit to copy.

Returns

A reference to this ExportACISOptionsKit.

bool operator==(ExportACISOptionsKit const &in_kit) const

Check if the source ExportACISOptionsKit is equivalent to this ExportACISOptionsKit.

Parameters

in_kit – The source ExportACISOptionsKit to compare to this ExportACISOptionsKit.

Returns

true if the objects are equivalent, false otherwise.

void Set(ExportACISOptionsKit const &in_kit)

Copies the source ExportACISOptionsKit into this ExportACISOptionsKit.

Parameters

in_kit – The source ExportACISOptionsKit to copy.

ExportACISOptionsKit &SetBinary(bool in_state)

Sets whether to write ACIS data in binary form. This corresponds to the value that will be passed to A3DRWParamsExportAcisData::m_bSaveAsBinary.

See

Default value

Parameters

in_state – Whether to write ACIS data in binary form.

Returns

A reference to this ExportACISOptionsKit.

ExportACISOptionsKit &SetMillimeterUnits(bool in_state)

Sets whether to write ACIS data in millimeter units instead of the native units of the CADModel. This corresponds to the value that will be passed to A3DRWParamsExportAcisData::m_bSaveAsMillimeter.

See

Default value

Parameters

in_state – Whether to write ACIS data in millimeter units instead of the native units of the CADModel.

Returns

A reference to this ExportACISOptionsKit.

void Show(ExportACISOptionsKit &out_kit) const

Copies this ExportACISOptionsKit into the given ExportACISOptionsKit.

Parameters

out_kit – The ExportACISOptionsKit to populate with the contents of this ExportACISOptionsKit.

bool ShowBinary(bool &out_state) const

Shows the binary export setting.

Parameters

out_state – Whether to write ACIS data in binary form.

Returns

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

bool ShowMillimeterUnits(bool &out_state) const

Shows the millimeter unit export setting.

Parameters

out_state – Whether to write ACIS data in millimeter units instead of the native units of the CADModel.

Returns

true if a millimeter unit export setting was specified, false otherwise.

ExportACISOptionsKit &UnsetBinary()

Removes the binary export setting.

Returns

A reference to this ExportACISOptionsKit.

ExportACISOptionsKit &UnsetEverything()

Removes all settings from this ExportACISOptionsKit.

Returns

A reference to this ExportACISOptionsKit.

ExportACISOptionsKit &UnsetMillimeterUnits()

Removes the millimeter unit export setting.

Returns

A reference to this ExportACISOptionsKit.

Public Static Functions

static ExportACISOptionsKit GetDefault()

Creates an ExportACISOptionsKit 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::ExportACIS.

Returns

An ExportACISOptionsKit with the default settings.