Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
HPS.Parasolid.ImportOptionsKit Class Reference

The ImportOptionsKit class is a user space object. It contains settings controlling what and how data is imported via the Parasolid interface. Calling HPS::Parasolid::ImportOptionsKit::GetDefault() will return an options kit with values found in here. More...

Inheritance diagram for HPS.Parasolid.ImportOptionsKit:
HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
 ImportOptionsKit ()
 The default constructor creates an empty ImportOptionsKit object. More...
 
 ImportOptionsKit (HPS.Parasolid.ImportOptionsKit in_kit)
 The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
void Set (HPS.Parasolid.ImportOptionsKit in_kit)
 Copies the source ImportOptionsKit into this ImportOptionsKit. More...
 
void Show (out HPS.Parasolid.ImportOptionsKit out_kit)
 Copies this ImportOptionsKit into the given ImportOptionsKit. More...
 
override bool Empty ()
 Indicates whether this ImportOptionsKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
bool Equals (HPS.Parasolid.ImportOptionsKit in_kit)
 Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit. More...
 
HPS.Parasolid.ImportOptionsKit SetFormat (HPS.Parasolid.Format in_format)
 Sets the format type to be imported. This corresponds to the value that will be passed to PK_PART_receive_o_t.transmit_format. More...
 
HPS.Parasolid.ImportOptionsKit SetUserFields (bool in_import_user_fields)
 Sets whether to import user fields from the CAD file. This corresponds to the value that will be passed to PK_PART_receive_o_t.receive_user_fields. More...
 
HPS.Parasolid.ImportOptionsKit SetAttributeMismatchBehavior (HPS.Parasolid.MismatchBehavior in_behavior)
 Sets the importer behavior for mismatched attributes. This corresponds to the value that will be passed to PK_PART_receive_o_t.attdef_mismatch. More...
 
HPS.Parasolid.ImportOptionsKit SetCompoundBodyBehavior (HPS.Parasolid.CompoundBodyBehavior in_behavior)
 Sets the importer behavior for compound bodies. This corresponds to the value that will be passed to PK_PART_receive_o_t.receive_compound. More...
 
HPS.Parasolid.ImportOptionsKit SetFacetTessellation (HPS.Parasolid.FacetTessellationKit in_facet_tessellation_kit)
 Sets the facet tessellation settings used during import This corresponds to the PK_TOPOL_render_facet_o_t struct. More...
 
HPS.Parasolid.ImportOptionsKit SetLineTessellation (HPS.Parasolid.LineTessellationKit in_line_tessellation_kit)
 Sets the line tessellation settings used during import This corresponds to the PK_TOPOL_render_line_o_t struct. More...
 
HPS.Parasolid.ImportOptionsKit UnsetFormat ()
 Removes the format import state. More...
 
HPS.Parasolid.ImportOptionsKit UnsetUserFields ()
 Removes the user fields import state. More...
 
HPS.Parasolid.ImportOptionsKit UnsetAttributeMismatchBehavior ()
 Removes the attribute mismatch behavior state. More...
 
HPS.Parasolid.ImportOptionsKit UnsetCompoundBodyBehavior ()
 Removes the compound body behavior state. More...
 
HPS.Parasolid.ImportOptionsKit UnsetFacetTessellation ()
 Removes the facet tessellation state. More...
 
HPS.Parasolid.ImportOptionsKit UnsetLineTessellation ()
 Removes the line tessellation state. More...
 
HPS.Parasolid.ImportOptionsKit UnsetEverything ()
 Removes all settings from this ImportOptionsKit. More...
 
bool ShowFormat (out HPS.Parasolid.Format out_format)
 Shows the format import setting. More...
 
bool ShowUserFields (out bool out_user_fields)
 Shows the user fields import setting. More...
 
bool ShowAttributeMismatchBehavior (out HPS.Parasolid.MismatchBehavior out_behavior)
 Shows the attribute mismatch behavior import setting. More...
 
bool ShowCompoundBodyBehavior (out HPS.Parasolid.CompoundBodyBehavior out_behavior)
 Shows the compound body behavior import setting. More...
 
bool ShowFacetTessellation (out HPS.Parasolid.FacetTessellationKit out_facet_tessellation)
 Shows the facet tessellation import setting. More...
 
bool ShowLineTessellation (out HPS.Parasolid.LineTessellationKit out_line_tessellation)
 Shows the line tessellation import setting. More...
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 Object (HPS.Object that)
 
HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 

Static Public Member Functions

static
HPS.Parasolid.ImportOptionsKit 
GetDefault ()
 Creates an ImportOptionsKit 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::Import. More...
 
static bool operator== (HPS.Parasolid.ImportOptionsKit a, HPS.Parasolid.ImportOptionsKit b)
 
static bool operator!= (HPS.Parasolid.ImportOptionsKit a, HPS.Parasolid.ImportOptionsKit 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 }
 The type of update to perform, either synchronous or asynchronous. More...
 
- Protected Attributes inherited from HPS.Object
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

Detailed Description

The ImportOptionsKit class is a user space object. It contains settings controlling what and how data is imported via the Parasolid interface. Calling HPS::Parasolid::ImportOptionsKit::GetDefault() will return an options kit with values found in here.

Constructor & Destructor Documentation

HPS.Parasolid.ImportOptionsKit.ImportOptionsKit ( )
inline

The default constructor creates an empty ImportOptionsKit object.

HPS.Parasolid.ImportOptionsKit.ImportOptionsKit ( HPS.Parasolid.ImportOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source ImportOptionsKit to copy.

Member Function Documentation

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

Indicates whether this ImportOptionsKit has any values set on it.

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

Reimplemented from HPS.Object.

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

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to compare to this ImportOptionsKit.
Returns
true if the objects are equivalent, false otherwise.
static HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.GetDefault ( )
inlinestatic

Creates an ImportOptionsKit 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::Import.

Returns
An ImportOptionsKit with the default settings.
override HPS.Type HPS.Parasolid.ImportOptionsKit.ObjectType ( )
inlinevirtual

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.Parasolid.ImportOptionsKit.Set ( HPS.Parasolid.ImportOptionsKit  in_kit)
inline

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.
HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.SetAttributeMismatchBehavior ( HPS.Parasolid.MismatchBehavior  in_behavior)
inline

Sets the importer behavior for mismatched attributes. This corresponds to the value that will be passed to PK_PART_receive_o_t.attdef_mismatch.

Parameters
in_behaviorThe behavior of the importer when mismatched attributes are found.
Returns
A reference to this ImportOptionsKit.

Default value

HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.SetCompoundBodyBehavior ( HPS.Parasolid.CompoundBodyBehavior  in_behavior)
inline

Sets the importer behavior for compound bodies. This corresponds to the value that will be passed to PK_PART_receive_o_t.receive_compound.

Parameters
in_behaviorThe behavior of the importer when compound bodies are found.
Returns
A reference to this ImportOptionsKit.

Default value

HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.SetFacetTessellation ( HPS.Parasolid.FacetTessellationKit  in_facet_tessellation_kit)
inline

Sets the facet tessellation settings used during import This corresponds to the PK_TOPOL_render_facet_o_t struct.

Parameters
in_facet_tessellation_kitThe facet tessellation settings used during import
Returns
A reference to this ImportOptionsKit.
HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.SetFormat ( HPS.Parasolid.Format  in_format)
inline

Sets the format type to be imported. This corresponds to the value that will be passed to PK_PART_receive_o_t.transmit_format.

Parameters
in_formatThe format of the file to be imported.
Returns
A reference to this ImportOptionsKit.

Default value

HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.SetLineTessellation ( HPS.Parasolid.LineTessellationKit  in_line_tessellation_kit)
inline

Sets the line tessellation settings used during import This corresponds to the PK_TOPOL_render_line_o_t struct.

Returns
A reference to this ImportOptionsKit.
HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.SetUserFields ( bool  in_import_user_fields)
inline

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

Parameters
in_import_user_fieldsWhether to import user fields from the CAD file.
Returns
A reference to this ImportOptionsKit.

Default value

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

Copies this ImportOptionsKit into the given ImportOptionsKit.

Parameters
out_kitThe ImportOptionsKit to populate with the contents of this ImportOptionsKit.
bool HPS.Parasolid.ImportOptionsKit.ShowAttributeMismatchBehavior ( out HPS.Parasolid.MismatchBehavior  out_behavior)
inline

Shows the attribute mismatch behavior import setting.

Parameters
out_behaviorThe attribute mismatch behavior setting for this import.
Returns
true if an attribute mismatch behavior setting was specified, false otherwise.
bool HPS.Parasolid.ImportOptionsKit.ShowCompoundBodyBehavior ( out HPS.Parasolid.CompoundBodyBehavior  out_behavior)
inline

Shows the compound body behavior import setting.

Parameters
out_behaviorThe compound body behavior setting for this import.
Returns
true if a compound body behavior setting was specified, false otherwise.
bool HPS.Parasolid.ImportOptionsKit.ShowFacetTessellation ( out HPS.Parasolid.FacetTessellationKit  out_facet_tessellation)
inline

Shows the facet tessellation import setting.

Parameters
out_facet_tessellationThe facet tessellation setting for this import.
Returns
true if a facet tessellation setting was specified, false otherwise.
bool HPS.Parasolid.ImportOptionsKit.ShowFormat ( out HPS.Parasolid.Format  out_format)
inline

Shows the format import setting.

Parameters
out_formatThe format setting for this import.
Returns
true if a format setting was specified, false otherwise.
bool HPS.Parasolid.ImportOptionsKit.ShowLineTessellation ( out HPS.Parasolid.LineTessellationKit  out_line_tessellation)
inline

Shows the line tessellation import setting.

Parameters
out_line_tessellationThe line tessellation setting for this import.
Returns
true if a line tessellation setting was specified, false otherwise.
bool HPS.Parasolid.ImportOptionsKit.ShowUserFields ( out bool  out_user_fields)
inline

Shows the user fields import setting.

Parameters
out_user_fieldsThe user fields setting for this import.
Returns
true if a user fields setting was specified, false otherwise.
HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.UnsetAttributeMismatchBehavior ( )
inline

Removes the attribute mismatch behavior state.

Returns
A reference to this ImportOptionsKit.
HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.UnsetCompoundBodyBehavior ( )
inline

Removes the compound body behavior state.

Returns
A reference to this ImportOptionsKit.
HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ImportOptionsKit.

Returns
A reference to this ImportOptionsKit.
HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.UnsetFacetTessellation ( )
inline

Removes the facet tessellation state.

Returns
A reference to this ImportOptionsKit.
HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.UnsetFormat ( )
inline

Removes the format import state.

Returns
A reference to this ImportOptionsKit.
HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.UnsetLineTessellation ( )
inline

Removes the line tessellation state.

Returns
A reference to this ImportOptionsKit.
HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.UnsetUserFields ( )
inline

Removes the user fields import state.

Returns
A reference to this ImportOptionsKit.

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