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

Evaluates an object based on a property value or an index
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateAccessorEvaluatorBuilder

Created in NX12.0.0. More...

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

Public Types

enum  AccessType { AccessTypeProperty, AccessTypeIndex }
 Choices for access type either by an index or property. More...
 
enum  PositionTypeValue { PositionTypeValueBegin, PositionTypeValueEnd, PositionTypeValueIndex }
 Choices for position to be either begin, end or defined by index. 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::AccessorEvaluatorBuilder::AccessType AccessTypeValue ()
 Returns the access type
Created in NX12.0.0. More...
 
NXString CompareValue ()
 Returns the comparative value given by user
Created in NX12.0.0. More...
 
int ObjectPosition ()
 Returns the object index value given by the user
Created in NX12.0.0. More...
 
NXOpen::AME::AccessorEvaluatorBuilder::PositionTypeValue PositionValue ()
 Returns the position value given by the user
Created in NX12.0.0. More...
 
NXString PropertyName ()
 Returns the property name given by the user
Created in NX12.0.0. More...
 
void SetAccessTypeValue (NXOpen::AME::AccessorEvaluatorBuilder::AccessType accessType)
 Sets the access type
Created in NX12.0.0. More...
 
void SetCompareValue (const NXString &compareValue)
 Sets the comparative value given by user
Created in NX12.0.0. More...
 
void SetCompareValue (const char *compareValue)
 Sets the comparative value given by user
Created in NX12.0.0. More...
 
void SetObjectPosition (int objectPosition)
 Sets the object index value given by the user
Created in NX12.0.0. More...
 
void SetPositionValue (NXOpen::AME::AccessorEvaluatorBuilder::PositionTypeValue positionValue)
 Sets the position value given by the user
Created in NX12.0.0. More...
 
void SetPropertyName (const NXString &propertyName)
 Sets the property name given by the user
Created in NX12.0.0. More...
 
void SetPropertyName (const char *propertyName)
 Sets the property name given by the user
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 object based on a property value or an index
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateAccessorEvaluatorBuilder

Created in NX12.0.0.


Member Enumeration Documentation

Choices for access type either by an index or property.

Enumerator
AccessTypeProperty 

property

AccessTypeIndex 

index

Choices for position to be either begin, end or defined by index.

Enumerator
PositionTypeValueBegin 

begin

PositionTypeValueEnd 

end

PositionTypeValueIndex 

index

Member Function Documentation

NXOpen::AME::AccessorEvaluatorBuilder::AccessType NXOpen::AME::AccessorEvaluatorBuilder::AccessTypeValue ( )

Returns the access type
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::AccessorEvaluatorBuilder::CompareValue ( )

Returns the comparative value given by user
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

int NXOpen::AME::AccessorEvaluatorBuilder::ObjectPosition ( )

Returns the object index value given by the user
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::AccessorEvaluatorBuilder::PositionTypeValue NXOpen::AME::AccessorEvaluatorBuilder::PositionValue ( )

Returns the position value given by the user
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::AccessorEvaluatorBuilder::PropertyName ( )

Returns the property name given by the user
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::AccessorEvaluatorBuilder::SetAccessTypeValue ( NXOpen::AME::AccessorEvaluatorBuilder::AccessType  accessType)

Sets the access type
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
accessTypeaccesstype
void NXOpen::AME::AccessorEvaluatorBuilder::SetCompareValue ( const NXString compareValue)

Sets the comparative value given by user
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
compareValuecomparevalue
void NXOpen::AME::AccessorEvaluatorBuilder::SetCompareValue ( const char *  compareValue)

Sets the comparative value given by user
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
compareValuecomparevalue
void NXOpen::AME::AccessorEvaluatorBuilder::SetObjectPosition ( int  objectPosition)

Sets the object index value given by the user
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
objectPositionobjectposition
void NXOpen::AME::AccessorEvaluatorBuilder::SetPositionValue ( NXOpen::AME::AccessorEvaluatorBuilder::PositionTypeValue  positionValue)

Sets the position value given by the user
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
positionValuepositionvalue
void NXOpen::AME::AccessorEvaluatorBuilder::SetPropertyName ( const NXString propertyName)

Sets the property name given by the user
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
propertyNamepropertyname
void NXOpen::AME::AccessorEvaluatorBuilder::SetPropertyName ( const char *  propertyName)

Sets the property name given by the user
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
propertyNamepropertyname

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