Inheritance diagram for HPS.Exchange.ExportJTOptionsKit:
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.ExportJTOptionsKit in_kit)
 
 ExportJTOptionsKit ()
 
 ExportJTOptionsKit (HPS.Exchange.ExportJTOptionsKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.Exchange.ExportJTOptionsKit in_kit)
 
HPS.Exchange.ExportJTOptionsKit SetContent (HPS.Exchange.JT.Content in_content)
 
HPS.Exchange.ExportJTOptionsKit SetHiddenObjects (bool in_state)
 
HPS.Exchange.ExportJTOptionsKit SetPMI (bool in_state)
 
HPS.Exchange.ExportJTOptionsKit SetVersion (HPS.Exchange.JT.Version in_version)
 
void Show (out HPS.Exchange.ExportJTOptionsKit out_kit)
 
bool ShowContent (out HPS.Exchange.JT.Content out_content)
 
bool ShowHiddenObjects (out bool out_state)
 
bool ShowPMI (out bool out_state)
 
bool ShowVersion (out HPS.Exchange.JT.Version out_version)
 
HPS.Exchange.ExportJTOptionsKit UnsetContent ()
 
HPS.Exchange.ExportJTOptionsKit UnsetEverything ()
 
HPS.Exchange.ExportJTOptionsKit UnsetHiddenObjects ()
 
HPS.Exchange.ExportJTOptionsKit UnsetPMI ()
 
HPS.Exchange.ExportJTOptionsKit UnsetVersion ()
 
- 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.ExportJTOptionsKit GetDefault ()
 
static bool operator!= (HPS.Exchange.ExportJTOptionsKit a, HPS.Exchange.ExportJTOptionsKit b)
 
static bool operator== (HPS.Exchange.ExportJTOptionsKit a, HPS.Exchange.ExportJTOptionsKit 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.ExportJTOptionsKit class is a user space object. It contains settings controlling how JT data is exported via Exchange. Calling HPS.Exchange.ExportJTOptionsKit.GetDefault() will return an options kit with values found in here.

Constructor & Destructor Documentation

◆ ExportJTOptionsKit() [1/2]

HPS.Exchange.ExportJTOptionsKit.ExportJTOptionsKit ( )
inline

The default constructor creates an empty ExportJTOptionsKit object.

◆ ExportJTOptionsKit() [2/2]

HPS.Exchange.ExportJTOptionsKit.ExportJTOptionsKit ( HPS.Exchange.ExportJTOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source ExportJTOptionsKit to copy.

Member Function Documentation

◆ Empty()

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

Indicates whether this ExportJTOptionsKit has any values set on it.

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

Reimplemented from HPS.Object.

◆ Equals()

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

Check if the source ExportJTOptionsKit is equivalent to this ExportJTOptionsKit.

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

◆ GetDefault()

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

Creates an ExportJTOptionsKit 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.ExportJT.

Returns
An ExportJTOptionsKit with the default settings.

◆ ObjectType()

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

Copies the source ExportJTOptionsKit into this ExportJTOptionsKit.

Parameters
in_kitThe source ExportJTOptionsKit to copy.

◆ SetContent()

HPS.Exchange.ExportJTOptionsKit HPS.Exchange.ExportJTOptionsKit.SetContent ( HPS.Exchange.JT.Content  in_content)
inline

Sets the type of data to export. This corresponds to the value that will be passed to A3DRWParamsExportJTData::m_eWriteGeomTessMode.

Parameters
in_contentThe type of data to export.
Returns
A reference to this ExportJTOptionsKit.
See also
Default value

◆ SetHiddenObjects()

HPS.Exchange.ExportJTOptionsKit HPS.Exchange.ExportJTOptionsKit.SetHiddenObjects ( bool  in_state)
inline

Sets whether to export hidden objects. This corresponds to the value that will be passed to A3DRWParamsExportJTData::m_bWriteHiddenObjects.

Parameters
in_stateWhether to export hidden objects.
Returns
A reference to this ExportJTOptionsKit.
See also
Default value

◆ SetPMI()

HPS.Exchange.ExportJTOptionsKit HPS.Exchange.ExportJTOptionsKit.SetPMI ( bool  in_state)
inline

Sets whether to export PMI. This corresponds to the value that will be passed to A3DRWParamsExportJTData::m_bWritePMI.

Parameters
in_stateWhether to export PMI.
Returns
A reference to this ExportJTOptionsKit.
See also
Default value

◆ SetVersion()

HPS.Exchange.ExportJTOptionsKit HPS.Exchange.ExportJTOptionsKit.SetVersion ( HPS.Exchange.JT.Version  in_version)
inline

Sets the version of the JT format to export. This corresponds to the value that will be passed to A3DRWParamsExportJTData::m_eJTVersion.

Parameters
in_versionThe version of the JT format to export.
Returns
A reference to this ExportJTOptionsKit.
See also
Default value

◆ Show()

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

Copies this ExportJTOptionsKit into the given ExportJTOptionsKit.

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

◆ ShowContent()

bool HPS.Exchange.ExportJTOptionsKit.ShowContent ( out HPS.Exchange.JT.Content  out_content)
inline

Shows the content export setting.

Parameters
out_contentThe type of data to export.
Returns
true if a content export setting was specified, false otherwise.

◆ ShowHiddenObjects()

bool HPS.Exchange.ExportJTOptionsKit.ShowHiddenObjects ( out bool  out_state)
inline

Shows the hidden object export setting.

Parameters
out_stateWhether to export hidden objects.
Returns
true if a hidden object export setting was specified, false otherwise.

◆ ShowPMI()

bool HPS.Exchange.ExportJTOptionsKit.ShowPMI ( out bool  out_state)
inline

Shows the PMI export setting.

Parameters
out_stateWhether to export PMI.
Returns
true if a PMI export setting was specified, false otherwise.

◆ ShowVersion()

bool HPS.Exchange.ExportJTOptionsKit.ShowVersion ( out HPS.Exchange.JT.Version  out_version)
inline

Shows the version export setting.

Parameters
out_versionThe version of the JT format to export.
Returns
true if a version export setting was specified, false otherwise.

◆ UnsetContent()

HPS.Exchange.ExportJTOptionsKit HPS.Exchange.ExportJTOptionsKit.UnsetContent ( )
inline

Removes the content export setting.

Returns
A reference to this ExportJTOptionsKit.

◆ UnsetEverything()

HPS.Exchange.ExportJTOptionsKit HPS.Exchange.ExportJTOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ExportJTOptionsKit.

Returns
A reference to this ExportJTOptionsKit.

◆ UnsetHiddenObjects()

HPS.Exchange.ExportJTOptionsKit HPS.Exchange.ExportJTOptionsKit.UnsetHiddenObjects ( )
inline

Removes the hidden objects export setting.

Returns
A reference to this ExportJTOptionsKit.

◆ UnsetPMI()

HPS.Exchange.ExportJTOptionsKit HPS.Exchange.ExportJTOptionsKit.UnsetPMI ( )
inline

Removes the PMI export setting.

Returns
A reference to this ExportJTOptionsKit.

◆ UnsetVersion()

HPS.Exchange.ExportJTOptionsKit HPS.Exchange.ExportJTOptionsKit.UnsetVersion ( )
inline

Removes the version export setting.

Returns
A reference to this ExportJTOptionsKit.

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