SCOUTExportBuilder Class¶
-
class
NXOpen.Mechatronics.
SCOUTExportBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Mechatronics.SCOUTExportBuilder
To create a new instance of this class, use
NXOpen.Mechatronics.PhysicsManager.CreateSCOUTExportBuilder()
New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
ExportFile | Returns or sets the export file name |
ExportFileFormat | Returns or sets the export file format. |
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. |
ExportToPointXyValue | Write elements to Generic XY point. |
ExportToScout | Write elements to SCOUT 44. |
ExportToScoutWithFormula | Write elements to SCOUT with more traverses type. |
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. |
Enumerations¶
SCOUTExportBuilderExportFileType Enumeration | Represents the export file type. |
Property Detail¶
ExportFile¶
-
SCOUTExportBuilder.
ExportFile
¶ Returns or sets the export file name
-------------------------------------
Getter Method
Signature
ExportFile
Returns: Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ExportFile
Parameters: exportFile (str) – New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
ExportFileFormat¶
-
SCOUTExportBuilder.
ExportFileFormat
¶ Returns or sets the export file format.
-------------------------------------
Getter Method
Signature
ExportFileFormat
Returns: Return type: NXOpen.Mechatronics.SCOUTExportBuilderExportFileType
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ExportFileFormat
Parameters: exportFileFormat ( NXOpen.Mechatronics.SCOUTExportBuilderExportFileType
) –New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Method Detail¶
ExportToPointXyValue¶
-
SCOUTExportBuilder.
ExportToPointXyValue
¶ Write elements to Generic XY point.
Signature
ExportToPointXyValue(camProfile)
Parameters: camProfile ( NXOpen.Mechatronics.CamProfileBuilder
) – Cam Profile BuilderNew in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
ExportToScout¶
-
SCOUTExportBuilder.
ExportToScout
¶ Write elements to SCOUT 44.
Signature
ExportToScout(camProfile)
Parameters: camProfile ( NXOpen.Builder
) – Cam Profile BuilderNew in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
ExportToScoutWithFormula¶
-
SCOUTExportBuilder.
ExportToScoutWithFormula
¶ Write elements to SCOUT with more traverses type.
Signature
ExportToScoutWithFormula(camProfile)
Parameters: camProfile ( NXOpen.Mechatronics.CamProfileBuilder
) – Cam Profile BuilderNew in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Validate¶
-
SCOUTExportBuilder.
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.