ImportHWXmlBuilder Class¶
-
class
NXOpen.AME.
ImportHWXmlBuilder
¶ Bases:
NXOpen.Builder
the Import HW Xml builder
To create a new instance of this class, use
NXOpen.AME.AMEManager.CreateImportHwxmlBuilder()
New in version NX11.0.0.
Properties¶
Property | Description |
---|---|
CurrentlySelectedSWBlockItemName | Returns or sets the currently selected TIA software block item name |
CurrentlySelectedStationItemName | Returns or sets the currently selected TIA station item name |
CurrentlySelectedTiaProjectName | Returns or sets the currently selected TIA project item name |
CurrentlySelectedTiaProjectPath | Returns or sets the currently selected TIA project item path |
SelectionTarget | Returns the selected engineering object |
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. |
GetStationList | Import Tia project with option get station list |
GetStationPreview | Import Tia project with option get station preview |
ImportPlcStations | Import plc station |
ImportStation | Import station |
ImportSwBlocks | Import sw blocks |
SetProjectXml | Set project xml |
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¶
CurrentlySelectedSWBlockItemName¶
-
ImportHWXmlBuilder.
CurrentlySelectedSWBlockItemName
¶ Returns or sets the currently selected TIA software block item name
-------------------------------------
Getter Method
Signature
CurrentlySelectedSWBlockItemName
Returns: Return type: str New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
CurrentlySelectedSWBlockItemName
Parameters: swBlockName (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
CurrentlySelectedStationItemName¶
-
ImportHWXmlBuilder.
CurrentlySelectedStationItemName
¶ Returns or sets the currently selected TIA station item name
-------------------------------------
Getter Method
Signature
CurrentlySelectedStationItemName
Returns: Return type: str New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
CurrentlySelectedStationItemName
Parameters: stationName (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
CurrentlySelectedTiaProjectName¶
-
ImportHWXmlBuilder.
CurrentlySelectedTiaProjectName
¶ Returns or sets the currently selected TIA project item name
-------------------------------------
Getter Method
Signature
CurrentlySelectedTiaProjectName
Returns: Return type: str New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
CurrentlySelectedTiaProjectName
Parameters: projectName (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
CurrentlySelectedTiaProjectPath¶
-
ImportHWXmlBuilder.
CurrentlySelectedTiaProjectPath
¶ Returns or sets the currently selected TIA project item path
-------------------------------------
Getter Method
Signature
CurrentlySelectedTiaProjectPath
Returns: Return type: str New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
CurrentlySelectedTiaProjectPath
Parameters: projectPath (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SelectionTarget¶
-
ImportHWXmlBuilder.
SelectionTarget
¶ Returns the selected engineering object
-------------------------------------
Getter Method
Signature
SelectionTarget
Returns: Return type: NXOpen.AME.SelectAMEBaseNode
New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Method Detail¶
GetStationList¶
-
ImportHWXmlBuilder.
GetStationList
¶ Import Tia project with option get station list
Signature
GetStationList()
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
GetStationPreview¶
-
ImportHWXmlBuilder.
GetStationPreview
¶ Import Tia project with option get station preview
Signature
GetStationPreview(stationName)
Parameters: stationName (str) – New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
ImportPlcStations¶
-
ImportHWXmlBuilder.
ImportPlcStations
¶ Import plc station
Signature
ImportPlcStations(stationNames)
Parameters: stationNames (list of str) – Returns: Return type: list of NXOpen.AME.AMEBaseNode
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
ImportStation¶
-
ImportHWXmlBuilder.
ImportStation
¶ Import station
Signature
ImportStation(stationId)
Parameters: stationId (str) – Returns: Return type: NXOpen.AME.AMEBaseNode
New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
ImportSwBlocks¶
-
ImportHWXmlBuilder.
ImportSwBlocks
¶ Import sw blocks
Signature
ImportSwBlocks(swBlockIds, isOnline)
Parameters: - swBlockIds (list of str) –
- isOnline (bool) –
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SetProjectXml¶
-
ImportHWXmlBuilder.
SetProjectXml
¶ Set project xml
Signature
SetProjectXml(projectXmlParts)
Parameters: projectXmlParts (list of str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Validate¶
-
ImportHWXmlBuilder.
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.