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

Evaluates an ancestor for a given aspect and a starting point
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateAncestorEvaluatorBuilder

Created in NX12.0.0. More...

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

Public Types

enum  JaAspectEvaluatorBuilderNavCriteria { JaAspectEvaluatorBuilderNavCriteriaByLevels, JaAspectEvaluatorBuilderNavCriteriaByProperty }
 Choices for navigation criteria - Could be By Levels or By Property. More...
 
enum  JaAspectEvaluatorBuilderNavDirection { JaAspectEvaluatorBuilderNavDirectionUp, JaAspectEvaluatorBuilderNavDirectionDown }
 Choices for direction of navigation - Could be from starting object upwards, or from root node downwards. 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...
 
NXOpen::AME::AncestorEvaluatorBuilder::JaAspectEvaluatorBuilderNavCriteria NavCriteria ()
 Returns the navigation criteria
Created in NX12.0.0. More...
 
NXOpen::AME::AncestorEvaluatorBuilder::JaAspectEvaluatorBuilderNavDirection NavDirection ()
 Returns the navigation direction
Created in NX12.0.0. More...
 
int NumLevels ()
 Returns the navigation direction
Created in NX12.0.0. More...
 
NXOpen::AME::SelectionEngineeringObjectDefinitionBuilderSelectedType ()
 Returns the selected 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 SetNavCriteria (NXOpen::AME::AncestorEvaluatorBuilder::JaAspectEvaluatorBuilderNavCriteria navCriteria)
 Sets the navigation criteria
Created in NX12.0.0. More...
 
void SetNavDirection (NXOpen::AME::AncestorEvaluatorBuilder::JaAspectEvaluatorBuilderNavDirection navDirection)
 Sets the navigation direction
Created in NX12.0.0. More...
 
void SetNumLevels (int numLevels)
 Sets the navigation direction
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 an ancestor for a given aspect and a starting point
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateAncestorEvaluatorBuilder

Created in NX12.0.0.


Member Enumeration Documentation

Choices for navigation criteria - Could be By Levels or By Property.

Enumerator
JaAspectEvaluatorBuilderNavCriteriaByLevels 

by levels

JaAspectEvaluatorBuilderNavCriteriaByProperty 

by property

Choices for direction of navigation - Could be from starting object upwards, or from root node downwards.

Enumerator
JaAspectEvaluatorBuilderNavDirectionUp 

up

JaAspectEvaluatorBuilderNavDirectionDown 

down

Member Function Documentation

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

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



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::AncestorEvaluatorBuilder::JaAspectEvaluatorBuilderNavCriteria NXOpen::AME::AncestorEvaluatorBuilder::NavCriteria ( )

Returns the navigation criteria
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::AncestorEvaluatorBuilder::JaAspectEvaluatorBuilderNavDirection NXOpen::AME::AncestorEvaluatorBuilder::NavDirection ( )

Returns the navigation direction
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

int NXOpen::AME::AncestorEvaluatorBuilder::NumLevels ( )

Returns the navigation direction
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::SelectionEngineeringObjectDefinitionBuilder* NXOpen::AME::AncestorEvaluatorBuilder::SelectedType ( )

Returns the selected type
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::AncestorEvaluatorBuilder::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::AncestorEvaluatorBuilder::SetNavCriteria ( NXOpen::AME::AncestorEvaluatorBuilder::JaAspectEvaluatorBuilderNavCriteria  navCriteria)

Sets the navigation criteria
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
navCriterianavcriteria
void NXOpen::AME::AncestorEvaluatorBuilder::SetNavDirection ( NXOpen::AME::AncestorEvaluatorBuilder::JaAspectEvaluatorBuilderNavDirection  navDirection)

Sets the navigation direction
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
navDirectionnavdirection
void NXOpen::AME::AncestorEvaluatorBuilder::SetNumLevels ( int  numLevels)

Sets the navigation direction
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
numLevelsnumlevels

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