SymbolAuthoringBuilder Class¶
-
class
NXOpen.AME.
SymbolAuthoringBuilder
¶ Bases:
NXOpen.Builder
Represents a Symbol Authoring class Builder
To create a new instance of this class, use
NXOpen.AME.AMEManager.CreateSymbolAuthoringBuilder()
Default values.
Property Value CapturedImage.CaptureMethod GraphicsArea CapturedImage.Format Bmp CapturedImage.Size Pixels64 Type StandardSymbol New in version NX12.0.0.
Properties¶
Property | Description |
---|---|
AnchorPointLocation | Returns or sets the symbol anchor point |
CapturedImage | Returns the image capture builder used to create an image for preview |
SelectedCustomSymbol | Returns the custom symbol selection |
SelectedPort | Returns the port selection |
SymbolAnnotationPoint | Returns the symbol annotation point |
Tag | Returns the Tag for this object. |
Type | Returns or sets the symbol type |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CreateConnectionPoint | Creates a new connection point |
DeleteConnectionPoint | Deletes the connection point |
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. |
GetConnectionDirection | Gets the connection direction |
GetConnectionPointLocation | Gets the connection point location |
GetObject | Returns the object currently being edited by this builder. |
InsertSymbol | Insert the symbol |
SetConnectionDirection | Sets the connection direction |
SetConnectionPointLocation | Sets the connection point location |
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¶
SymbolAuthoringBuilderTypes Enumeration | Represents the type of symbol |
Property Detail¶
AnchorPointLocation¶
-
SymbolAuthoringBuilder.
AnchorPointLocation
¶ Returns or sets the symbol anchor point
-------------------------------------
Getter Method
Signature
AnchorPointLocation
Returns: Return type: NXOpen.Point2d
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
AnchorPointLocation
Parameters: symbolAnchorPoint ( NXOpen.Point2d
) –New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
CapturedImage¶
-
SymbolAuthoringBuilder.
CapturedImage
¶ Returns the image capture builder used to create an image for preview
-------------------------------------
Getter Method
Signature
CapturedImage
Returns: Return type: NXOpen.Gateway.ImageCaptureBuilder
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SelectedCustomSymbol¶
-
SymbolAuthoringBuilder.
SelectedCustomSymbol
¶ Returns the custom symbol selection
-------------------------------------
Getter Method
Signature
SelectedCustomSymbol
Returns: Return type: NXOpen.Tooling.SelectReuseLibraryItemBuilder
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SelectedPort¶
-
SymbolAuthoringBuilder.
SelectedPort
¶ Returns the port selection
-------------------------------------
Getter Method
Signature
SelectedPort
Returns: Return type: NXOpen.AME.SelectAMEPort
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SymbolAnnotationPoint¶
-
SymbolAuthoringBuilder.
SymbolAnnotationPoint
¶ Returns the symbol annotation point
-------------------------------------
Getter Method
Signature
SymbolAnnotationPoint
Returns: Return type: NXOpen.Point2d
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Type¶
-
SymbolAuthoringBuilder.
Type
¶ Returns or sets the symbol type
-------------------------------------
Getter Method
Signature
Type
Returns: Return type: NXOpen.AME.SymbolAuthoringBuilderTypes
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
Type
Parameters: type ( NXOpen.AME.SymbolAuthoringBuilderTypes
) –New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Method Detail¶
CreateConnectionPoint¶
-
SymbolAuthoringBuilder.
CreateConnectionPoint
¶ Creates a new connection point
Signature
CreateConnectionPoint(portToBeMapped)
Parameters: portToBeMapped ( NXOpen.NXObject
) –Returns: Return type: NXOpen.NXObject
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
DeleteConnectionPoint¶
-
SymbolAuthoringBuilder.
DeleteConnectionPoint
¶ Deletes the connection point
Signature
DeleteConnectionPoint(portToBeUnmapped, libPort)
Parameters: - portToBeUnmapped (
NXOpen.NXObject
) – - libPort (
NXOpen.NXObject
) –
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
- portToBeUnmapped (
GetConnectionDirection¶
-
SymbolAuthoringBuilder.
GetConnectionDirection
¶ Gets the connection direction
Signature
GetConnectionDirection(libPort)
Parameters: libPort ( NXOpen.NXObject
) –Returns: Return type: NXOpen.Point2d
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
GetConnectionPointLocation¶
-
SymbolAuthoringBuilder.
GetConnectionPointLocation
¶ Gets the connection point location
Signature
GetConnectionPointLocation(libPort)
Parameters: libPort ( NXOpen.NXObject
) –Returns: Return type: NXOpen.Point2d
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
InsertSymbol¶
-
SymbolAuthoringBuilder.
InsertSymbol
¶ Insert the symbol
Signature
InsertSymbol(customSymbolPath)
Parameters: customSymbolPath (str) – Returns: Return type: NXOpen.Annotations.CustomSymbol
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SetConnectionDirection¶
-
SymbolAuthoringBuilder.
SetConnectionDirection
¶ Sets the connection direction
Signature
SetConnectionDirection(libPort)
Parameters: libPort ( NXOpen.NXObject
) –Returns: Return type: NXOpen.Point2d
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SetConnectionPointLocation¶
-
SymbolAuthoringBuilder.
SetConnectionPointLocation
¶ Sets the connection point location
Signature
SetConnectionPointLocation(libPort)
Parameters: libPort ( NXOpen.NXObject
) –Returns: Return type: NXOpen.Point2d
New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Validate¶
-
SymbolAuthoringBuilder.
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.