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

Evaluates the PLC tags for a given aspect and a starting point
To create a new instance of this class, use NXOpen::AME::AMEManager::CreatePlcSymbolsEvaluatorBuilder

Created in NX12.0.0. More...

Inheritance diagram for NXOpen::AME::PlcSymbolsEvaluatorBuilder:
NXOpen::AME::BaseEvaluatorBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  FilterType {
  FilterTypeTags, FilterTypeIdbs, FilterTypeFunctionBlocks, FilterTypeFunctions,
  FilterTypePageMacros, FilterTypeWindowMacros, FilterTypeCallerInstance, FilterTypeAll
}
 choices for type filter, can either be tags, instance dbs, function blocks, functions, eplan macros, or all More...
 
- Public Types inherited from NXOpen::AME::BaseEvaluatorBuilder
enum  ConditionType {
  ConditionTypeContains, ConditionTypeEquals, ConditionTypeNotEquals, ConditionTypeLessThan,
  ConditionTypeGreaterThan, ConditionTypeLessThanEquals, ConditionTypeGreaterThanEquals
}
 choices for condition type filter for navigations that return a list of filtered objects More...
 
enum  ContextType { ContextTypeFunction, ContextTypeLocation, ContextTypeProduct, ContextTypeAutomation }
 choices for aspect context type, can either be function, location, product, or automation More...
 

Public Member Functions

NXOpen::AME::BaseEvaluatorBuilder::ContextType AspectSelection ()
 Returns the aspect navigator selection type
Created in NX12.0.0. More...
 
void SetAspectSelection (NXOpen::AME::BaseEvaluatorBuilder::ContextType aspectSelection)
 Sets the aspect navigator selection type
Created in NX12.0.0. More...
 
void SetTypeSelection (NXOpen::AME::PlcSymbolsEvaluatorBuilder::FilterType typeSelection)
 Sets the type filter selection
Created in NX12.0.0. More...
 
NXOpen::AME::PlcSymbolsEvaluatorBuilder::FilterType TypeSelection ()
 Returns the type filter selection
Created in NX12.0.0. More...
 
- Public Member Functions inherited from NXOpen::AME::BaseEvaluatorBuilder
NXOpen::AME::BasicPropertiesBuilderBasicProperties ()
 Returns the name and description
Created in NX12.0.0. More...
 
NXOpen::AME::ExpressionEvaluatorEstablishEvaluator ()
 Establishes the evaluator. More...
 
NXOpen::AME::ReferenceObjectBuilderReferenceObject ()
 Returns the context and source object selection
Created in NX12.0.0. More...
 
NXOpen::AME::SortingBlockBuilderSortingBlock ()
 Returns the sorting block
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

Evaluates the PLC tags for a given aspect and a starting point
To create a new instance of this class, use NXOpen::AME::AMEManager::CreatePlcSymbolsEvaluatorBuilder

Created in NX12.0.0.


Member Enumeration Documentation

choices for type filter, can either be tags, instance dbs, function blocks, functions, eplan macros, or all

Enumerator
FilterTypeTags 

tags

FilterTypeIdbs 

idbs

FilterTypeFunctionBlocks 

function blocks

FilterTypeFunctions 

functions

FilterTypePageMacros 

page macros

FilterTypeWindowMacros 

window macros

FilterTypeCallerInstance 

caller instance

FilterTypeAll 

all

Member Function Documentation

NXOpen::AME::BaseEvaluatorBuilder::ContextType NXOpen::AME::PlcSymbolsEvaluatorBuilder::AspectSelection ( )

Returns the aspect navigator selection type
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::PlcSymbolsEvaluatorBuilder::SetAspectSelection ( NXOpen::AME::BaseEvaluatorBuilder::ContextType  aspectSelection)

Sets the aspect navigator selection type
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
aspectSelectionaspectselection
void NXOpen::AME::PlcSymbolsEvaluatorBuilder::SetTypeSelection ( NXOpen::AME::PlcSymbolsEvaluatorBuilder::FilterType  typeSelection)

Sets the type filter selection
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
typeSelectiontypeselection
NXOpen::AME::PlcSymbolsEvaluatorBuilder::FilterType NXOpen::AME::PlcSymbolsEvaluatorBuilder::TypeSelection ( )

Returns the type filter selection
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 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.