Inheritance diagram for HPS.Exchange.ExportACISOptionsKit:
HPS.SprocketKit HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Exchange.ExportACISOptionsKit in_kit)
 
 ExportACISOptionsKit ()
 
 ExportACISOptionsKit (HPS.Exchange.ExportACISOptionsKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.Exchange.ExportACISOptionsKit in_kit)
 
HPS.Exchange.ExportACISOptionsKit SetBinary (bool in_state)
 
HPS.Exchange.ExportACISOptionsKit SetMillimeterUnits (bool in_state)
 
void Show (out HPS.Exchange.ExportACISOptionsKit out_kit)
 
bool ShowBinary (out bool out_state)
 
bool ShowMillimeterUnits (out bool out_state)
 
HPS.Exchange.ExportACISOptionsKit UnsetBinary ()
 
HPS.Exchange.ExportACISOptionsKit UnsetEverything ()
 
HPS.Exchange.ExportACISOptionsKit UnsetMillimeterUnits ()
 
- 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.Exchange.ExportACISOptionsKit GetDefault ()
 
static bool operator!= (HPS.Exchange.ExportACISOptionsKit a, HPS.Exchange.ExportACISOptionsKit b)
 
static bool operator== (HPS.Exchange.ExportACISOptionsKit a, HPS.Exchange.ExportACISOptionsKit 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 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.

Constructor & Destructor Documentation

◆ ExportACISOptionsKit() [1/2]

HPS.Exchange.ExportACISOptionsKit.ExportACISOptionsKit ( )
inline

The default constructor creates an empty ExportACISOptionsKit object.

◆ ExportACISOptionsKit() [2/2]

HPS.Exchange.ExportACISOptionsKit.ExportACISOptionsKit ( HPS.Exchange.ExportACISOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source ExportACISOptionsKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.Exchange.ExportACISOptionsKit.Empty ( )
inlinevirtual

Indicates whether this ExportACISOptionsKit has any values set on it.

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

Reimplemented from HPS.Object.

◆ Equals()

bool HPS.Exchange.ExportACISOptionsKit.Equals ( HPS.Exchange.ExportACISOptionsKit  in_kit)
inline

Check if the source ExportACISOptionsKit is equivalent to this ExportACISOptionsKit.

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

◆ GetDefault()

static HPS.Exchange.ExportACISOptionsKit HPS.Exchange.ExportACISOptionsKit.GetDefault ( )
inlinestatic

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.

◆ ObjectType()

override HPS.Type HPS.Exchange.ExportACISOptionsKit.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.Exchange.ExportACISOptionsKit.Set ( HPS.Exchange.ExportACISOptionsKit  in_kit)
inline

Copies the source ExportACISOptionsKit into this ExportACISOptionsKit.

Parameters
in_kitThe source ExportACISOptionsKit to copy.

◆ SetBinary()

HPS.Exchange.ExportACISOptionsKit HPS.Exchange.ExportACISOptionsKit.SetBinary ( bool  in_state)
inline

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

Parameters
in_stateWhether to write ACIS data in binary form.
Returns
A reference to this ExportACISOptionsKit.
See also
Default value

◆ SetMillimeterUnits()

HPS.Exchange.ExportACISOptionsKit HPS.Exchange.ExportACISOptionsKit.SetMillimeterUnits ( bool  in_state)
inline

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.

Parameters
in_stateWhether to write ACIS data in millimeter units instead of the native units of the CADModel.
Returns
A reference to this ExportACISOptionsKit.
See also
Default value

◆ Show()

void HPS.Exchange.ExportACISOptionsKit.Show ( out HPS.Exchange.ExportACISOptionsKit  out_kit)
inline

Copies this ExportACISOptionsKit into the given ExportACISOptionsKit.

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

◆ ShowBinary()

bool HPS.Exchange.ExportACISOptionsKit.ShowBinary ( out bool  out_state)
inline

Shows the binary export setting.

Parameters
out_stateWhether to write ACIS data in binary form.
Returns
true if a binary export setting was specified, false otherwise.

◆ ShowMillimeterUnits()

bool HPS.Exchange.ExportACISOptionsKit.ShowMillimeterUnits ( out bool  out_state)
inline

Shows the millimeter unit export setting.

Parameters
out_stateWhether 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.

◆ UnsetBinary()

HPS.Exchange.ExportACISOptionsKit HPS.Exchange.ExportACISOptionsKit.UnsetBinary ( )
inline

Removes the binary export setting.

Returns
A reference to this ExportACISOptionsKit.

◆ UnsetEverything()

HPS.Exchange.ExportACISOptionsKit HPS.Exchange.ExportACISOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ExportACISOptionsKit.

Returns
A reference to this ExportACISOptionsKit.

◆ UnsetMillimeterUnits()

HPS.Exchange.ExportACISOptionsKit HPS.Exchange.ExportACISOptionsKit.UnsetMillimeterUnits ( )
inline

Removes the millimeter unit export setting.

Returns
A reference to this ExportACISOptionsKit.

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