< Home

< Table of Contents

REFERENCE MANUAL

HPS.Exchange.ExportJTOptionsKit Class Reference

The Exchange::ExportJTOptionsKit class is a user space object. More...

Inheritance diagram for HPS.Exchange.ExportJTOptionsKit:
HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 Indicates whether this ExportJTOptionsKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Exchange.ExportJTOptionsKit in_kit)
 Check if the source ExportJTOptionsKit is equivalent to this ExportJTOptionsKit. More...
 
 ExportJTOptionsKit ()
 The default constructor creates an empty ExportJTOptionsKit object. More...
 
 ExportJTOptionsKit (HPS.Exchange.ExportJTOptionsKit in_kit)
 The copy constructor creates a new ExportJTOptionsKit object that contains the same settings as the source ExportJTOptionsKit. More...
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.Exchange.ExportJTOptionsKit in_kit)
 Copies the source ExportJTOptionsKit into this ExportJTOptionsKit. More...
 
HPS.Exchange.ExportJTOptionsKit SetContent (HPS.Exchange.JT.Content in_content)
 Sets the type of data to export. More...
 
HPS.Exchange.ExportJTOptionsKit SetHiddenObjects (bool in_state)
 Sets whether to export hidden objects. More...
 
HPS.Exchange.ExportJTOptionsKit SetPMI (bool in_state)
 Sets whether to export PMI. More...
 
void Show (out HPS.Exchange.ExportJTOptionsKit out_kit)
 Copies this ExportJTOptionsKit into the given ExportJTOptionsKit. More...
 
bool ShowContent (out HPS.Exchange.JT.Content out_content)
 Shows the content export setting. More...
 
bool ShowHiddenObjects (out bool out_state)
 Shows the hidden object export setting. More...
 
bool ShowPMI (out bool out_state)
 Shows the PMI export setting. More...
 
HPS.Exchange.ExportJTOptionsKit UnsetContent ()
 Removes the content export setting. More...
 
HPS.Exchange.ExportJTOptionsKit UnsetEverything ()
 Removes all settings from this ExportJTOptionsKit. More...
 
HPS.Exchange.ExportJTOptionsKit UnsetHiddenObjects ()
 Removes the hidden objects export setting. More...
 
HPS.Exchange.ExportJTOptionsKit UnsetPMI ()
 Removes the PMI export setting. More...
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

Static Public Member Functions

static
HPS.Exchange.ExportJTOptionsKit 
GetDefault ()
 Creates an ExportJTOptionsKit which contains the default settings. More...
 
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

- Public Types inherited from HPS.Sprocket
enum  UpdateType { Synchronous = 0, Asynchronous = 1 }
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The Exchange::ExportJTOptionsKit class is a user space object.

It contains settings controlling how JT data is exported via Exchange. Calling Exchange::ExportJTOptionsKit::GetDefault() will return an options kit with values found in here.

Constructor & Destructor Documentation

HPS.Exchange.ExportJTOptionsKit.ExportJTOptionsKit ( )

The default constructor creates an empty ExportJTOptionsKit object.

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

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

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_exchange_1_1_export_j_t_options_kit" kindref="compound">ExportJTOptionsKit</ref> to copy.

Member Function Documentation

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

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.

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

Check if the source ExportJTOptionsKit is equivalent to this ExportJTOptionsKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_exchange_1_1_export_j_t_options_kit" kindref="compound">ExportJTOptionsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_exchange_1_1_export_j_t_options_kit" kindref="compound">ExportJTOptionsKit</ref>.
Returns
true if the objects are equivalent, false otherwise.
static HPS.Exchange.ExportJTOptionsKit HPS.Exchange.ExportJTOptionsKit.GetDefault ( )
static

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.
override HPS.Type HPS.Exchange.ExportJTOptionsKit.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

void HPS.Exchange.ExportJTOptionsKit.Set ( HPS.Exchange.ExportJTOptionsKit  in_kit)

Copies the source ExportJTOptionsKit into this ExportJTOptionsKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_exchange_1_1_export_j_t_options_kit" kindref="compound">ExportJTOptionsKit</ref> to copy.
HPS.Exchange.ExportJTOptionsKit HPS.Exchange.ExportJTOptionsKit.SetContent ( HPS.Exchange.JT.Content  in_content)

Sets the type of data to export.

This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/exchange_ref_manual/struct_a3_d_r_w_params_export_j_t_data.html#add11ead0aff256e907a0d932dd620c19">A3DRWParamsExportJTData::m_eWriteGeomTessMode</ulink>.

Parameters
in_contentThe type of data to export.
Returns
A reference to this ExportJTOptionsKit.

Default value

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

Sets whether to export hidden objects.

This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/exchange_ref_manual/struct_a3_d_r_w_params_export_j_t_data.html#a08988cd540914a2637ca5e83fe0dfebb">A3DRWParamsExportJTData::m_bWriteHiddenObjects</ulink>.

Parameters
in_stateWhether to export hidden objects.
Returns
A reference to this ExportJTOptionsKit.

Default value

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

Sets whether to export PMI.

This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/exchange_ref_manual/struct_a3_d_r_w_params_export_j_t_data.html#a722eab9279f0e9a8d21d583e07ebff92">A3DRWParamsExportJTData::m_bWritePMI</ulink>.

Parameters
in_stateWhether to export PMI.
Returns
A reference to this ExportJTOptionsKit.

Default value

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

Copies this ExportJTOptionsKit into the given ExportJTOptionsKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_exchange_1_1_export_j_t_options_kit" kindref="compound">ExportJTOptionsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_exchange_1_1_export_j_t_options_kit" kindref="compound">ExportJTOptionsKit</ref>.
bool HPS.Exchange.ExportJTOptionsKit.ShowContent ( out HPS.Exchange.JT.Content  out_content)

Shows the content export setting.

Parameters
out_contentThe type of data to export.
Returns
true if a content export setting was specified, false otherwise.
bool HPS.Exchange.ExportJTOptionsKit.ShowHiddenObjects ( out bool  out_state)

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.
bool HPS.Exchange.ExportJTOptionsKit.ShowPMI ( out bool  out_state)

Shows the PMI export setting.

Parameters
out_stateWhether to export PMI.
Returns
true if a PMI export setting was specified, false otherwise.
HPS.Exchange.ExportJTOptionsKit HPS.Exchange.ExportJTOptionsKit.UnsetContent ( )

Removes the content export setting.

Returns
A reference to this ExportJTOptionsKit.
HPS.Exchange.ExportJTOptionsKit HPS.Exchange.ExportJTOptionsKit.UnsetEverything ( )

Removes all settings from this ExportJTOptionsKit.

Returns
A reference to this ExportJTOptionsKit.
HPS.Exchange.ExportJTOptionsKit HPS.Exchange.ExportJTOptionsKit.UnsetHiddenObjects ( )

Removes the hidden objects export setting.

Returns
A reference to this ExportJTOptionsKit.
HPS.Exchange.ExportJTOptionsKit HPS.Exchange.ExportJTOptionsKit.UnsetPMI ( )

Removes the PMI export setting.

Returns
A reference to this ExportJTOptionsKit.

The documentation for this class was generated from the following file: