NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::AME::TiaProjectItemBuilder Class Reference

the TIA project item builder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateTiaprojectItemBuilder

Created in NX11.0.0. More...

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

Public Member Functions

NXString FullPath ()
 Returns the project item full path (project folder path plus project file name with extension)
Created in NX11.0.0. More...
 
NXString Name ()
 Returns the project item name
Created in NX11.0.0. More...
 
NXString Path ()
 Returns the project item path
Created in NX11.0.0. More...
 
void SetFullPath (const NXString &projectFullPath)
 Sets the project item full path (project folder path plus project file name with extension)
Created in NX11.0.0. More...
 
void SetFullPath (const char *projectFullPath)
 Sets the project item full path (project folder path plus project file name with extension)
Created in NX11.0.0. More...
 
void SetName (const NXString &projectName)
 Sets the project item name
Created in NX11.0.0. More...
 
void SetName (const char *projectName)
 Sets the project item name
Created in NX11.0.0. More...
 
void SetPath (const NXString &projectPath)
 Sets the project item path
Created in NX11.0.0. More...
 
void SetPath (const char *projectPath)
 Sets the project item path
Created in NX11.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 TIA project item builder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateTiaprojectItemBuilder

Created in NX11.0.0.


Member Function Documentation

NXString NXOpen::AME::TiaProjectItemBuilder::FullPath ( )

Returns the project item full path (project folder path plus project file name with extension)
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::TiaProjectItemBuilder::Name ( )

Returns the project item name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::TiaProjectItemBuilder::Path ( )

Returns the project item path
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::TiaProjectItemBuilder::SetFullPath ( const NXString projectFullPath)

Sets the project item full path (project folder path plus project file name with extension)
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
projectFullPathprojectfullpath
void NXOpen::AME::TiaProjectItemBuilder::SetFullPath ( const char *  projectFullPath)

Sets the project item full path (project folder path plus project file name with extension)
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
projectFullPathprojectfullpath
void NXOpen::AME::TiaProjectItemBuilder::SetName ( const NXString projectName)

Sets the project item name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
projectNameprojectname
void NXOpen::AME::TiaProjectItemBuilder::SetName ( const char *  projectName)

Sets the project item name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
projectNameprojectname
void NXOpen::AME::TiaProjectItemBuilder::SetPath ( const NXString projectPath)

Sets the project item path
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
projectPathprojectpath
void NXOpen::AME::TiaProjectItemBuilder::SetPath ( const char *  projectPath)

Sets the project item path
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
projectPathprojectpath

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