AspectPrefixBuilder Class¶
-
class
NXOpen.AME.
AspectPrefixBuilder
¶ Bases:
NXOpen.Builder
represents the builder class which is used to define Aspect Prefixes and Delimiter for
NXOpen.AME.Project
To create a new instance of this class, use
NXOpen.AME.AMEManager.CreateAspectPrefixBuilder()
New in version NX11.0.0.
Properties¶
Property | Description |
---|---|
AutoRenameOnMapping | Returns or sets the option to automatically rename AD object and its aspect names to mechanical/layout name upon mapping |
Delimiter | Returns or sets the NXOpen.AME.AspectPrefixBuilderDelimiterType |
Function | Returns or sets the aspect prefix of function aspect |
Location | Returns or sets the aspect prefix of location aspect |
Product | Returns or sets the aspect prefix of product aspect |
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. |
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¶
AspectPrefixBuilderDelimiterType Enumeration | represents delimiter type |
Property Detail¶
AutoRenameOnMapping¶
-
AspectPrefixBuilder.
AutoRenameOnMapping
¶ Returns or sets the option to automatically rename AD object and its aspect names to mechanical/layout name upon mapping
-------------------------------------
Getter Method
Signature
AutoRenameOnMapping
Returns: Return type: bool New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
AutoRenameOnMapping
Parameters: autoRenameOnMapping (bool) – New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Delimiter¶
-
AspectPrefixBuilder.
Delimiter
¶ Returns or sets the
NXOpen.AME.AspectPrefixBuilderDelimiterType
-------------------------------------
Getter Method
Signature
Delimiter
Returns: Return type: NXOpen.AME.AspectPrefixBuilderDelimiterType
New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
Delimiter
Parameters: delimiter ( NXOpen.AME.AspectPrefixBuilderDelimiterType
) –New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Function¶
-
AspectPrefixBuilder.
Function
¶ Returns or sets the aspect prefix of function aspect
-------------------------------------
Getter Method
Signature
Function
Returns: Return type: str New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
Function
Parameters: functionPrefix (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Location¶
-
AspectPrefixBuilder.
Location
¶ Returns or sets the aspect prefix of location aspect
-------------------------------------
Getter Method
Signature
Location
Returns: Return type: str New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
Location
Parameters: location (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Product¶
-
AspectPrefixBuilder.
Product
¶ Returns or sets the aspect prefix of product aspect
-------------------------------------
Getter Method
Signature
Product
Returns: Return type: str New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------
Setter Method
Signature
Product
Parameters: product (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Method Detail¶
Validate¶
-
AspectPrefixBuilder.
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.