Catiav5Creator Class¶
-
class
NXOpen.Catiav5Creator¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Catiav5Creatorto be used when exporting the CATIA V5 Data This class is created usingNXOpen.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 New in version NX6.0.0.
Properties¶
| Property | Description |
|---|---|
| EnableHybridDesign | Returns or sets the enable hybrid design - If set to true then it will enable hybrid design |
| ExportFrom | Returns or sets the export from - this option will determine if data from display part or existing part is exported |
| ExportSelectionBlock | Returns the export selection block - the object selection will be done by this block. |
| FileSaveFlag | Returns or sets the file save flag - this should be set to false if doing File Export |
| IncludeBlankedObj | Returns or sets the include blanked obj - If set to true then blanked objects will also be written to catia file. |
| IncludeCSYS | Returns or sets the include coordinate systems - if set true then datum coordinate systems will be exported to catia v5 file |
| IncludeIndWireFrame | Returns or sets the include ind wire frame if set true then indpendent wireframe objects will be exported to catia v5 file |
| InputFile | Returns or sets the input file - name of file which is being exported. |
| OutputFile | Returns or sets the output file - the exported data will be written to file specified |
| SettingsFile | Returns or sets the settings file - The definition file to read default options |
| Tag | Returns the Tag for this object. |
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¶
| Catiav5CreatorExportFromOption Enumeration | Export from options |
Property Detail¶
EnableHybridDesign¶
-
Catiav5Creator.EnableHybridDesign¶ Returns or sets the enable hybrid design - If set to true then it will enable hybrid design
-------------------------------------Getter Method
Signature
EnableHybridDesign()Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
EnableHybridDesign(enableHybridDesign)Parameters: enableHybridDesign (bool) – New in version NX7.5.0.
License requirements: None.
ExportFrom¶
-
Catiav5Creator.ExportFrom¶ Returns or sets the export from - this option will determine if data from display part or existing part is exported
-------------------------------------Getter Method
Signature
ExportFrom()Returns: Return type: NXOpen.Catiav5CreatorExportFromOptionNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ExportFrom(exportFrom)Parameters: exportFrom ( NXOpen.Catiav5CreatorExportFromOption) –New in version NX8.0.0.
License requirements: None.
ExportSelectionBlock¶
-
Catiav5Creator.ExportSelectionBlock¶ Returns the export selection block - the object selection will be done by this block.
-------------------------------------Getter Method
Signature
ExportSelectionBlock()Returns: Return type: NXOpen.ObjectSelectorNew in version NX6.0.0.
License requirements: None.
FileSaveFlag¶
-
Catiav5Creator.FileSaveFlag¶ Returns or sets the file save flag - this should be set to false if doing File Export
-------------------------------------Getter Method
Signature
FileSaveFlag()Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
FileSaveFlag(doingFileSave)Parameters: doingFileSave (bool) – New in version NX6.0.0.
License requirements: None.
IncludeBlankedObj¶
-
Catiav5Creator.IncludeBlankedObj¶ Returns or sets the include blanked obj - If set to true then blanked objects will also be written to catia file.
-------------------------------------Getter Method
Signature
IncludeBlankedObj()Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
IncludeBlankedObj(includeBlankedObj)Parameters: includeBlankedObj (bool) – New in version NX6.0.0.
License requirements: None.
IncludeCSYS¶
-
Catiav5Creator.IncludeCSYS¶ Returns or sets the include coordinate systems - if set true then datum coordinate systems will be exported to catia v5 file
-------------------------------------Getter Method
Signature
IncludeCSYS()Returns: Return type: bool New in version NX9.0.1.
License requirements: None.
-------------------------------------Setter Method
Signature
IncludeCSYS(includeCSYS)Parameters: includeCSYS (bool) – New in version NX9.0.1.
License requirements: None.
IncludeIndWireFrame¶
-
Catiav5Creator.IncludeIndWireFrame¶ Returns or sets the include ind wire frame if set true then indpendent wireframe objects will be exported to catia v5 file
-------------------------------------Getter Method
Signature
IncludeIndWireFrame()Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
IncludeIndWireFrame(includeIndWireFrame)Parameters: includeIndWireFrame (bool) – New in version NX6.0.0.
License requirements: None.
InputFile¶
-
Catiav5Creator.InputFile¶ Returns or sets the input file - name of file which is being exported.
-------------------------------------Getter Method
Signature
InputFile()Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
InputFile(filename)Parameters: filename (str) – New in version NX8.0.0.
License requirements: None.
OutputFile¶
-
Catiav5Creator.OutputFile¶ Returns or sets the output file - the exported data will be written to file specified
-------------------------------------Getter Method
Signature
OutputFile()Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
OutputFile(filename)Parameters: filename (str) – New in version NX6.0.0.
License requirements: None.
SettingsFile¶
-
Catiav5Creator.SettingsFile¶ Returns or sets the settings file - The definition file to read default options
-------------------------------------Getter Method
Signature
SettingsFile()Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SettingsFile(filename)Parameters: filename (str) – New in version NX6.0.0.
License requirements: None.
Method Detail¶
SaveSettings¶
-
Catiav5Creator.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¶
-
Catiav5Creator.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.