NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Catiav5Importer Class Reference

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

Inheritance diagram for NXOpen::Catiav5Importer:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  ImportToOption { ImportToOptionWorkPart, ImportToOptionNewPart }
 Import To Option. More...
 

Public Member Functions

bool FileOpenFlag ()
 Returns the file open flag - should be set to false if doing file import
Created in NX6.0.0. More...
 
NXOpen::Catiav5Importer::ImportToOption ImportTo ()
 Returns the import to. More...
 
bool ImportToTeamcenter ()
 Returns the import to Teamcenter - if set to true then imported data can be added to Teamcenter
Created in NX11.0.1. More...
 
bool IncludeCSYS ()
 Returns the include coordinate systems - if set to true the coordinate systems from catia v5 will be imported to NX
Created in NX9.0.1. More...
 
bool IncludeIndWireFrame ()
 Returns the include ind wire frame - if set to true the indpendent wireframe objects from catia v5 will be imported to NX
Created in NX6.0.0. More...
 
bool IncludeNoShowEntity ()
 Returns the include no show entity - if set to true then no show entities from the catia v5 file will be imported to NX
Created in NX6.0.0. More...
 
NXString InputFile ()
 Returns the input file - name of a file which is being imported
Created in NX6.0.0. More...
 
bool Optimize ()
 Returns the optimize - This option allows you to optimize the topology
Created in NX6.0.0. More...
 
NXString OutputFile ()
 Returns the output file - if V5 file is imported to new part then this name will be used to write the output. More...
 
void SaveSettings (const NXString &filename)
 Save the settings - this will save the settings to a file sepcified
Created in NX6.0.0. More...
 
void SaveSettings (const char *filename)
 Save the settings - this will save the settings to a file sepcified
Created in NX6.0.0. More...
 
NXString SearchDirectoryList ()
 Returns 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. More...
 
void SetFileOpenFlag (bool doingFileOpen)
 Sets the file open flag - should be set to false if doing file import
Created in NX6.0.0. More...
 
void SetImportTo (NXOpen::Catiav5Importer::ImportToOption importTo)
 Sets the import to. More...
 
void SetImportToTeamcenter (bool importToTeamcenter)
 Sets the import to Teamcenter - if set to true then imported data can be added to Teamcenter
Created in NX11.0.1. More...
 
void SetIncludeCSYS (bool includeCSYS)
 Sets the include coordinate systems - if set to true the coordinate systems from catia v5 will be imported to NX
Created in NX9.0.1. More...
 
void SetIncludeIndWireFrame (bool includeIndWireFrame)
 Sets the include ind wire frame - if set to true the indpendent wireframe objects from catia v5 will be imported to NX
Created in NX6.0.0. More...
 
void SetIncludeNoShowEntity (bool includeNoShowEntity)
 Sets the include no show entity - if set to true then no show entities from the catia v5 file will be imported to NX
Created in NX6.0.0. More...
 
void SetInputFile (const NXString &filename)
 Sets the input file - name of a file which is being imported
Created in NX6.0.0. More...
 
void SetInputFile (const char *filename)
 Sets the input file - name of a file which is being imported
Created in NX6.0.0. More...
 
void SetOptimize (bool optimize)
 Sets the optimize - This option allows you to optimize the topology
Created in NX6.0.0. More...
 
void SetOutputFile (const NXString &filename)
 Sets the output file - if V5 file is imported to new part then this name will be used to write the output. More...
 
void SetOutputFile (const char *filename)
 Sets the output file - if V5 file is imported to new part then this name will be used to write the output. More...
 
void SetSearchDirectoryList (const NXString &searchDirectoryList)
 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. More...
 
void SetSearchDirectoryList (const char *searchDirectoryList)
 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. More...
 
void SetSettingsFile (const NXString &filename)
 Sets the settings file - definition file for default options
Created in NX6.0.0. More...
 
void SetSettingsFile (const char *filename)
 Sets the settings file - definition file for default options
Created in NX6.0.0. More...
 
void SetSimplifyFacesandEdges (bool simplifyFacesandEdges)
 Sets the simplify faces and edges - This option allows you to simplify nearly analytical faces and edges to analytics
Created in NX6.0.0. More...
 
NXString SettingsFile ()
 Returns the settings file - definition file for default options
Created in NX6.0.0. More...
 
void SetTotalSearchDirectories (int totalSearchDir)
 Sets the number of search directories - This option allows you to specify total number of serach directories
Created in NX6.0.0. More...
 
bool SimplifyFacesandEdges ()
 Returns the simplify faces and edges - This option allows you to simplify nearly analytical faces and edges to analytics
Created in NX6.0.0. More...
 
int TotalSearchDirectories ()
 Returns the number of search directories - This option allows you to specify total number of serach directories
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

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


Created in NX6.0.0.

Member Enumeration Documentation

Import To Option.

Enumerator
ImportToOptionWorkPart 

import Catia V5 file to work part

ImportToOptionNewPart 

import Catia V5 file to new part

Member Function Documentation

bool NXOpen::Catiav5Importer::FileOpenFlag ( )

Returns the file open flag - should be set to false if doing file import
Created in NX6.0.0.



License requirements : None

NXOpen::Catiav5Importer::ImportToOption NXOpen::Catiav5Importer::ImportTo ( )

Returns the import to.

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

License requirements : None

bool NXOpen::Catiav5Importer::ImportToTeamcenter ( )

Returns the import to Teamcenter - if set to true then imported data can be added to Teamcenter
Created in NX11.0.1.



License requirements : None

bool NXOpen::Catiav5Importer::IncludeCSYS ( )

Returns the include coordinate systems - if set to true the coordinate systems from catia v5 will be imported to NX
Created in NX9.0.1.



License requirements : None

bool NXOpen::Catiav5Importer::IncludeIndWireFrame ( )

Returns the include ind wire frame - if set to true the indpendent wireframe objects from catia v5 will be imported to NX
Created in NX6.0.0.



License requirements : None

bool NXOpen::Catiav5Importer::IncludeNoShowEntity ( )

Returns the include no show entity - if set to true then no show entities from the catia v5 file will be imported to NX
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Catiav5Importer::InputFile ( )

Returns the input file - name of a file which is being imported
Created in NX6.0.0.



License requirements : None

bool NXOpen::Catiav5Importer::Optimize ( )

Returns the optimize - This option allows you to optimize the topology
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Catiav5Importer::OutputFile ( )

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


Created in NX11.0.1.

License requirements : None

void NXOpen::Catiav5Importer::SaveSettings ( const NXString filename)

Save the settings - this will save the settings to a file sepcified
Created in NX6.0.0.



License requirements : None

Parameters
filenamefilename
void NXOpen::Catiav5Importer::SaveSettings ( const char *  filename)

Save the settings - this will save the settings to a file sepcified
Created in NX6.0.0.



License requirements : None

Parameters
filenamefilename
NXString NXOpen::Catiav5Importer::SearchDirectoryList ( )

Returns 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.
Created in NX6.0.0.

License requirements : None

void NXOpen::Catiav5Importer::SetFileOpenFlag ( bool  doingFileOpen)

Sets the file open flag - should be set to false if doing file import
Created in NX6.0.0.



License requirements : None

Parameters
doingFileOpendoingfileopen
void NXOpen::Catiav5Importer::SetImportTo ( NXOpen::Catiav5Importer::ImportToOption  importTo)

Sets the import to.

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

License requirements : None

Parameters
importToimportto
void NXOpen::Catiav5Importer::SetImportToTeamcenter ( bool  importToTeamcenter)

Sets the import to Teamcenter - if set to true then imported data can be added to Teamcenter
Created in NX11.0.1.



License requirements : None

Parameters
importToTeamcenterimporttoteamcenter
void NXOpen::Catiav5Importer::SetIncludeCSYS ( bool  includeCSYS)

Sets the include coordinate systems - if set to true the coordinate systems from catia v5 will be imported to NX
Created in NX9.0.1.



License requirements : None

Parameters
includeCSYSincludecsys
void NXOpen::Catiav5Importer::SetIncludeIndWireFrame ( bool  includeIndWireFrame)

Sets the include ind wire frame - if set to true the indpendent wireframe objects from catia v5 will be imported to NX
Created in NX6.0.0.



License requirements : None

Parameters
includeIndWireFrameincludeindwireframe
void NXOpen::Catiav5Importer::SetIncludeNoShowEntity ( bool  includeNoShowEntity)

Sets the include no show entity - if set to true then no show entities from the catia v5 file will be imported to NX
Created in NX6.0.0.



License requirements : None

Parameters
includeNoShowEntityincludenoshowentity
void NXOpen::Catiav5Importer::SetInputFile ( const NXString filename)

Sets the input file - name of a file which is being imported
Created in NX6.0.0.



License requirements : None

Parameters
filenamefilename
void NXOpen::Catiav5Importer::SetInputFile ( const char *  filename)

Sets the input file - name of a file which is being imported
Created in NX6.0.0.



License requirements : None

Parameters
filenamefilename
void NXOpen::Catiav5Importer::SetOptimize ( bool  optimize)

Sets the optimize - This option allows you to optimize the topology
Created in NX6.0.0.



License requirements : None

Parameters
optimizeoptimize
void NXOpen::Catiav5Importer::SetOutputFile ( const NXString filename)

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


Created in NX11.0.1.

License requirements : None

Parameters
filenamefilename
void NXOpen::Catiav5Importer::SetOutputFile ( const char *  filename)

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


Created in NX11.0.1.

License requirements : None

Parameters
filenamefilename
void NXOpen::Catiav5Importer::SetSearchDirectoryList ( const NXString searchDirectoryList)

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.
Created in NX6.0.0.

License requirements : None

Parameters
searchDirectoryListsearchdirectorylist
void NXOpen::Catiav5Importer::SetSearchDirectoryList ( const char *  searchDirectoryList)

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.
Created in NX6.0.0.

License requirements : None

Parameters
searchDirectoryListsearchdirectorylist
void NXOpen::Catiav5Importer::SetSettingsFile ( const NXString filename)

Sets the settings file - definition file for default options
Created in NX6.0.0.



License requirements : None

Parameters
filenamefilename
void NXOpen::Catiav5Importer::SetSettingsFile ( const char *  filename)

Sets the settings file - definition file for default options
Created in NX6.0.0.



License requirements : None

Parameters
filenamefilename
void NXOpen::Catiav5Importer::SetSimplifyFacesandEdges ( bool  simplifyFacesandEdges)

Sets the simplify faces and edges - This option allows you to simplify nearly analytical faces and edges to analytics
Created in NX6.0.0.



License requirements : None

Parameters
simplifyFacesandEdgessimplifyfacesandedges
NXString NXOpen::Catiav5Importer::SettingsFile ( )

Returns the settings file - definition file for default options
Created in NX6.0.0.



License requirements : None

void NXOpen::Catiav5Importer::SetTotalSearchDirectories ( int  totalSearchDir)

Sets the number of search directories - This option allows you to specify total number of serach directories
Created in NX6.0.0.



License requirements : None

Parameters
totalSearchDirtotalsearchdir
bool NXOpen::Catiav5Importer::SimplifyFacesandEdges ( )

Returns the simplify faces and edges - This option allows you to simplify nearly analytical faces and edges to analytics
Created in NX6.0.0.



License requirements : None

int NXOpen::Catiav5Importer::TotalSearchDirectories ( )

Returns the number of search directories - This option allows you to specify total number of serach directories
Created in NX6.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.