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

the eplan project generation dialog builder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateEplanProjectGenerationBuilder
Default values. More...

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

Public Member Functions

void GenerateEplanProject ()
 Generate EPLAN project
Created in NX12.0.0. More...
 
NXString ProjectName ()
 Returns the project name
Created in NX11.0.0. More...
 
void SetProjectName (const NXString &projectName)
 Sets the project name
Created in NX11.0.0. More...
 
void SetProjectName (const char *projectName)
 Sets the project name
Created in NX11.0.0. More...
 
void SetTargetPathFolderBrowser (const NXString &filename)
 Sets the generation target folder path
Created in NX11.0.0. More...
 
void SetTargetPathFolderBrowser (const char *filename)
 Sets the generation target folder path
Created in NX11.0.0. More...
 
void SetToggleOpenInEplan (bool toggleOpenInEplan)
 Sets the toggle whether to open EPLAN project after generation
Created in NX11.0.0. More...
 
void SetToggleOverwrite (bool toggleOverwrite)
 Sets the toggle whether to overwrite existing EPLAN project
Created in NX11.0.0. More...
 
void SetToggleSaveNameChanges (bool toggleSaveNameChanges)
 Sets the toggle whether to save the project name changes to EPLAN project settings
Created in NX11.0.0. More...
 
void SetToggleSavePathChanges (bool toggleSavePathChanges)
 Sets the toggle whether to save the target path changes to EPLAN project settings
Created in NX11.0.0. More...
 
NXString TargetPathFolderBrowser ()
 Returns the generation target folder path
Created in NX11.0.0. More...
 
bool ToggleOpenInEplan ()
 Returns the toggle whether to open EPLAN project after generation
Created in NX11.0.0. More...
 
bool ToggleOverwrite ()
 Returns the toggle whether to overwrite existing EPLAN project
Created in NX11.0.0. More...
 
bool ToggleSaveNameChanges ()
 Returns the toggle whether to save the project name changes to EPLAN project settings
Created in NX11.0.0. More...
 
bool ToggleSavePathChanges ()
 Returns the toggle whether to save the target path changes to EPLAN project settings
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 eplan project generation dialog builder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateEplanProjectGenerationBuilder
Default values.

Property Value

ToggleOpenInEplan

0

ToggleOverwrite

0

ToggleSaveNameChanges

0

ToggleSavePathChanges

0


Created in NX11.0.0.

Member Function Documentation

void NXOpen::AME::EplanProjectGenerationBuilder::GenerateEplanProject ( )

Generate EPLAN project
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::EplanProjectGenerationBuilder::ProjectName ( )

Returns the project name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::EplanProjectGenerationBuilder::SetProjectName ( const NXString projectName)

Sets the project name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
projectNameprojectname
void NXOpen::AME::EplanProjectGenerationBuilder::SetProjectName ( const char *  projectName)

Sets the project name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
projectNameprojectname
void NXOpen::AME::EplanProjectGenerationBuilder::SetTargetPathFolderBrowser ( const NXString filename)

Sets the generation target folder path
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
filenamefilename
void NXOpen::AME::EplanProjectGenerationBuilder::SetTargetPathFolderBrowser ( const char *  filename)

Sets the generation target folder path
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
filenamefilename
void NXOpen::AME::EplanProjectGenerationBuilder::SetToggleOpenInEplan ( bool  toggleOpenInEplan)

Sets the toggle whether to open EPLAN project after generation
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
toggleOpenInEplantoggleopenineplan
void NXOpen::AME::EplanProjectGenerationBuilder::SetToggleOverwrite ( bool  toggleOverwrite)

Sets the toggle whether to overwrite existing EPLAN project
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
toggleOverwritetoggleoverwrite
void NXOpen::AME::EplanProjectGenerationBuilder::SetToggleSaveNameChanges ( bool  toggleSaveNameChanges)

Sets the toggle whether to save the project name changes to EPLAN project settings
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
toggleSaveNameChangestogglesavenamechanges
void NXOpen::AME::EplanProjectGenerationBuilder::SetToggleSavePathChanges ( bool  toggleSavePathChanges)

Sets the toggle whether to save the target path changes to EPLAN project settings
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
toggleSavePathChangestogglesavepathchanges
NXString NXOpen::AME::EplanProjectGenerationBuilder::TargetPathFolderBrowser ( )

Returns the generation target folder path
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

bool NXOpen::AME::EplanProjectGenerationBuilder::ToggleOpenInEplan ( )

Returns the toggle whether to open EPLAN project after generation
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

bool NXOpen::AME::EplanProjectGenerationBuilder::ToggleOverwrite ( )

Returns the toggle whether to overwrite existing EPLAN project
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

bool NXOpen::AME::EplanProjectGenerationBuilder::ToggleSaveNameChanges ( )

Returns the toggle whether to save the project name changes to EPLAN project settings
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

bool NXOpen::AME::EplanProjectGenerationBuilder::ToggleSavePathChanges ( )

Returns the toggle whether to save the target path changes to EPLAN project settings
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")


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