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:

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	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	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...

std::vector < NXOpen::AME::AMEBaseNode * >	ImportPlcStations (const std::vector< NXString > &stationNames)
	Import plc station. More...

NXOpen::AME::AMEBaseNode *	ImportStation (const NXString &stationId)
	Import station. More...

NXOpen::AME::AMEBaseNode *	ImportStation (const char *stationId)
	Import station. More...

void	ImportSwBlocks (const std::vector< NXString > &swBlockIds, bool isOnline)
	Import sw blocks Created in NX12.0.0. More...

NXOpen::AME::SelectAMEBaseNode *	SelectionTarget ()
	Returns the selected engineering object Created in NX11.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	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...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	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::NXObject *	GetObject ()
	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::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::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

stationName stationname

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

stationName stationname

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

Import plc station.

Returns: Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

stationNames stationnames

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

Import station.

Returns: Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

stationId stationid

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

Import station.

Returns: Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

stationId stationid

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

swBlockIds	swblockids
isOnline	isonline

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")

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

stationName stationname

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

stationName stationname

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

swBlockName swblockname

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

swBlockName swblockname

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

projectName projectname

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

projectName projectname

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

projectPath projectpath

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

projectPath projectpath

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

projectXmlParts projectxmlparts

The documentation for this class was generated from the following file:

AME_ImportHWXmlBuilder.hxx

Public Member Functions

Detailed Description

Member Function Documentation