BasicPropertiesBuilder Class¶
-
class
NXOpen.AME.BasicPropertiesBuilder¶ Bases:
NXOpen.TaggedObject,NXOpen.GeometricUtilities.IComponentBuilderRepresents a re-usable component for basic properties such as name and description
This object does not need a creator.
New in version NX12.0.0.
Properties¶
| Property | Description |
|---|---|
| Description | Returns or sets the description |
| Name | Returns or sets the name |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
Description¶
-
BasicPropertiesBuilder.Description¶ Returns or sets the description
-------------------------------------Getter Method
Signature
DescriptionReturns: Return type: str New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
DescriptionParameters: description (str) – New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Name¶
-
BasicPropertiesBuilder.Name¶ Returns or sets the name
-------------------------------------Getter Method
Signature
NameReturns: Return type: str New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
NameParameters: name (str) – New in version NX12.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Method Detail¶
Validate¶
-
BasicPropertiesBuilder.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.