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

override bool Empty ()

Indicates whether this ExportACISOptionsKit has any values set on it.

Return

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

bool Equals (HPS.Exchange.ExportACISOptionsKit in_kit)

Check if the source ExportACISOptionsKit is equivalent to this ExportACISOptionsKit.

Param in_kit

The source ExportACISOptionsKit to compare to this ExportACISOptionsKit.

Return

true if the objects are equivalent, false otherwise.

ExportACISOptionsKit ()

The default constructor creates an empty ExportACISOptionsKit object.

ExportACISOptionsKit (HPS.Exchange.ExportACISOptionsKit in_kit)

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

Param in_kit

The source ExportACISOptionsKit 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.ExportACISOptionsKit in_kit)

Copies the source ExportACISOptionsKit into this ExportACISOptionsKit.

Param in_kit

The source ExportACISOptionsKit to copy.

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

Param in_state

Whether to write ACIS data in binary form.

Return

A reference to this ExportACISOptionsKit.

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

Param in_state

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

Return

A reference to this ExportACISOptionsKit.

void Show (out HPS.Exchange.ExportACISOptionsKit out_kit)

Copies this ExportACISOptionsKit into the given ExportACISOptionsKit.

Param out_kit

The ExportACISOptionsKit to populate with the contents of this ExportACISOptionsKit.

bool ShowBinary (out bool out_state)

Shows the binary export setting.

Param out_state

Whether to write ACIS data in binary form.

Return

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

bool ShowMillimeterUnits (out bool out_state)

Shows the millimeter unit export setting.

Param out_state

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

Return

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

HPS.Exchange.ExportACISOptionsKit UnsetBinary ()

Removes the binary export setting.

Return

A reference to this ExportACISOptionsKit.

HPS.Exchange.ExportACISOptionsKit UnsetEverything ()

Removes all settings from this ExportACISOptionsKit.

Return

A reference to this ExportACISOptionsKit.

HPS.Exchange.ExportACISOptionsKit UnsetMillimeterUnits ()

Removes the millimeter unit export setting.

Return

A reference to this ExportACISOptionsKit.

Public Static Functions

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

Return

An ExportACISOptionsKit with the default settings.