SinumerikCaExportBuilder Class¶
-
class
NXOpen.SIM.SinumerikCaExportBuilder¶ Bases:
NXOpen.BuilderThis class is used for export a spf file.
A call to
SinumerikCaExportBuilder.ExportSpf()is used to export a spf file. CallingBuilder.Commit()on this builder will only return None.Use the
NXOpen.Partclass to create a SinumerikCaExportBuilder object.New in version NX9.0.0.
Properties¶
| Property | Description |
|---|---|
| ChainElementIndex | Returns or sets the index used by chain elements when exporting the SPF file |
| CollisionPairIndex | Returns or sets the index used when exporting collision pairs to the SPF file |
| DeleteChainsAtStart | Returns or sets the flag which determines if chains are deleted at the beginning of the export |
| FileName | Returns or sets the output filename of the SPF file |
| ListOutput | Returns or sets the flag which determines if the output is printed to a listing window |
| ProtectionAreaElementIndex | Returns or sets the index used when exporting protection area elements to the SPF file |
| ProtectionAreaIndex | Returns or sets the index used when exporting protection areas to the SPF file |
| 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. |
| ExportSpf | Export to Sinumerik Spf file |
| 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. |
| 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. |
Property Detail¶
ChainElementIndex¶
-
SinumerikCaExportBuilder.ChainElementIndex¶ Returns or sets the index used by chain elements when exporting the SPF file
-------------------------------------Getter Method
Signature
ChainElementIndexReturns: Return type: int New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ChainElementIndexParameters: index (int) – New in version NX9.0.0.
License requirements: nx_sinumerik_ca (“Sinumerik Collision Avoidance”)
CollisionPairIndex¶
-
SinumerikCaExportBuilder.CollisionPairIndex¶ Returns or sets the index used when exporting collision pairs to the SPF file
-------------------------------------Getter Method
Signature
CollisionPairIndexReturns: Return type: int New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CollisionPairIndexParameters: index (int) – New in version NX9.0.0.
License requirements: nx_sinumerik_ca (“Sinumerik Collision Avoidance”)
DeleteChainsAtStart¶
-
SinumerikCaExportBuilder.DeleteChainsAtStart¶ Returns or sets the flag which determines if chains are deleted at the beginning of the export
-------------------------------------Getter Method
Signature
DeleteChainsAtStartReturns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DeleteChainsAtStartParameters: deleteChainsAtStart (bool) – New in version NX9.0.0.
License requirements: nx_sinumerik_ca (“Sinumerik Collision Avoidance”)
FileName¶
-
SinumerikCaExportBuilder.FileName¶ Returns or sets the output filename of the SPF file
-------------------------------------Getter Method
Signature
FileNameReturns: The output name Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
FileNameParameters: name (str) – the output new name New in version NX9.0.0.
License requirements: nx_sinumerik_ca (“Sinumerik Collision Avoidance”)
ListOutput¶
-
SinumerikCaExportBuilder.ListOutput¶ Returns or sets the flag which determines if the output is printed to a listing window
-------------------------------------Getter Method
Signature
ListOutputReturns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ListOutputParameters: output (bool) – New in version NX9.0.0.
License requirements: nx_sinumerik_ca (“Sinumerik Collision Avoidance”)
ProtectionAreaElementIndex¶
-
SinumerikCaExportBuilder.ProtectionAreaElementIndex¶ Returns or sets the index used when exporting protection area elements to the SPF file
-------------------------------------Getter Method
Signature
ProtectionAreaElementIndexReturns: Return type: int New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ProtectionAreaElementIndexParameters: index (int) – New in version NX9.0.0.
License requirements: nx_sinumerik_ca (“Sinumerik Collision Avoidance”)
ProtectionAreaIndex¶
-
SinumerikCaExportBuilder.ProtectionAreaIndex¶ Returns or sets the index used when exporting protection areas to the SPF file
-------------------------------------Getter Method
Signature
ProtectionAreaIndexReturns: Return type: int New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ProtectionAreaIndexParameters: index (int) – New in version NX9.0.0.
License requirements: nx_sinumerik_ca (“Sinumerik Collision Avoidance”)
Method Detail¶
ExportSpf¶
-
SinumerikCaExportBuilder.ExportSpf¶ Export to Sinumerik Spf file
Signature
ExportSpf(targetNode)Parameters: targetNode (str) – The name of the node to export to New in version NX9.0.0.
License requirements: nx_sinumerik_ca (“Sinumerik Collision Avoidance”)
Validate¶
-
SinumerikCaExportBuilder.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.