Manage2dSymbolsBuilder Class¶
-
class
NXOpen.AME.Manage2dSymbolsBuilder¶ Bases:
NXOpen.AME.AMEBaseBuilderRepresents a Manage2dSymbolsBuilder class Builder
To create a new instance of this class, use
NXOpen.AME.AMEManager.CreateManage2dSymbolsBuilder()Default values.
Property Value SymbolRepresentationType MultiLineSchematic New in version NX11.0.0.
Properties¶
| Property | Description |
|---|---|
| SelectedObjects | Returns the Target node selection |
| SymbolRepresentationType | Returns or sets the representation type which could be of NXOpen.AME.Manage2dSymbolsBuilderSymbolRepresentationTypes |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| AddAssignedSymbol | Adds the given 2d symbol to the assigned symbols list |
| Commit | Commits any edits that have been applied to the builder. |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| GetAssignedSymbols | Get assigned symbols |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetDefaultSymbol | Gets the default 2d symbol assigned to the input object |
| GetObject | Returns the object currently being edited by this builder. |
| RemoveAssignedSymbol | Removes the given 2d symbol from the assigned symbols list |
| ResetDefaultSymbol | Reset the default 2d symbol from the associated NXOpen.AME.ProductDefinition |
| SetDefaultSymbol | Sets the given 2d symbol as default on the input object |
| 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¶
| Manage2dSymbolsBuilderSymbolRepresentationTypes Enumeration | Representation type of symbol |
Property Detail¶
SelectedObjects¶
-
Manage2dSymbolsBuilder.SelectedObjects¶ Returns the Target node selection
-------------------------------------Getter Method
Signature
SelectedObjectsReturns: Return type: NXOpen.AME.SelectAMEBaseNodeListNew in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SymbolRepresentationType¶
-
Manage2dSymbolsBuilder.SymbolRepresentationType¶ Returns or sets the representation type which could be of
NXOpen.AME.Manage2dSymbolsBuilderSymbolRepresentationTypes-------------------------------------Getter Method
Signature
SymbolRepresentationTypeReturns: Return type: NXOpen.AME.Manage2dSymbolsBuilderSymbolRepresentationTypesNew in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
SymbolRepresentationTypeParameters: symbolRepresentationType ( NXOpen.AME.Manage2dSymbolsBuilderSymbolRepresentationTypes) –New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Method Detail¶
AddAssignedSymbol¶
-
Manage2dSymbolsBuilder.AddAssignedSymbol¶ Adds the given 2d symbol to the assigned symbols list
Signature
AddAssignedSymbol(symbolNameString)Parameters: symbolNameString (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
GetAssignedSymbols¶
-
Manage2dSymbolsBuilder.GetAssignedSymbols¶ Get assigned symbols
Signature
GetAssignedSymbols(objTag)Parameters: objTag ( NXOpen.TaggedObject) –Returns: Return type: list of str New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
GetDefaultSymbol¶
-
Manage2dSymbolsBuilder.GetDefaultSymbol¶ Gets the default 2d symbol assigned to the input object
Signature
GetDefaultSymbol(inputObject)Parameters: inputObject ( NXOpen.TaggedObject) –Returns: Return type: str New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
RemoveAssignedSymbol¶
-
Manage2dSymbolsBuilder.RemoveAssignedSymbol¶ Removes the given 2d symbol from the assigned symbols list
Signature
RemoveAssignedSymbol(symbolNameString)Parameters: symbolNameString (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
ResetDefaultSymbol¶
-
Manage2dSymbolsBuilder.ResetDefaultSymbol¶ Reset the default 2d symbol from the associated
NXOpen.AME.ProductDefinitionSignature
ResetDefaultSymbol()New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
SetDefaultSymbol¶
-
Manage2dSymbolsBuilder.SetDefaultSymbol¶ Sets the given 2d symbol as default on the input object
Signature
SetDefaultSymbol(symbolNameString)Parameters: symbolNameString (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Validate¶
-
Manage2dSymbolsBuilder.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.