ElectricalConnectionSettingsBuilder Class

class NXOpen.AME.ElectricalConnectionSettingsBuilder

Bases: NXOpen.Builder

Builder object for changing electrical connection settings on diagramming pages associated with the NXOpen.AME.Project.

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

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.
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.
GetStyleColorCode Style color code property of a given electrical connection sub-type.
GetStyleFont Style font property of a given electrical connection sub-type.
GetStyleWidth Style width property of a given electrical connection sub-type.
GetWireColorCode Wire color code property of a given electrical connection sub-type.
GetWireCrossSection Wire cross section property of a given electrical connection sub-type.
GetWireType Wire type property of a given electrical connection sub-type.
ResetToDefault Resets electrical connection settings to default
SetStyleColorCode  
SetStyleFont  
SetStyleWidth  
SetWireColorCode  
SetWireCrossSection  
SetWireType  
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.

Method Detail

GetStyleColorCode

ElectricalConnectionSettingsBuilder.GetStyleColorCode

Style color code property of a given electrical connection sub-type.

Signature GetStyleColorCode(potentialType)

Parameters:potentialType (NXOpen.AME.AmeElectricalConnectionPotentialType) –
Returns:
Return type:Id

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

GetStyleFont

ElectricalConnectionSettingsBuilder.GetStyleFont

Style font property of a given electrical connection sub-type.

Signature GetStyleFont(potentialType)

Parameters:potentialType (NXOpen.AME.AmeElectricalConnectionPotentialType) –
Returns:
Return type:NXOpen.DisplayableObjectObjectFont

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

GetStyleWidth

ElectricalConnectionSettingsBuilder.GetStyleWidth

Style width property of a given electrical connection sub-type.

Signature GetStyleWidth(potentialType)

Parameters:potentialType (NXOpen.AME.AmeElectricalConnectionPotentialType) –
Returns:
Return type:NXOpen.DisplayableObjectObjectWidth

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

GetWireColorCode

ElectricalConnectionSettingsBuilder.GetWireColorCode

Wire color code property of a given electrical connection sub-type.

Signature GetWireColorCode(potentialType)

Parameters:potentialType (NXOpen.AME.AmeElectricalConnectionPotentialType) –
Returns:Caller needs to free this memory.
Return type:str

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

GetWireCrossSection

ElectricalConnectionSettingsBuilder.GetWireCrossSection

Wire cross section property of a given electrical connection sub-type.

Signature GetWireCrossSection(potentialType)

Parameters:potentialType (NXOpen.AME.AmeElectricalConnectionPotentialType) –
Returns:
Return type:float

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

GetWireType

ElectricalConnectionSettingsBuilder.GetWireType

Wire type property of a given electrical connection sub-type.

Signature GetWireType(potentialType)

Parameters:potentialType (NXOpen.AME.AmeElectricalConnectionPotentialType) –
Returns:Caller needs to free this memory.
Return type:str

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ResetToDefault

ElectricalConnectionSettingsBuilder.ResetToDefault

Resets electrical connection settings to default

Signature ResetToDefault()

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SetStyleColorCode

ElectricalConnectionSettingsBuilder.SetStyleColorCode

Signature SetStyleColorCode(potentialType, styleColorCode)

Parameters:

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SetStyleFont

ElectricalConnectionSettingsBuilder.SetStyleFont

Signature SetStyleFont(potentialType, styleFont)

Parameters:

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SetStyleWidth

ElectricalConnectionSettingsBuilder.SetStyleWidth

Signature SetStyleWidth(potentialType, styleWidth)

Parameters:

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SetWireColorCode

ElectricalConnectionSettingsBuilder.SetWireColorCode

Signature SetWireColorCode(potentialType, wireColorCode)

Parameters:

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SetWireCrossSection

ElectricalConnectionSettingsBuilder.SetWireCrossSection

Signature SetWireCrossSection(potentialType, wireCrossSection)

Parameters:

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SetWireType

ElectricalConnectionSettingsBuilder.SetWireType

Signature SetWireType(potentialType, wireType)

Parameters:

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Validate

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