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

ImportEplanPageMacroBuilder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateImportEplanPageMacroBuilder

Created in NX11.0.0. More...

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

Public Member Functions

NXString Description ()
 Returns the description
Created in NX11.0.0. More...
 
void ImportMacro (const std::vector< NXString > &segmentsOfResponseMessage)
 Imports an eplan page macro
Created in NX11.0.0. More...
 
NXString MacroFile ()
 Returns the eplan page macro template file
Created in NX11.0.0. More...
 
int MacroType ()
 Returns the macro type
Created in NX11.0.0. More...
 
NXString Name ()
 Returns the name
Created in NX11.0.0. More...
 
void ReadMacroInformation ()
 Read device properties
Created in NX12.0.0. More...
 
NXOpen::AME::SelectAMEBaseNodeSelectedAspectNode ()
 Returns the selected engineering object
Created in NX11.0.0. More...
 
void SetDescription (const NXString &description)
 Sets the description
Created in NX11.0.0. More...
 
void SetDescription (const char *description)
 Sets the description
Created in NX11.0.0. More...
 
void SetMacroFile (const NXString &macroFile)
 Sets the eplan page macro template file
Created in NX11.0.0. More...
 
void SetMacroFile (const char *macroFile)
 Sets the eplan page macro template file
Created in NX11.0.0. More...
 
void SetMacroType (int macroType)
 Sets the macro type
Created in NX11.0.0. More...
 
void SetName (const NXString &name)
 Sets the name
Created in NX11.0.0. More...
 
void SetName (const char *name)
 Sets the name
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

ImportEplanPageMacroBuilder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateImportEplanPageMacroBuilder

Created in NX11.0.0.


Member Function Documentation

NXString NXOpen::AME::ImportEplanPageMacroBuilder::Description ( )

Returns the description
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::ImportEplanPageMacroBuilder::ImportMacro ( const std::vector< NXString > &  segmentsOfResponseMessage)

Imports an eplan page macro
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
segmentsOfResponseMessagesegmentsofresponsemessage
NXString NXOpen::AME::ImportEplanPageMacroBuilder::MacroFile ( )

Returns the eplan page macro template file
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

int NXOpen::AME::ImportEplanPageMacroBuilder::MacroType ( )

Returns the macro type
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::ImportEplanPageMacroBuilder::Name ( )

Returns the name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::ImportEplanPageMacroBuilder::ReadMacroInformation ( )

Read device properties
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::SelectAMEBaseNode* NXOpen::AME::ImportEplanPageMacroBuilder::SelectedAspectNode ( )

Returns the selected engineering object
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::ImportEplanPageMacroBuilder::SetDescription ( const NXString description)

Sets the description
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
descriptiondescription
void NXOpen::AME::ImportEplanPageMacroBuilder::SetDescription ( const char *  description)

Sets the description
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
descriptiondescription
void NXOpen::AME::ImportEplanPageMacroBuilder::SetMacroFile ( const NXString macroFile)

Sets the eplan page macro template file
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
macroFilemacrofile
void NXOpen::AME::ImportEplanPageMacroBuilder::SetMacroFile ( const char *  macroFile)

Sets the eplan page macro template file
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
macroFilemacrofile
void NXOpen::AME::ImportEplanPageMacroBuilder::SetMacroType ( int  macroType)

Sets the macro type
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
macroTypemacrotype
void NXOpen::AME::ImportEplanPageMacroBuilder::SetName ( const NXString name)

Sets the name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
namename
void NXOpen::AME::ImportEplanPageMacroBuilder::SetName ( const char *  name)

Sets the name
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
namename

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