OpticalAnnotationSettingsBuilder Class¶
-
class
NXOpen.AME.
OpticalAnnotationSettingsBuilder
¶ Bases:
NXOpen.Builder
JA class for the Optical Annotation Settings dialog
To create a new instance of this class, use
NXOpen.AME.AMEManager.CreateOpticalAnnotationSettingsBuilder()
New in version NX12.0.0.
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 fiber 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¶
OpticalAnnotationSettingsBuilderAnnotationAttrType Enumeration | Represents the type of annotations |
Method Detail¶
GetAnnotationAttributes¶
-
OpticalAnnotationSettingsBuilder.
GetAnnotationAttributes
¶ The annotation attributes for a given fiber type.
Signature
GetAnnotationAttributes(fiberType)
Parameters: fiberType ( NXOpen.AME.AmeOpticalConnectionFiberType
) –Returns: User needs to free this memory. Return type: list of NXOpen.AME.OpticalAnnotationSettingsBuilderAnnotationAttrType
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
ResetToDefault¶
-
OpticalAnnotationSettingsBuilder.
ResetToDefault
¶ Reset to default.
Signature
ResetToDefault()
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SetAnnotationAttributes¶
-
OpticalAnnotationSettingsBuilder.
SetAnnotationAttributes
¶ Signature
SetAnnotationAttributes(fiberType, annotationAttrs)
Parameters: - fiberType (
NXOpen.AME.AmeOpticalConnectionFiberType
) – - annotationAttrs (list of
NXOpen.AME.OpticalAnnotationSettingsBuilderAnnotationAttrType
) –
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
- fiberType (
Validate¶
-
OpticalAnnotationSettingsBuilder.
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.