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

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

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

Public Types

enum  ExportFromOption { ExportFromOptionDisplayPart, ExportFromOptionExistingPart }
 Export from options. More...
 

Public Member Functions

bool EnableHybridDesign ()
 Returns the enable hybrid design - If set to true then it will enable hybrid design
Created in NX7.5.0. More...
 
NXOpen::Catiav5Creator::ExportFromOption ExportFrom ()
 Returns the export from - this option will determine if data from display part or existing part is exported
Created in NX8.0.0. More...
 
NXOpen::ObjectSelectorExportSelectionBlock ()
 Returns the export selection block - the object selection will be done by this block. More...
 
bool FileSaveFlag ()
 Returns the file save flag - this should be set to false if doing File Export
Created in NX6.0.0. More...
 
bool IncludeBlankedObj ()
 Returns the include blanked obj - If set to true then blanked objects will also be written to catia file. More...
 
bool IncludeCSYS ()
 Returns the include coordinate systems - if set true then datum coordinate systems will be exported to catia v5 file
Created in NX9.0.1. More...
 
bool IncludeIndWireFrame ()
 Returns the include ind wire frame if set true then indpendent wireframe objects will be exported to catia v5 file
Created in NX6.0.0. More...
 
NXString InputFile ()
 Returns the input file - name of file which is being exported. More...
 
NXString OutputFile ()
 Returns the output file - the exported data will be written to file specified
Created in NX6.0.0. 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...
 
void SetEnableHybridDesign (bool enableHybridDesign)
 Sets the enable hybrid design - If set to true then it will enable hybrid design
Created in NX7.5.0. More...
 
void SetExportFrom (NXOpen::Catiav5Creator::ExportFromOption exportFrom)
 Sets the export from - this option will determine if data from display part or existing part is exported
Created in NX8.0.0. More...
 
void SetFileSaveFlag (bool doingFileSave)
 Sets the file save flag - this should be set to false if doing File Export
Created in NX6.0.0. More...
 
void SetIncludeBlankedObj (bool includeBlankedObj)
 Sets the include blanked obj - If set to true then blanked objects will also be written to catia file. More...
 
void SetIncludeCSYS (bool includeCSYS)
 Sets the include coordinate systems - if set true then datum coordinate systems will be exported to catia v5 file
Created in NX9.0.1. More...
 
void SetIncludeIndWireFrame (bool includeIndWireFrame)
 Sets the include ind wire frame if set true then indpendent wireframe objects will be exported to catia v5 file
Created in NX6.0.0. More...
 
void SetInputFile (const NXString &filename)
 Sets the input file - name of file which is being exported. More...
 
void SetInputFile (const char *filename)
 Sets the input file - name of file which is being exported. More...
 
void SetOutputFile (const NXString &filename)
 Sets the output file - the exported data will be written to file specified
Created in NX6.0.0. More...
 
void SetOutputFile (const char *filename)
 Sets the output file - the exported data will be written to file specified
Created in NX6.0.0. More...
 
void SetSettingsFile (const NXString &filename)
 Sets the settings file - The definition file to read default options
Created in NX6.0.0. More...
 
void SetSettingsFile (const char *filename)
 Sets the settings file - The definition file to read default options
Created in NX6.0.0. More...
 
NXString SettingsFile ()
 Returns the settings file - The definition file to read default options
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::Catiav5Creator to be used when exporting 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::CreateCatiav5Creator
Default values.

Property Value

EnableHybridDesign

1

ExportFrom

DisplayPart

IncludeBlankedObj

0

IncludeCSYS

0

IncludeIndWireFrame

0


Created in NX6.0.0.

Member Enumeration Documentation

Export from options.

Enumerator
ExportFromOptionDisplayPart 

export data from displayed part

ExportFromOptionExistingPart 

export data from existing part which is on disk

Member Function Documentation

bool NXOpen::Catiav5Creator::EnableHybridDesign ( )

Returns the enable hybrid design - If set to true then it will enable hybrid design
Created in NX7.5.0.



License requirements : None

NXOpen::Catiav5Creator::ExportFromOption NXOpen::Catiav5Creator::ExportFrom ( )

Returns the export from - this option will determine if data from display part or existing part is exported
Created in NX8.0.0.



License requirements : None

NXOpen::ObjectSelector* NXOpen::Catiav5Creator::ExportSelectionBlock ( )

Returns the export selection block - the object selection will be done by this block.


Created in NX6.0.0.

License requirements : None

bool NXOpen::Catiav5Creator::FileSaveFlag ( )

Returns the file save flag - this should be set to false if doing File Export
Created in NX6.0.0.



License requirements : None

bool NXOpen::Catiav5Creator::IncludeBlankedObj ( )

Returns the include blanked obj - If set to true then blanked objects will also be written to catia file.


Created in NX6.0.0.

License requirements : None

bool NXOpen::Catiav5Creator::IncludeCSYS ( )

Returns the include coordinate systems - if set true then datum coordinate systems will be exported to catia v5 file
Created in NX9.0.1.



License requirements : None

bool NXOpen::Catiav5Creator::IncludeIndWireFrame ( )

Returns the include ind wire frame if set true then indpendent wireframe objects will be exported to catia v5 file
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Catiav5Creator::InputFile ( )

Returns the input file - name of file which is being exported.


Created in NX8.0.0.

License requirements : None

NXString NXOpen::Catiav5Creator::OutputFile ( )

Returns the output file - the exported data will be written to file specified
Created in NX6.0.0.



License requirements : None

void NXOpen::Catiav5Creator::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::Catiav5Creator::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
void NXOpen::Catiav5Creator::SetEnableHybridDesign ( bool  enableHybridDesign)

Sets the enable hybrid design - If set to true then it will enable hybrid design
Created in NX7.5.0.



License requirements : None

Parameters
enableHybridDesignenablehybriddesign
void NXOpen::Catiav5Creator::SetExportFrom ( NXOpen::Catiav5Creator::ExportFromOption  exportFrom)

Sets the export from - this option will determine if data from display part or existing part is exported
Created in NX8.0.0.



License requirements : None

Parameters
exportFromexportfrom
void NXOpen::Catiav5Creator::SetFileSaveFlag ( bool  doingFileSave)

Sets the file save flag - this should be set to false if doing File Export
Created in NX6.0.0.



License requirements : None

Parameters
doingFileSavedoingfilesave
void NXOpen::Catiav5Creator::SetIncludeBlankedObj ( bool  includeBlankedObj)

Sets the include blanked obj - If set to true then blanked objects will also be written to catia file.


Created in NX6.0.0.

License requirements : None

Parameters
includeBlankedObjincludeblankedobj
void NXOpen::Catiav5Creator::SetIncludeCSYS ( bool  includeCSYS)

Sets the include coordinate systems - if set true then datum coordinate systems will be exported to catia v5 file
Created in NX9.0.1.



License requirements : None

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

Sets the include ind wire frame if set true then indpendent wireframe objects will be exported to catia v5 file
Created in NX6.0.0.



License requirements : None

Parameters
includeIndWireFrameincludeindwireframe
void NXOpen::Catiav5Creator::SetInputFile ( const NXString filename)

Sets the input file - name of file which is being exported.


Created in NX8.0.0.

License requirements : None

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

Sets the input file - name of file which is being exported.


Created in NX8.0.0.

License requirements : None

Parameters
filenamefilename
void NXOpen::Catiav5Creator::SetOutputFile ( const NXString filename)

Sets the output file - the exported data will be written to file specified
Created in NX6.0.0.



License requirements : None

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

Sets the output file - the exported data will be written to file specified
Created in NX6.0.0.



License requirements : None

Parameters
filenamefilename
void NXOpen::Catiav5Creator::SetSettingsFile ( const NXString filename)

Sets the settings file - The definition file to read default options
Created in NX6.0.0.



License requirements : None

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

Sets the settings file - The definition file to read default options
Created in NX6.0.0.



License requirements : None

Parameters
filenamefilename
NXString NXOpen::Catiav5Creator::SettingsFile ( )

Returns the settings file - The definition file to read default options
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.