InterruptionPointBuilder Class¶
-
class
NXOpen.AME.
InterruptionPointBuilder
¶ Bases:
NXOpen.Builder
Represents builder for AME::DB::InterruptionPoint
To create a new instance of this class, use
NXOpen.AME.AMEManager.CreateInterruptionPointBuilder()
New in version NX12.0.0.
Properties¶
Property | Description |
---|---|
InterruptionPointName | Returns or sets the interruption point name |
InterruptionPointVariant | Returns or sets the interrupt point variant |
Tag | Returns the Tag for this object. |
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. |
SetDestinationInterruptionPoint | Set the destination interruption point to link to |
SetInterruptionPointLocation | Set node location of Interruption Point on page. |
SetStarSource | Set the interruption point type to star source |
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¶
InterruptionPointBuilderVariant Enumeration | Represents Interruption Point Variant type |
Property Detail¶
InterruptionPointName¶
-
InterruptionPointBuilder.
InterruptionPointName
¶ Returns or sets the interruption point name
-------------------------------------
Getter Method
Signature
InterruptionPointName
Returns: Return type: str New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
InterruptionPointName
Parameters: interruptionPointName (str) – New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
InterruptionPointVariant¶
-
InterruptionPointBuilder.
InterruptionPointVariant
¶ Returns or sets the interrupt point variant
-------------------------------------
Getter Method
Signature
InterruptionPointVariant
Returns: Return type: NXOpen.AME.InterruptionPointBuilderVariant
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
InterruptionPointVariant
Parameters: interruptionPointVariant ( NXOpen.AME.InterruptionPointBuilderVariant
) –New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Method Detail¶
SetDestinationInterruptionPoint¶
-
InterruptionPointBuilder.
SetDestinationInterruptionPoint
¶ Set the destination interruption point to link to
Signature
SetDestinationInterruptionPoint(interruptionPoint)
Parameters: interruptionPoint ( NXOpen.AME.AMEExtendedObject
) –New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SetInterruptionPointLocation¶
-
InterruptionPointBuilder.
SetInterruptionPointLocation
¶ Set node location of Interruption Point on page.
Signature
SetInterruptionPointLocation(point, pageObject)
Parameters: - point (
NXOpen.Point2d
) – - pageObject (
NXOpen.AME.PageObject
) –
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
- point (
SetStarSource¶
-
InterruptionPointBuilder.
SetStarSource
¶ Set the interruption point type to star source
Signature
SetStarSource(starSource)
Parameters: starSource (bool) – New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Validate¶
-
InterruptionPointBuilder.
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.