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

Represents a method used in the software blocks
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateMethodBuilder
Default values. More...

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

Public Member Functions

void AddCompileUnitIndex (int compileUnitStartIndex, int compileUnitEndIndex)
 Add a index of network that will be in a method with this function is possible to add several network
Created in NX12.0.0. More...
 
void AddStatementIndexes (int compileUnitIndex, int startStatementIndex, int endStatementIndex)
 Add a index of start statment in a network and index of end of statment
Created in NX12.0.0. More...
 
NXString Description ()
 Returns the string description
Created in NX12.0.0. More...
 
bool InsertMethodAuto ()
 Returns the method automatically insertion
Created in NX12.0.0. More...
 
NXString MethodName ()
 Returns the string method name
Created in NX12.0.0. More...
 
NXOpen::AME::SelectAMEBaseNodeListSelectedObjects ()
 Returns the select object
Created in NX12.0.0. More...
 
void SetDescription (const NXString &description)
 Sets the string description
Created in NX12.0.0. More...
 
void SetDescription (const char *description)
 Sets the string description
Created in NX12.0.0. More...
 
void SetInsertMethodAuto (bool insertMethodAuto)
 Sets the method automatically insertion
Created in NX12.0.0. More...
 
void SetMethodName (const NXString &methodName)
 Sets the string method name
Created in NX12.0.0. More...
 
void SetMethodName (const char *methodName)
 Sets the string method name
Created in NX12.0.0. More...
 
void SetPlcCodeBlock (NXOpen::AME::PlcBlock *plcBlock)
 Set selected PlcCodeBlock
Created in NX12.0.0. More...
 
void SetShowInAutomation (bool showInAutomation)
 Sets the show in automation
Created in NX12.0.0. More...
 
void SetShowInFunction (bool showInFunction)
 Sets the show in function
Created in NX12.0.0. More...
 
void SetShowInLocation (bool showInLocation)
 Sets the show in location
Created in NX12.0.0. More...
 
void SetShowInProduct (bool showInProduct)
 Sets the show in product
Created in NX12.0.0. More...
 
bool ShowInAutomation ()
 Returns the show in automation
Created in NX12.0.0. More...
 
bool ShowInFunction ()
 Returns the show in function
Created in NX12.0.0. More...
 
bool ShowInLocation ()
 Returns the show in location
Created in NX12.0.0. More...
 
bool ShowInProduct ()
 Returns the show in product
Created in NX12.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

Represents a method used in the software blocks
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateMethodBuilder
Default values.

Property Value

ShowInAutomation

false

ShowInFunction

false

ShowInLocation

false

ShowInProduct

false


Created in NX12.0.0.

Member Function Documentation

void NXOpen::AME::CreateMethodBuilder::AddCompileUnitIndex ( int  compileUnitStartIndex,
int  compileUnitEndIndex 
)

Add a index of network that will be in a method with this function is possible to add several network
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
compileUnitStartIndexcompileunitstartindex
compileUnitEndIndexcompileunitendindex
void NXOpen::AME::CreateMethodBuilder::AddStatementIndexes ( int  compileUnitIndex,
int  startStatementIndex,
int  endStatementIndex 
)

Add a index of start statment in a network and index of end of statment
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
compileUnitIndexcompileunitindex
startStatementIndexstartstatementindex
endStatementIndexendstatementindex
NXString NXOpen::AME::CreateMethodBuilder::Description ( )

Returns the string description
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

bool NXOpen::AME::CreateMethodBuilder::InsertMethodAuto ( )

Returns the method automatically insertion
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::CreateMethodBuilder::MethodName ( )

Returns the string method name
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::SelectAMEBaseNodeList* NXOpen::AME::CreateMethodBuilder::SelectedObjects ( )

Returns the select object
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

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

Sets the string description
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

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

Sets the string description
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
descriptiondescription
void NXOpen::AME::CreateMethodBuilder::SetInsertMethodAuto ( bool  insertMethodAuto)

Sets the method automatically insertion
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
insertMethodAutoinsertmethodauto
void NXOpen::AME::CreateMethodBuilder::SetMethodName ( const NXString methodName)

Sets the string method name
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
methodNamemethodname
void NXOpen::AME::CreateMethodBuilder::SetMethodName ( const char *  methodName)

Sets the string method name
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
methodNamemethodname
void NXOpen::AME::CreateMethodBuilder::SetPlcCodeBlock ( NXOpen::AME::PlcBlock plcBlock)

Set selected PlcCodeBlock
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
plcBlockplcblock
void NXOpen::AME::CreateMethodBuilder::SetShowInAutomation ( bool  showInAutomation)

Sets the show in automation
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
showInAutomationshowinautomation
void NXOpen::AME::CreateMethodBuilder::SetShowInFunction ( bool  showInFunction)

Sets the show in function
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
showInFunctionshowinfunction
void NXOpen::AME::CreateMethodBuilder::SetShowInLocation ( bool  showInLocation)

Sets the show in location
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
showInLocationshowinlocation
void NXOpen::AME::CreateMethodBuilder::SetShowInProduct ( bool  showInProduct)

Sets the show in product
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
showInProductshowinproduct
bool NXOpen::AME::CreateMethodBuilder::ShowInAutomation ( )

Returns the show in automation
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

bool NXOpen::AME::CreateMethodBuilder::ShowInFunction ( )

Returns the show in function
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

bool NXOpen::AME::CreateMethodBuilder::ShowInLocation ( )

Returns the show in location
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

bool NXOpen::AME::CreateMethodBuilder::ShowInProduct ( )

Returns the show in product
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")


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