OpticalConnectionSettingsBuilder Class

class NXOpen.AME.OpticalConnectionSettingsBuilder

Bases: NXOpen.Builder

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

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

New in version NX12.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.
GetCladdingDiameter	Fiber cladding diameter property of a given optical connection sub-type.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetCoreDiameter	Fiber core diameter property of a given optical connection sub-type.
GetObject	Returns the object currently being edited by this builder.
GetStyleColorCode	Style color code property of a given optical connection sub-type.
GetStyleFont	Style font property of a given optical connection sub-type.
GetStyleWidth	Style width property of a given optical connection sub-type.
ResetToDefault	Resets optical connection settings to default
SetCladdingDiameter
SetCoreDiameter
SetStyleColor
SetStyleFont
SetStyleWidth
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

GetCladdingDiameter

OpticalConnectionSettingsBuilder.GetCladdingDiameter

Fiber cladding diameter property of a given optical connection sub-type.

Signature GetCladdingDiameter(fiberType)

Parameters:fiberType (NXOpen.AME.AmeOpticalConnectionFiberType) – Returns: Return type:float

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

GetCoreDiameter

OpticalConnectionSettingsBuilder.GetCoreDiameter

Fiber core diameter property of a given optical connection sub-type.

Signature GetCoreDiameter(fiberType)

Parameters:fiberType (NXOpen.AME.AmeOpticalConnectionFiberType) – Returns: Return type:float

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

GetStyleColorCode

OpticalConnectionSettingsBuilder.GetStyleColorCode

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

Signature GetStyleColorCode(fiberType)

Parameters:fiberType (NXOpen.AME.AmeOpticalConnectionFiberType) – Returns: Return type:Id

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

GetStyleFont

OpticalConnectionSettingsBuilder.GetStyleFont

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

Signature GetStyleFont(fiberType)

Parameters:fiberType (NXOpen.AME.AmeOpticalConnectionFiberType) – Returns: Return type:NXOpen.DisplayableObjectObjectFont

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

GetStyleWidth

OpticalConnectionSettingsBuilder.GetStyleWidth

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

Signature GetStyleWidth(fiberType)

Parameters:fiberType (NXOpen.AME.AmeOpticalConnectionFiberType) – Returns: Return type:NXOpen.DisplayableObjectObjectWidth

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ResetToDefault

OpticalConnectionSettingsBuilder.ResetToDefault

Resets optical connection settings to default

Signature ResetToDefault()

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SetCladdingDiameter

OpticalConnectionSettingsBuilder.SetCladdingDiameter

Signature SetCladdingDiameter(fiberType, claddingDiameter)

Parameters:

• fiberType (NXOpen.AME.AmeOpticalConnectionFiberType) –
• claddingDiameter (float) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SetCoreDiameter

OpticalConnectionSettingsBuilder.SetCoreDiameter

Signature SetCoreDiameter(fiberType, coreDiameter)

Parameters:

• fiberType (NXOpen.AME.AmeOpticalConnectionFiberType) –
• coreDiameter (float) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SetStyleColor

OpticalConnectionSettingsBuilder.SetStyleColor

Signature SetStyleColor(fiberType, styleColorCode)

Parameters:

• fiberType (NXOpen.AME.AmeOpticalConnectionFiberType) –
• styleColorCode (Id) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SetStyleFont

OpticalConnectionSettingsBuilder.SetStyleFont

Signature SetStyleFont(fiberType, styleFont)

Parameters:

• fiberType (NXOpen.AME.AmeOpticalConnectionFiberType) –
• styleFont (NXOpen.DisplayableObjectObjectFont) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SetStyleWidth

OpticalConnectionSettingsBuilder.SetStyleWidth

Signature SetStyleWidth(fiberType, styleWidth)

Parameters:

• fiberType (NXOpen.AME.AmeOpticalConnectionFiberType) –
• styleWidth (NXOpen.DisplayableObjectObjectWidth) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Validate

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