Inheritance diagram for HPS.Parasolid.ExportOptionsKit:
HPS.SprocketKit HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Parasolid.ExportOptionsKit in_kit)
 
 ExportOptionsKit ()
 
 ExportOptionsKit (HPS.Parasolid.ExportOptionsKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.Parasolid.ExportOptionsKit in_kit)
 
HPS.Parasolid.ExportOptionsKit SetFormat (HPS.Parasolid.Format in_format)
 
HPS.Parasolid.ExportOptionsKit SetUserFields (bool in_export_user_fields)
 
void Show (out HPS.Parasolid.ExportOptionsKit out_kit)
 
bool ShowFormat (out HPS.Parasolid.Format out_format)
 
bool ShowUserFields (out bool out_user_fields)
 
HPS.Parasolid.ExportOptionsKit UnsetEverything ()
 
HPS.Parasolid.ExportOptionsKit UnsetFormat ()
 
HPS.Parasolid.ExportOptionsKit UnsetUserFields ()
 
- Public Member Functions inherited from HPS.SprocketKit
SprocketKit (HPS.SprocketKit in_that)
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static HPS.Parasolid.ExportOptionsKit GetDefault ()
 
static bool operator!= (HPS.Parasolid.ExportOptionsKit a, HPS.Parasolid.ExportOptionsKit b)
 
static bool operator== (HPS.Parasolid.ExportOptionsKit a, HPS.Parasolid.ExportOptionsKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ ExportOptionsKit() [1/2]

HPS.Parasolid.ExportOptionsKit.ExportOptionsKit ( )
inline

The default constructor creates an empty ExportOptionsKit object.

◆ ExportOptionsKit() [2/2]

HPS.Parasolid.ExportOptionsKit.ExportOptionsKit ( HPS.Parasolid.ExportOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source ExportOptionsKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.Parasolid.ExportOptionsKit.Empty ( )
inlinevirtual

Indicates whether this ExportOptionsKit has any values set on it.

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

Reimplemented from HPS.Object.

◆ Equals()

bool HPS.Parasolid.ExportOptionsKit.Equals ( HPS.Parasolid.ExportOptionsKit  in_kit)
inline

Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.

Parameters
in_kitThe source ExportOptionsKit to compare to this ExportOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.Parasolid.ExportOptionsKit HPS.Parasolid.ExportOptionsKit.GetDefault ( )
inlinestatic

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.

Returns
An ExportOptionsKit with the default settings.

◆ ObjectType()

override HPS.Type HPS.Parasolid.ExportOptionsKit.ObjectType ( )
inlinevirtual

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.

Reimplemented from HPS.SprocketKit.

◆ Set()

void HPS.Parasolid.ExportOptionsKit.Set ( HPS.Parasolid.ExportOptionsKit  in_kit)
inline

Copies the source ExportOptionsKit into this ExportOptionsKit.

Parameters
in_kitThe source ExportOptionsKit to copy.

◆ SetFormat()

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

Sets the format type to be exported.

This corresponds to the value that will be passed to PK_PART_transmit_o_t.transmit_format.

Parameters
in_formatThe format of the file to be exported.
Returns
A reference to this ExportOptionsKit.
See also
Default value

◆ SetUserFields()

HPS.Parasolid.ExportOptionsKit HPS.Parasolid.ExportOptionsKit.SetUserFields ( bool  in_export_user_fields)
inline

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.

Parameters
in_export_user_fieldsWhether to export user fields from the CAD file.
Returns
A reference to this ExportOptionsKit.

◆ Show()

void HPS.Parasolid.ExportOptionsKit.Show ( out HPS.Parasolid.ExportOptionsKit  out_kit)
inline

Copies this ExportOptionsKit into the given ExportOptionsKit.

Parameters
out_kitThe ExportOptionsKit to populate with the contents of this ExportOptionsKit.

◆ ShowFormat()

bool HPS.Parasolid.ExportOptionsKit.ShowFormat ( out HPS.Parasolid.Format  out_format)
inline

Shows the format export setting.

Parameters
out_formatThe format setting for this export.
Returns
true if a format setting was specified, false otherwise.

◆ ShowUserFields()

bool HPS.Parasolid.ExportOptionsKit.ShowUserFields ( out bool  out_user_fields)
inline

Shows the user fields export setting.

Parameters
out_user_fieldsThe user fields setting for this export.
Returns
true if a user fields setting was specified, false otherwise.

◆ UnsetEverything()

HPS.Parasolid.ExportOptionsKit HPS.Parasolid.ExportOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ExportOptionsKit.

Returns
A reference to this ExportOptionsKit.

◆ UnsetFormat()

HPS.Parasolid.ExportOptionsKit HPS.Parasolid.ExportOptionsKit.UnsetFormat ( )
inline

Removes the format export state.

Returns
A reference to this ExportOptionsKit.

◆ UnsetUserFields()

HPS.Parasolid.ExportOptionsKit HPS.Parasolid.ExportOptionsKit.UnsetUserFields ( )
inline

Removes the user fields export state.

Returns
A reference to this ExportOptionsKit.

The documentation for this class was generated from the following file:
  • internals/hps_sprk_parasolid/source/cs/HPS.Parasolid.cs