ReferenceObjectBuilder Class¶
-
class
NXOpen.AME.ReferenceObjectBuilder¶ Bases:
NXOpen.TaggedObject,NXOpen.GeometricUtilities.IComponentBuilderRe-usable UI consist of a context and source selection
New in version NX12.0.0.
Properties¶
| Property | Description |
|---|---|
| ContextObject | Returns the selection for the object where the evaluator will be stored. |
| SourceExpression | Returns or sets the expression that will determine the source object. |
| SourceObject | Returns the selection for the object where the evaluation will start. |
| SourceTypeSelection | Returns or sets the selection type for the source object |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| GetSourceExpressionPart | Gets the source expression part. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| ReferenceObjectBuilderSourceSelectionType Enumeration | possible choices for source object selection |
Property Detail¶
ContextObject¶
-
ReferenceObjectBuilder.ContextObject¶ Returns the selection for the object where the evaluator will be stored.
-------------------------------------Getter Method
Signature
ContextObjectReturns: Return type: NXOpen.SelectNXObjectNew in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SourceExpression¶
-
ReferenceObjectBuilder.SourceExpression¶ Returns or sets the expression that will determine the source object.
-------------------------------------Getter Method
Signature
SourceExpressionReturns: Return type: NXOpen.ExpressionNew in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
SourceExpressionParameters: sourceExpression ( NXOpen.Expression) –New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SourceObject¶
-
ReferenceObjectBuilder.SourceObject¶ Returns the selection for the object where the evaluation will start.
-------------------------------------Getter Method
Signature
SourceObjectReturns: Return type: NXOpen.SelectNXObjectNew in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SourceTypeSelection¶
-
ReferenceObjectBuilder.SourceTypeSelection¶ Returns or sets the selection type for the source object
-------------------------------------Getter Method
Signature
SourceTypeSelectionReturns: Return type: NXOpen.AME.ReferenceObjectBuilderSourceSelectionTypeNew in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
SourceTypeSelectionParameters: typeSelection ( NXOpen.AME.ReferenceObjectBuilderSourceSelectionType) –New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Method Detail¶
GetSourceExpressionPart¶
-
ReferenceObjectBuilder.GetSourceExpressionPart¶ Gets the source expression part.
Signature
GetSourceExpressionPart()Returns: Return type: NXOpen.PartNew in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Validate¶
-
ReferenceObjectBuilder.Validate¶ 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.
Signature
Validate()Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.