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

Re-usable UI consist of a context and source selection
Created in NX12.0.0. More...

Inheritance diagram for NXOpen::AME::ReferenceObjectBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  SourceSelectionType { SourceSelectionTypeContextObject, SourceSelectionTypeSelectObject, SourceSelectionTypeDetermineByExpression }
 possible choices for source object selection More...
 

Public Member Functions

NXOpen::SelectNXObjectContextObject ()
 Returns the selection for the object where the evaluator will be stored. More...
 
NXOpen::PartGetSourceExpressionPart ()
 Gets the source expression part. More...
 
void SetSourceExpression (NXOpen::Expression *sourceExpression)
 Sets the expression that will determine the source object. More...
 
void SetSourceTypeSelection (NXOpen::AME::ReferenceObjectBuilder::SourceSelectionType typeSelection)
 Sets the selection type for the source object
Created in NX12.0.0. More...
 
NXOpen::ExpressionSourceExpression ()
 Returns the expression that will determine the source object. More...
 
NXOpen::SelectNXObjectSourceObject ()
 Returns the selection for the object where the evaluation will start. More...
 
NXOpen::AME::ReferenceObjectBuilder::SourceSelectionType SourceTypeSelection ()
 Returns the selection type for the source object
Created in NX12.0.0. 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

Re-usable UI consist of a context and source selection
Created in NX12.0.0.


Member Enumeration Documentation

possible choices for source object selection

Enumerator
SourceSelectionTypeContextObject 

context object

SourceSelectionTypeSelectObject 

select object

SourceSelectionTypeDetermineByExpression 

determine by expression

Member Function Documentation

NXOpen::SelectNXObject* NXOpen::AME::ReferenceObjectBuilder::ContextObject ( )

Returns the selection for the object where the evaluator will be stored.


Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::Part* NXOpen::AME::ReferenceObjectBuilder::GetSourceExpressionPart ( )

Gets the source expression part.

Returns

Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
void NXOpen::AME::ReferenceObjectBuilder::SetSourceExpression ( NXOpen::Expression sourceExpression)

Sets the expression that will determine the source object.


Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
sourceExpressionsourceexpression
void NXOpen::AME::ReferenceObjectBuilder::SetSourceTypeSelection ( NXOpen::AME::ReferenceObjectBuilder::SourceSelectionType  typeSelection)

Sets the selection type for the source object
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
typeSelectiontypeselection
NXOpen::Expression* NXOpen::AME::ReferenceObjectBuilder::SourceExpression ( )

Returns the expression that will determine the source object.


Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::SelectNXObject* NXOpen::AME::ReferenceObjectBuilder::SourceObject ( )

Returns the selection for the object where the evaluation will start.


Created in NX12.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::ReferenceObjectBuilder::SourceSelectionType NXOpen::AME::ReferenceObjectBuilder::SourceTypeSelection ( )

Returns the selection type for the source object
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

virtual bool NXOpen::AME::ReferenceObjectBuilder::Validate ( )
virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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