HPS::Parasolid::ExportOptionsKit

class HPS.Parasolid.ExportOptionsKit : public HPS.SprocketKit

The ExportOptionsKit class is a user space object. It contains settings controlling what and how data is exported via Parasolid. Default values for the various fields of this class can be found here.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ExportOptionsKit has any values set on it.

Return

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

bool Equals (HPS.Parasolid.ExportOptionsKit in_kit)

Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.

Param in_kit

The source ExportOptionsKit to compare to this ExportOptionsKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

ExportOptionsKit ()

The default constructor creates an empty ExportOptionsKit object.

ExportOptionsKit (HPS.Parasolid.ExportOptionsKit in_kit)

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

Param in_kit

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

Copies the source ExportOptionsKit into this ExportOptionsKit.

Param in_kit

The source ExportOptionsKit to copy.

HPS.Parasolid.ExportOptionsKit SetFormat (HPS.Parasolid.Format in_format)

Sets the format type to be exported. This corresponds to the value that will be passed to PK_PART_transmit_o_t.transmit_format.

See

Default value

Param in_format

The format of the file to be exported.

Return

A reference to this ExportOptionsKit.

HPS.Parasolid.ExportOptionsKit SetUserFields (bool in_export_user_fields)

Sets whether to export user fields from the CAD file. This corresponds to the value that will be passed to PK_PART_transmit_o_t.receive_user_fields.

Param in_export_user_fields

Whether to export user fields from the CAD file.

Return

A reference to this ExportOptionsKit.

void Show (out HPS.Parasolid.ExportOptionsKit out_kit)

Copies this ExportOptionsKit into the given ExportOptionsKit.

Param out_kit

The ExportOptionsKit to populate with the contents of this ExportOptionsKit.

bool ShowFormat (out HPS.Parasolid.Format out_format)

Shows the format export setting.

Param out_format

The format setting for this export.

Return

true if a format setting was specified, false otherwise.

bool ShowUserFields (out bool out_user_fields)

Shows the user fields export setting.

Param out_user_fields

The user fields setting for this export.

Return

true if a user fields setting was specified, false otherwise.

HPS.Parasolid.ExportOptionsKit UnsetEverything ()

Removes all settings from this ExportOptionsKit.

Return

A reference to this ExportOptionsKit.

HPS.Parasolid.ExportOptionsKit UnsetFormat ()

Removes the format export state.

Return

A reference to this ExportOptionsKit.

HPS.Parasolid.ExportOptionsKit UnsetUserFields ()

Removes the user fields export state.

Return

A reference to this ExportOptionsKit.

Public Static Functions

HPS.Parasolid.ExportOptionsKit GetDefault ()

Creates an ExportOptionsKit 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.Export.

Return

An ExportOptionsKit with the default settings.

bool operator!= (HPS.Parasolid.ExportOptionsKit a, HPS.Parasolid.ExportOptionsKit b)

bool operator== (HPS.Parasolid.ExportOptionsKit a, HPS.Parasolid.ExportOptionsKit b)