NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Properties | List of all members
NXOpen.AME.ImportHWXmlBuilder Class Reference

the Import HW Xml builder More...

Inheritance diagram for NXOpen.AME.ImportHWXmlBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Member Functions

unsafe void GetLibraryPreview ()
 Get library preview More...
 
unsafe void GetStationList ()
 Import Tia project with option get station list More...
 
unsafe void GetStationPreview (string stationName)
 Import Tia project with option get station preview More...
 
unsafe void ImportHwLibraryMasterCopies (string[] masterCopyIds)
 Import master copy from hardware library More...
 
unsafe NXOpen.AME.AMEBaseNode[] ImportPlcStations (string[] stationNames)
 Import plc station More...
 
unsafe NXOpen.AME.AMEBaseNode ImportStation (string stationId)
 Import station More...
 
unsafe void ImportSwBlocks (string[] swBlockIds, bool isOnline)
 Import sw blocks More...
 
unsafe void ImportSwLibraryTypes (string[] swTypeIds)
 Import sw blocks and UDTs from TIA library More...
 
unsafe void ReimportSingleSwBlock (string nameOfMainBlockToImport, string[] namesOfSubBlocksToImport, NXOpen.AME.PlcBlock blockToUpdate, bool isOnline)
 Reimport a single sw block More...
 
unsafe void ReimportSingleSwLibraryType (string swTypeId, string swTypeVersionId, NXOpen.AME.PlcBlock blockToUpdate)
 Reimport a single sw block from a TIA Portal Global Library More...
 
unsafe void SetProjectXml (string[] projectXmlParts)
 Set project xml More...
 
unsafe void SetTiaPortalVersion (string tiaPortalVersion)
 The Tia Portal Version More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe string CurrentlySelectedStationItemName [get, set]
 Returns or sets the currently selected TIA station item name More...
 
unsafe string CurrentlySelectedSWBlockItemName [get, set]
 Returns or sets the currently selected TIA software block item name More...
 
unsafe string CurrentlySelectedTiaLibraryName [get, set]
 Returns or sets the currently selected TIA library item name More...
 
unsafe string CurrentlySelectedTiaLibraryPath [get, set]
 Returns or sets the currently selected TIA library item path More...
 
unsafe string CurrentlySelectedTiaProjectName [get, set]
 Returns or sets the currently selected TIA project item name More...
 
unsafe string CurrentlySelectedTiaProjectPath [get, set]
 Returns or sets the currently selected TIA project item path More...
 
unsafe NXOpen.AME.SelectAMEBaseNode SelectionTarget [get]
 Returns the selected engineering object More...
 
unsafe
NXOpen.AME.SelectionBaseDefinitionBuilder 
SelectLibraryObject [get]
 Returns the engineering object definition or product definition More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

the Import HW Xml builder

To create a new instance of this class, use NXOpen.AME.AMEManager.CreateImportHwxmlBuilder

Created in NX11.0.0

Member Function Documentation

unsafe void NXOpen.AME.ImportHWXmlBuilder.GetLibraryPreview ( )
inline

Get library preview

Created in NX1847.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe void NXOpen.AME.ImportHWXmlBuilder.GetStationList ( )
inline

Import Tia project with option get station list

Created in NX12.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe void NXOpen.AME.ImportHWXmlBuilder.GetStationPreview ( string  stationName)
inline

Import Tia project with option get station preview

Created in NX12.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
stationName
unsafe void NXOpen.AME.ImportHWXmlBuilder.ImportHwLibraryMasterCopies ( string[]  masterCopyIds)
inline

Import master copy from hardware library

Created in NX1847.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
masterCopyIds
unsafe NXOpen.AME.AMEBaseNode [] NXOpen.AME.ImportHWXmlBuilder.ImportPlcStations ( string[]  stationNames)
inline

Import plc station

Created in NX12.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
stationNames
Returns
unsafe NXOpen.AME.AMEBaseNode NXOpen.AME.ImportHWXmlBuilder.ImportStation ( string  stationId)
inline

Import station

Created in NX11.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
stationId
Returns
unsafe void NXOpen.AME.ImportHWXmlBuilder.ImportSwBlocks ( string[]  swBlockIds,
bool  isOnline 
)
inline

Import sw blocks

Created in NX12.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
swBlockIds
isOnline
unsafe void NXOpen.AME.ImportHWXmlBuilder.ImportSwLibraryTypes ( string[]  swTypeIds)
inline

Import sw blocks and UDTs from TIA library

Created in NX1847.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
swTypeIds
unsafe void NXOpen.AME.ImportHWXmlBuilder.ReimportSingleSwBlock ( string  nameOfMainBlockToImport,
string[]  namesOfSubBlocksToImport,
NXOpen.AME.PlcBlock  blockToUpdate,
bool  isOnline 
)
inline

Reimport a single sw block

Created in NX1872.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
nameOfMainBlockToImport
namesOfSubBlocksToImport
blockToUpdate
isOnline
unsafe void NXOpen.AME.ImportHWXmlBuilder.ReimportSingleSwLibraryType ( string  swTypeId,
string  swTypeVersionId,
NXOpen.AME.PlcBlock  blockToUpdate 
)
inline

Reimport a single sw block from a TIA Portal Global Library

Created in NX1872.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
swTypeId
swTypeVersionId
blockToUpdate
unsafe void NXOpen.AME.ImportHWXmlBuilder.SetProjectXml ( string[]  projectXmlParts)
inline

Set project xml

Created in NX11.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
projectXmlParts
unsafe void NXOpen.AME.ImportHWXmlBuilder.SetTiaPortalVersion ( string  tiaPortalVersion)
inline

The Tia Portal Version

Created in NX1847.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
tiaPortalVersion

Property Documentation

unsafe string NXOpen.AME.ImportHWXmlBuilder.CurrentlySelectedStationItemName
getset

Returns or sets the currently selected TIA station item name

Created in NX11.0.0

License requirements to get this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

License requirements to set this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe string NXOpen.AME.ImportHWXmlBuilder.CurrentlySelectedSWBlockItemName
getset

Returns or sets the currently selected TIA software block item name

Created in NX11.0.0

License requirements to get this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

License requirements to set this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe string NXOpen.AME.ImportHWXmlBuilder.CurrentlySelectedTiaLibraryName
getset

Returns or sets the currently selected TIA library item name

Created in NX1847.0.0

License requirements to get this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

License requirements to set this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe string NXOpen.AME.ImportHWXmlBuilder.CurrentlySelectedTiaLibraryPath
getset

Returns or sets the currently selected TIA library item path

Created in NX1847.0.0

License requirements to get this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

License requirements to set this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe string NXOpen.AME.ImportHWXmlBuilder.CurrentlySelectedTiaProjectName
getset

Returns or sets the currently selected TIA project item name

Created in NX11.0.0

License requirements to get this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

License requirements to set this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe string NXOpen.AME.ImportHWXmlBuilder.CurrentlySelectedTiaProjectPath
getset

Returns or sets the currently selected TIA project item path

Created in NX11.0.0

License requirements to get this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

License requirements to set this property: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe NXOpen.AME.SelectAMEBaseNode NXOpen.AME.ImportHWXmlBuilder.SelectionTarget
get

Returns the selected engineering object

Created in NX11.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe NXOpen.AME.SelectionBaseDefinitionBuilder NXOpen.AME.ImportHWXmlBuilder.SelectLibraryObject
get

Returns the engineering object definition or product definition

Created in NX1847.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.