PlcSymbolsEvaluatorBuilder Class¶
-
class
NXOpen.AME.PlcSymbolsEvaluatorBuilder¶ Bases:
NXOpen.AME.BaseEvaluatorBuilderEvaluates the PLC tags for a given aspect and a starting point
To create a new instance of this class, use
NXOpen.AME.AMEManager.CreatePlcSymbolsEvaluatorBuilder()New in version NX12.0.0.
Properties¶
| Property | Description |
|---|---|
| AspectSelection | Returns or sets the aspect navigator selection type |
| BasicProperties | Returns the name and description |
| ReferenceObject | Returns the context and source object selection |
| SortingBlock | Returns the sorting block |
| Tag | Returns the Tag for this object. |
| TypeSelection | Returns or sets the type filter selection |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| EstablishEvaluator | Establishes the evaluator |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetObject | Returns the object currently being edited by this builder. |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| PlcSymbolsEvaluatorBuilderFilterType Enumeration | choices for type filter, can either be tags, instance dbs, function blocks, functions, eplan macros, or all |
Property Detail¶
AspectSelection¶
-
PlcSymbolsEvaluatorBuilder.AspectSelection¶ Returns or sets the aspect navigator selection type
-------------------------------------Getter Method
Signature
AspectSelectionReturns: Return type: NXOpen.AME.BaseEvaluatorBuilderContextTypeNew in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
AspectSelectionParameters: aspectSelection ( NXOpen.AME.BaseEvaluatorBuilderContextType) –New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
TypeSelection¶
-
PlcSymbolsEvaluatorBuilder.TypeSelection¶ Returns or sets the type filter selection
-------------------------------------Getter Method
Signature
TypeSelectionReturns: Return type: NXOpen.AME.PlcSymbolsEvaluatorBuilderFilterTypeNew in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
TypeSelectionParameters: typeSelection ( NXOpen.AME.PlcSymbolsEvaluatorBuilderFilterType) –New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Method Detail¶
Validate¶
-
PlcSymbolsEvaluatorBuilder.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.