ElectricalAnnotationSettingsBuilder Class

class NXOpen.AME.ElectricalAnnotationSettingsBuilder

Bases: NXOpen.Builder

JA class for the Electrical Annotation Settings dialog

To create a new instance of this class, use NXOpen.AME.AMEManager.CreateElectricalAnnotationSettingsBuilder()

New in version NX11.0.0.

Properties

Property Description
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.
GetAnnotationAttributes The annotation attributes for a given connection type.
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.
ResetToDefault Reset to default.
SetAnnotationAttributes  
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

ElectricalAnnotationSettingsBuilderAnnotationAttrType Enumeration Represents the type of annotations

Method Detail

GetAnnotationAttributes

ElectricalAnnotationSettingsBuilder.GetAnnotationAttributes

The annotation attributes for a given connection type.

Signature GetAnnotationAttributes(potentialType)

Parameters:potentialType (NXOpen.AME.AmeElectricalConnectionPotentialType) –
Returns:User needs to free this memory.
Return type:list of NXOpen.AME.ElectricalAnnotationSettingsBuilderAnnotationAttrType

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ResetToDefault

ElectricalAnnotationSettingsBuilder.ResetToDefault

Reset to default.

Signature ResetToDefault()

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SetAnnotationAttributes

ElectricalAnnotationSettingsBuilder.SetAnnotationAttributes

Signature SetAnnotationAttributes(potentialType, annotationAttrs)

Parameters:

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Validate

ElectricalAnnotationSettingsBuilder.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.