NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
NXOpen::AME::ImportHWXmlBuilder Class Reference

the Import HW Xml builder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateImportHwxmlBuilder

Created in NX11.0.0. More...

Inheritance diagram for NXOpen::AME::ImportHWXmlBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXString CurrentlySelectedStationItemName ()
 Returns the currently selected TIA station item name
Created in NX11.0.0. More...
 
NXString CurrentlySelectedSWBlockItemName ()
 Returns the currently selected TIA software block item name
Created in NX11.0.0. More...
 
NXString CurrentlySelectedTiaLibraryName ()
 Returns the currently selected TIA library item name
Created in NX1847.0.0. More...
 
NXString CurrentlySelectedTiaLibraryPath ()
 Returns the currently selected TIA library item path
Created in NX1847.0.0. More...
 
NXString CurrentlySelectedTiaProjectName ()
 Returns the currently selected TIA project item name
Created in NX11.0.0. More...
 
NXString CurrentlySelectedTiaProjectPath ()
 Returns the currently selected TIA project item path
Created in NX11.0.0. More...
 
void GetLibraryPreview ()
 Get library preview
Created in NX1847.0.0. More...
 
void GetStationList ()
 Import Tia project with option get station list
Created in NX12.0.0. More...
 
void GetStationPreview (const NXString &stationName)
 Import Tia project with option get station preview
Created in NX12.0.0. More...
 
void GetStationPreview (const char *stationName)
 Import Tia project with option get station preview
Created in NX12.0.0. More...
 
void ImportHwLibraryMasterCopies (const std::vector< NXString > &masterCopyIds)
 Import master copy from hardware library
Created in NX1847.0.0. More...
 
std::vector
< NXOpen::AME::AMEBaseNode * > 
ImportPlcStations (const std::vector< NXString > &stationNames)
 Import plc station
Created in NX12.0.0. More...
 
NXOpen::AME::AMEBaseNodeImportStation (const NXString &stationId)
 Import station
Created in NX11.0.0. More...
 
NXOpen::AME::AMEBaseNodeImportStation (const char *stationId)
 Import station
Created in NX11.0.0. More...
 
void ImportSwBlocks (const std::vector< NXString > &swBlockIds, bool isOnline)
 Import sw blocks
Created in NX12.0.0. More...
 
void ImportSwLibraryTypes (const std::vector< NXString > &swTypeIds)
 Import sw blocks and UDTs from TIA library
Created in NX1847.0.0. More...
 
NXOpen::AME::SelectAMEBaseNodeSelectionTarget ()
 Returns the selected engineering object
Created in NX11.0.0. More...
 
NXOpen::AME::SelectionBaseDefinitionBuilderSelectLibraryObject ()
 Returns the engineering object definition or product definition
Created in NX1847.0.0. More...
 
void SetCurrentlySelectedStationItemName (const NXString &stationName)
 Sets the currently selected TIA station item name
Created in NX11.0.0. More...
 
void SetCurrentlySelectedStationItemName (const char *stationName)
 Sets the currently selected TIA station item name
Created in NX11.0.0. More...
 
void SetCurrentlySelectedSWBlockItemName (const NXString &swBlockName)
 Sets the currently selected TIA software block item name
Created in NX11.0.0. More...
 
void SetCurrentlySelectedSWBlockItemName (const char *swBlockName)
 Sets the currently selected TIA software block item name
Created in NX11.0.0. More...
 
void SetCurrentlySelectedTiaLibraryName (const NXString &libraryName)
 Sets the currently selected TIA library item name
Created in NX1847.0.0. More...
 
void SetCurrentlySelectedTiaLibraryName (const char *libraryName)
 Sets the currently selected TIA library item name
Created in NX1847.0.0. More...
 
void SetCurrentlySelectedTiaLibraryPath (const NXString &libraryPath)
 Sets the currently selected TIA library item path
Created in NX1847.0.0. More...
 
void SetCurrentlySelectedTiaLibraryPath (const char *libraryPath)
 Sets the currently selected TIA library item path
Created in NX1847.0.0. More...
 
void SetCurrentlySelectedTiaProjectName (const NXString &projectName)
 Sets the currently selected TIA project item name
Created in NX11.0.0. More...
 
void SetCurrentlySelectedTiaProjectName (const char *projectName)
 Sets the currently selected TIA project item name
Created in NX11.0.0. More...
 
void SetCurrentlySelectedTiaProjectPath (const NXString &projectPath)
 Sets the currently selected TIA project item path
Created in NX11.0.0. More...
 
void SetCurrentlySelectedTiaProjectPath (const char *projectPath)
 Sets the currently selected TIA project item path
Created in NX11.0.0. More...
 
void SetProjectXml (const std::vector< NXString > &projectXmlParts)
 Set project xml
Created in NX11.0.0. More...
 
void SetTiaPortalVersion (const NXString &tiaPortalVersion)
 The Tia Portal Version
Created in NX1847.0.0. More...
 
void SetTiaPortalVersion (const char *tiaPortalVersion)
 The Tia Portal Version
Created in NX1847.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. 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

NXString NXOpen::AME::ImportHWXmlBuilder::CurrentlySelectedStationItemName ( )

Returns the currently selected TIA station item name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::ImportHWXmlBuilder::CurrentlySelectedSWBlockItemName ( )

Returns the currently selected TIA software block item name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::ImportHWXmlBuilder::CurrentlySelectedTiaLibraryName ( )

Returns the currently selected TIA library item name
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::ImportHWXmlBuilder::CurrentlySelectedTiaLibraryPath ( )

Returns the currently selected TIA library item path
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::ImportHWXmlBuilder::CurrentlySelectedTiaProjectName ( )

Returns the currently selected TIA project item name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::ImportHWXmlBuilder::CurrentlySelectedTiaProjectPath ( )

Returns the currently selected TIA project item path
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::ImportHWXmlBuilder::GetLibraryPreview ( )

Get library preview
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::ImportHWXmlBuilder::GetStationList ( )

Import Tia project with option get station list
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::ImportHWXmlBuilder::GetStationPreview ( const NXString stationName)

Import Tia project with option get station preview
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
stationNamestationname
void NXOpen::AME::ImportHWXmlBuilder::GetStationPreview ( const char *  stationName)

Import Tia project with option get station preview
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
stationNamestationname
void NXOpen::AME::ImportHWXmlBuilder::ImportHwLibraryMasterCopies ( const std::vector< NXString > &  masterCopyIds)

Import master copy from hardware library
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
masterCopyIdsmastercopyids
std::vector<NXOpen::AME::AMEBaseNode *> NXOpen::AME::ImportHWXmlBuilder::ImportPlcStations ( const std::vector< NXString > &  stationNames)

Import plc station
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
stationNamesstationnames
NXOpen::AME::AMEBaseNode* NXOpen::AME::ImportHWXmlBuilder::ImportStation ( const NXString stationId)

Import station
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
stationIdstationid
NXOpen::AME::AMEBaseNode* NXOpen::AME::ImportHWXmlBuilder::ImportStation ( const char *  stationId)

Import station
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
stationIdstationid
void NXOpen::AME::ImportHWXmlBuilder::ImportSwBlocks ( const std::vector< NXString > &  swBlockIds,
bool  isOnline 
)

Import sw blocks
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
swBlockIdsswblockids
isOnlineisonline
void NXOpen::AME::ImportHWXmlBuilder::ImportSwLibraryTypes ( const std::vector< NXString > &  swTypeIds)

Import sw blocks and UDTs from TIA library
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
swTypeIdsswtypeids
NXOpen::AME::SelectAMEBaseNode* NXOpen::AME::ImportHWXmlBuilder::SelectionTarget ( )

Returns the selected engineering object
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::SelectionBaseDefinitionBuilder* NXOpen::AME::ImportHWXmlBuilder::SelectLibraryObject ( )

Returns the engineering object definition or product definition
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::ImportHWXmlBuilder::SetCurrentlySelectedStationItemName ( const NXString stationName)

Sets the currently selected TIA station item name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
stationNamestationname
void NXOpen::AME::ImportHWXmlBuilder::SetCurrentlySelectedStationItemName ( const char *  stationName)

Sets the currently selected TIA station item name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
stationNamestationname
void NXOpen::AME::ImportHWXmlBuilder::SetCurrentlySelectedSWBlockItemName ( const NXString swBlockName)

Sets the currently selected TIA software block item name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
swBlockNameswblockname
void NXOpen::AME::ImportHWXmlBuilder::SetCurrentlySelectedSWBlockItemName ( const char *  swBlockName)

Sets the currently selected TIA software block item name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
swBlockNameswblockname
void NXOpen::AME::ImportHWXmlBuilder::SetCurrentlySelectedTiaLibraryName ( const NXString libraryName)

Sets the currently selected TIA library item name
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
libraryNamelibraryname
void NXOpen::AME::ImportHWXmlBuilder::SetCurrentlySelectedTiaLibraryName ( const char *  libraryName)

Sets the currently selected TIA library item name
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
libraryNamelibraryname
void NXOpen::AME::ImportHWXmlBuilder::SetCurrentlySelectedTiaLibraryPath ( const NXString libraryPath)

Sets the currently selected TIA library item path
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
libraryPathlibrarypath
void NXOpen::AME::ImportHWXmlBuilder::SetCurrentlySelectedTiaLibraryPath ( const char *  libraryPath)

Sets the currently selected TIA library item path
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
libraryPathlibrarypath
void NXOpen::AME::ImportHWXmlBuilder::SetCurrentlySelectedTiaProjectName ( const NXString projectName)

Sets the currently selected TIA project item name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
projectNameprojectname
void NXOpen::AME::ImportHWXmlBuilder::SetCurrentlySelectedTiaProjectName ( const char *  projectName)

Sets the currently selected TIA project item name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
projectNameprojectname
void NXOpen::AME::ImportHWXmlBuilder::SetCurrentlySelectedTiaProjectPath ( const NXString projectPath)

Sets the currently selected TIA project item path
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
projectPathprojectpath
void NXOpen::AME::ImportHWXmlBuilder::SetCurrentlySelectedTiaProjectPath ( const char *  projectPath)

Sets the currently selected TIA project item path
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
projectPathprojectpath
void NXOpen::AME::ImportHWXmlBuilder::SetProjectXml ( const std::vector< NXString > &  projectXmlParts)

Set project xml
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
projectXmlPartsprojectxmlparts
void NXOpen::AME::ImportHWXmlBuilder::SetTiaPortalVersion ( const NXString tiaPortalVersion)

The Tia Portal Version
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
tiaPortalVersiontiaportalversion
void NXOpen::AME::ImportHWXmlBuilder::SetTiaPortalVersion ( const char *  tiaPortalVersion)

The Tia Portal Version
Created in NX1847.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
tiaPortalVersiontiaportalversion

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