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

OperatorRule Dialog
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateOperatorRuleBuilder

Created in NX12.0.0. More...

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

Public Types

enum  NegationValue { NegationValueFalse, NegationValueTrue }
 Enum of negation value. More...
 
enum  ParameterType { ParameterTypeInput, ParameterTypeOutput }
 Enum of parameter type. More...
 

Public Member Functions

NXOpen::AME::ConditionsBuilderConditions ()
 Returns the conditions block
Created in NX12.0.0. More...
 
NXOpen::NXObjectCreateParameter (NXOpen::AME::OperatorRuleBuilder::ParameterType parameterType, int atIndex)
 Create new parameter. More...
 
void DeleteParameter (NXOpen::AME::OperatorRuleBuilder::ParameterType parameterType, int index)
 Deletes parameter
Created in NX12.0.0. More...
 
void MoveParameter (NXOpen::AME::OperatorRuleBuilder::ParameterType parameterType, int moveFromIndex, int moveToIndex)
 Move existing parameter
Created in NX12.0.0. More...
 
NXOpen::AME::OperatorRuleBuilder::NegationValue Negation ()
 Returns the Negation of parameter
Created in NX12.0.0. More...
 
NXOpen::AME::ObjectConnectionDetailBuilderObjectConnectionDetail ()
 Returns the Variable component
Created in NX12.0.0. More...
 
NXOpen::AME::PlcRule::Type OperatorType ()
 Returns the OperatorType
Created in NX12.0.0. More...
 
NXOpen::AME::PlcRule::Type ParameterRuleType ()
 Returns the Select Parameter
Created in NX12.0.0. More...
 
NXOpen::AME::SelectAMEBaseNodePort ()
 Returns the Object Selection for Global Variable
Created in NX12.0.0. More...
 
NXString RuleName ()
 Returns the rule name
Created in NX12.0.0. More...
 
void SetNegation (NXOpen::AME::OperatorRuleBuilder::NegationValue negation)
 Sets the Negation of parameter
Created in NX12.0.0. More...
 
void SetOperatorType (NXOpen::AME::PlcRule::Type operatorType)
 Sets the OperatorType
Created in NX12.0.0. More...
 
void SetParameterRuleType (NXOpen::AME::PlcRule::Type ruleType)
 Sets the Select Parameter
Created in NX12.0.0. More...
 
void SetRuleName (const NXString &ruleName)
 Sets the rule name
Created in NX12.0.0. More...
 
void SetRuleName (const char *ruleName)
 Sets the rule name
Created in NX12.0.0. More...
 
NXOpen::NXObjectUpdateParameter (NXOpen::AME::OperatorRuleBuilder::ParameterType parameterType, int index)
 Update existing parameter. 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

OperatorRule Dialog
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateOperatorRuleBuilder

Created in NX12.0.0.


Member Enumeration Documentation

Enum of negation value.

Enumerator
NegationValueFalse 

false

NegationValueTrue 

true

Enum of parameter type.

Enumerator
ParameterTypeInput 

input

ParameterTypeOutput 

output

Member Function Documentation

NXOpen::AME::ConditionsBuilder* NXOpen::AME::OperatorRuleBuilder::Conditions ( )

Returns the conditions block
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::NXObject* NXOpen::AME::OperatorRuleBuilder::CreateParameter ( NXOpen::AME::OperatorRuleBuilder::ParameterType  parameterType,
int  atIndex 
)

Create new parameter.

Returns

Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
Parameters
parameterTypeparametertype
atIndexatindex
void NXOpen::AME::OperatorRuleBuilder::DeleteParameter ( NXOpen::AME::OperatorRuleBuilder::ParameterType  parameterType,
int  index 
)

Deletes parameter
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
parameterTypeparametertype
indexindex
void NXOpen::AME::OperatorRuleBuilder::MoveParameter ( NXOpen::AME::OperatorRuleBuilder::ParameterType  parameterType,
int  moveFromIndex,
int  moveToIndex 
)

Move existing parameter
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
parameterTypeparametertype
moveFromIndexmovefromindex
moveToIndexmovetoindex
NXOpen::AME::OperatorRuleBuilder::NegationValue NXOpen::AME::OperatorRuleBuilder::Negation ( )

Returns the Negation of parameter
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::ObjectConnectionDetailBuilder* NXOpen::AME::OperatorRuleBuilder::ObjectConnectionDetail ( )

Returns the Variable component
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::PlcRule::Type NXOpen::AME::OperatorRuleBuilder::OperatorType ( )

Returns the OperatorType
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::PlcRule::Type NXOpen::AME::OperatorRuleBuilder::ParameterRuleType ( )

Returns the Select Parameter
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::SelectAMEBaseNode* NXOpen::AME::OperatorRuleBuilder::Port ( )

Returns the Object Selection for Global Variable
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::OperatorRuleBuilder::RuleName ( )

Returns the rule name
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::OperatorRuleBuilder::SetNegation ( NXOpen::AME::OperatorRuleBuilder::NegationValue  negation)

Sets the Negation of parameter
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
negationnegation
void NXOpen::AME::OperatorRuleBuilder::SetOperatorType ( NXOpen::AME::PlcRule::Type  operatorType)

Sets the OperatorType
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
operatorTypeoperatortype
void NXOpen::AME::OperatorRuleBuilder::SetParameterRuleType ( NXOpen::AME::PlcRule::Type  ruleType)

Sets the Select Parameter
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
ruleTyperuletype
void NXOpen::AME::OperatorRuleBuilder::SetRuleName ( const NXString ruleName)

Sets the rule name
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
ruleNamerulename
void NXOpen::AME::OperatorRuleBuilder::SetRuleName ( const char *  ruleName)

Sets the rule name
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
ruleNamerulename
NXOpen::NXObject* NXOpen::AME::OperatorRuleBuilder::UpdateParameter ( NXOpen::AME::OperatorRuleBuilder::ParameterType  parameterType,
int  index 
)

Update existing parameter.

Returns

Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
Parameters
parameterTypeparametertype
indexindex

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