Catiav5Importer Class — NXOpen Python API Reference 12.0.0 documentation

# Catiav5Importer Class

class `NXOpen.``Catiav5Importer`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Catiav5Importer` to be used when importing the CATIA V5 Data This class is created using `NXOpen.DexManager`.

  NULL object will be returned from Commit() To create a new instance of this class, use `NXOpen.DexManager.CreateCatiav5Importer()`

  Default values.

  Property | Value
  --- | ---
  ImportTo | WorkPart
  ImportToTeamcenter | 0
  IncludeCSYS | 0
  IncludeIndWireFrame | 1
  IncludeNoShowEntity | 0
  Optimize | 1
  SimplifyFacesandEdges | 0
  TotalSearchDirectories | 0

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
FileOpenFlag | Returns or sets the file open flag - should be set to false if doing file import
ImportTo | Returns or sets the import to.
ImportToTeamcenter | Returns or sets the import to Teamcenter - if set to true then imported data can be added to Teamcenter
IncludeCSYS | Returns or sets the include coordinate systems - if set to true the coordinate systems from catia v5 will be imported to NX
IncludeIndWireFrame | Returns or sets the include ind wire frame - if set to true the indpendent wireframe objects from catia v5 will be imported to NX
IncludeNoShowEntity | Returns or sets the include no show entity - if set to true then no show entities from the catia v5 file will be imported to NX
InputFile | Returns or sets the input file - name of a file which is being imported
Optimize | Returns or sets the optimize - This option allows you to optimize the topology
OutputFile | Returns or sets the output file - if V5 file is imported to new part then this name will be used to write the output.
SearchDirectoryList | Returns or sets the serach directory list - This option allows you to specify a semicolon separated list of directories in which the translator can find components of an assembly.
SettingsFile | Returns or sets the settings file - definition file for default options
SimplifyFacesandEdges | Returns or sets the simplify faces and edges - This option allows you to simplify nearly analytical faces and edges to analytics
Tag | Returns the Tag for this object.
TotalSearchDirectories | Returns or sets the number of search directories - This option allows you to specify total number of serach directories

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetObject | Returns the object currently being edited by this builder.
SaveSettings | Save the settings - this will save the settings to a file sepcified
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

Catiav5ImporterImportToOption Enumeration | Import To Option

# Property Detail

## FileOpenFlag

`Catiav5Importer.``FileOpenFlag`

  Returns or sets the file open flag - should be set to false if doing file import

  `-------------------------------------`

  Getter Method

  Signature `FileOpenFlag`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `FileOpenFlag`

  Parameters: | doingFileOpen (bool) –

  New in version NX6.0.0.

  License requirements: None.

## ImportTo

`Catiav5Importer.``ImportTo`

  Returns or sets the import to.

  This option will determine the destination for imported V5 file. It can either be new part or work part.

  `-------------------------------------`

  Getter Method

  Signature `ImportTo`

  Returns: |
  Return type: | `NXOpen.Catiav5ImporterImportToOption`

  New in version NX11.0.1.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ImportTo`

  Parameters: | importTo (`NXOpen.Catiav5ImporterImportToOption`) –

  New in version NX11.0.1.

  License requirements: None.

## ImportToTeamcenter

`Catiav5Importer.``ImportToTeamcenter`

  Returns or sets the import to Teamcenter - if set to true then imported data can be added to Teamcenter

  `-------------------------------------`

  Getter Method

  Signature `ImportToTeamcenter`

  Returns: |
  Return type: | bool

  New in version NX11.0.1.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ImportToTeamcenter`

  Parameters: | importToTeamcenter (bool) –

  New in version NX11.0.1.

  License requirements: None.

## IncludeCSYS

`Catiav5Importer.``IncludeCSYS`

  Returns or sets the include coordinate systems - if set to true the coordinate systems from catia v5 will be imported to NX

  `-------------------------------------`

  Getter Method

  Signature `IncludeCSYS`

  Returns: |
  Return type: | bool

  New in version NX9.0.1.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `IncludeCSYS`

  Parameters: | includeCSYS (bool) –

  New in version NX9.0.1.

  License requirements: None.

## IncludeIndWireFrame

`Catiav5Importer.``IncludeIndWireFrame`

  Returns or sets the include ind wire frame - if set to true the indpendent wireframe objects from catia v5 will be imported to NX

  `-------------------------------------`

  Getter Method

  Signature `IncludeIndWireFrame`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `IncludeIndWireFrame`

  Parameters: | includeIndWireFrame (bool) –

  New in version NX6.0.0.

  License requirements: None.

## IncludeNoShowEntity

`Catiav5Importer.``IncludeNoShowEntity`

  Returns or sets the include no show entity - if set to true then no show entities from the catia v5 file will be imported to NX

  `-------------------------------------`

  Getter Method

  Signature `IncludeNoShowEntity`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `IncludeNoShowEntity`

  Parameters: | includeNoShowEntity (bool) –

  New in version NX6.0.0.

  License requirements: None.

## InputFile

`Catiav5Importer.``InputFile`

  Returns or sets the input file - name of a file which is being imported

  `-------------------------------------`

  Getter Method

  Signature `InputFile`

  Returns: |
  Return type: | str

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `InputFile`

  Parameters: | filename (str) –

  New in version NX6.0.0.

  License requirements: None.

## Optimize

`Catiav5Importer.``Optimize`

  Returns or sets the optimize - This option allows you to optimize the topology

  `-------------------------------------`

  Getter Method

  Signature `Optimize`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Optimize`

  Parameters: | optimize (bool) –

  New in version NX6.0.0.

  License requirements: None.

## OutputFile

`Catiav5Importer.``OutputFile`

  Returns or sets the output file - if V5 file is imported to new part then this name will be used to write the output.

  `-------------------------------------`

  Getter Method

  Signature `OutputFile`

  Returns: |
  Return type: | str

  New in version NX11.0.1.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `OutputFile`

  Parameters: | filename (str) –

  New in version NX11.0.1.

  License requirements: None.

## SearchDirectoryList

`Catiav5Importer.``SearchDirectoryList`

  Returns or sets the serach directory list - This option allows you to specify a semicolon separated list of directories in which the translator can find components of an assembly.

  The translator will search all of the subdirectories below the given directories.

  `-------------------------------------`

  Getter Method

  Signature `SearchDirectoryList`

  Returns: |
  Return type: | str

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SearchDirectoryList`

  Parameters: | searchDirectoryList (str) –

  New in version NX6.0.0.

  License requirements: None.

## SettingsFile

`Catiav5Importer.``SettingsFile`

  Returns or sets the settings file - definition file for default options

  `-------------------------------------`

  Getter Method

  Signature `SettingsFile`

  Returns: |
  Return type: | str

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SettingsFile`

  Parameters: | filename (str) –

  New in version NX6.0.0.

  License requirements: None.

## SimplifyFacesandEdges

`Catiav5Importer.``SimplifyFacesandEdges`

  Returns or sets the simplify faces and edges - This option allows you to simplify nearly analytical faces and edges to analytics

  `-------------------------------------`

  Getter Method

  Signature `SimplifyFacesandEdges`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SimplifyFacesandEdges`

  Parameters: | simplifyFacesandEdges (bool) –

  New in version NX6.0.0.

  License requirements: None.

## TotalSearchDirectories

`Catiav5Importer.``TotalSearchDirectories`

  Returns or sets the number of search directories - This option allows you to specify total number of serach directories

  `-------------------------------------`

  Getter Method

  Signature `TotalSearchDirectories`

  Returns: |
  Return type: | int

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `TotalSearchDirectories`

  Parameters: | totalSearchDir (int) –

  New in version NX6.0.0.

  License requirements: None.

# Method Detail

## SaveSettings

`Catiav5Importer.``SaveSettings`

  Save the settings - this will save the settings to a file sepcified

  Signature `SaveSettings(filename)`

  Parameters: | filename (str) –

  New in version NX6.0.0.

  License requirements: None.

## Validate

`Catiav5Importer.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.