InstanceDataBlockBuilder Class¶
-
class
NXOpen.AME.
InstanceDataBlockBuilder
¶ Bases:
NXOpen.Builder
JA class for the reuse rule dialog
To create a new instance of this class, use
NXOpen.AME.AMEManager.CreateInstanceDataBlockBuilder()
New in version NX11.0.0.
Properties¶
Property | Description |
---|---|
EoDataItemAttributeHolder | Returns the data item |
InstanceDescription | Returns or sets the defined idb text description |
InstanceName | Returns or sets the defined idb text name |
SelectedBlock | Returns the PlcBlock selection |
SelectedEngObject | Returns the EngObject selection |
SelectedFBFromLibrary | Returns the library pou selection |
Tag | Returns the Tag for this object. |
TypeOfIDB | Returns or sets the defined rule type |
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. |
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. |
SetSymbolicName | Updates the idb symbolic name |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
UpdateSourceBlock | Updates the source block selection |
UpdateSourceBlockByName | Updates the source block by using given file name of reuse library item |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
InstanceDataBlockBuilderActionType Enumeration | the idb scope |
InstanceDataBlockBuilderCreateMode Enumeration | the idb create mode |
Property Detail¶
EoDataItemAttributeHolder¶
-
InstanceDataBlockBuilder.
EoDataItemAttributeHolder
¶ Returns the data item
-------------------------------------
Getter Method
Signature
EoDataItemAttributeHolder
Returns: Return type: NXOpen.AME.EODataItemAttributeHolder
New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
InstanceDescription¶
-
InstanceDataBlockBuilder.
InstanceDescription
¶ Returns or sets the defined idb text description
-------------------------------------
Getter Method
Signature
InstanceDescription
Returns: Return type: str New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
InstanceDescription
Parameters: resultText (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
InstanceName¶
-
InstanceDataBlockBuilder.
InstanceName
¶ Returns or sets the defined idb text name
-------------------------------------
Getter Method
Signature
InstanceName
Returns: Return type: str New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
InstanceName
Parameters: resultText (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SelectedBlock¶
-
InstanceDataBlockBuilder.
SelectedBlock
¶ Returns the PlcBlock selection
-------------------------------------
Getter Method
Signature
SelectedBlock
Returns: Return type: NXOpen.AME.SelectAMEBaseNode
New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SelectedEngObject¶
-
InstanceDataBlockBuilder.
SelectedEngObject
¶ Returns the EngObject selection
-------------------------------------
Getter Method
Signature
SelectedEngObject
Returns: Return type: NXOpen.AME.SelectAspectNode
New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SelectedFBFromLibrary¶
-
InstanceDataBlockBuilder.
SelectedFBFromLibrary
¶ Returns the library pou selection
-------------------------------------
Getter Method
Signature
SelectedFBFromLibrary
Returns: Return type: NXOpen.Tooling.SelectReuseLibraryItemBuilder
New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
TypeOfIDB¶
-
InstanceDataBlockBuilder.
TypeOfIDB
¶ Returns or sets the defined rule type
-------------------------------------
Getter Method
Signature
TypeOfIDB
Returns: Return type: NXOpen.AME.InstanceDataBlockBuilderActionType
New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
TypeOfIDB
Parameters: type ( NXOpen.AME.InstanceDataBlockBuilderActionType
) –New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Method Detail¶
SetSymbolicName¶
-
InstanceDataBlockBuilder.
SetSymbolicName
¶ Updates the idb symbolic name
Signature
SetSymbolicName(symbolicName)
Parameters: symbolicName (str) – New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
UpdateSourceBlock¶
-
InstanceDataBlockBuilder.
UpdateSourceBlock
¶ Updates the source block selection
Signature
UpdateSourceBlock(selBlock)
Parameters: selBlock ( NXOpen.AME.PlcBlock
) –New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
UpdateSourceBlockByName¶
-
InstanceDataBlockBuilder.
UpdateSourceBlockByName
¶ Updates the source block by using given file name of reuse library item
Signature
UpdateSourceBlockByName(fileName)
Parameters: fileName (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Validate¶
-
InstanceDataBlockBuilder.
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.