TBSBaseDesignVariableBuilder Class¶
-
class
NXOpen.CAE.Optimization.TBSBaseDesignVariableBuilder¶ Bases:
NXOpen.BuilderRepresents the builder of
NXOpen.CAE.Optimization.TBSDesignVariableThis is an abstract class, and cannot be created.
New in version NX8.0.0.
Properties¶
| Property | Description |
|---|---|
| DesignElements | Returns the element group in which the value of the design variable is to be determined |
| DesignNodes | Returns the node group in which the value of the design variable is to be determined |
| GroupOperatorOption | Returns or sets the group operator option |
| LoadCases | Returns the load cases |
| NameDescription | Returns the name description |
| ReferenceCoordinateSystem | Returns or sets the referenced coordinate system |
| SelectionAreaType | Returns or sets the type of selection location on which design variable is applied |
| 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¶
| TBSBaseDesignVariableBuilderGroupOperator Enumeration | Defines the operator type to determine the design variable that used within the selection area |
Property Detail¶
DesignElements¶
-
TBSBaseDesignVariableBuilder.DesignElements¶ Returns the element group in which the value of the design variable is to be determined
-------------------------------------Getter Method
Signature
DesignElementsReturns: Return type: NXOpen.CAE.Optimization.TBSGroupDefinitionNew in version NX8.0.0.
License requirements: None.
DesignNodes¶
-
TBSBaseDesignVariableBuilder.DesignNodes¶ Returns the node group in which the value of the design variable is to be determined
-------------------------------------Getter Method
Signature
DesignNodesReturns: Return type: NXOpen.CAE.Optimization.TBSGroupDefinitionNew in version NX8.0.0.
License requirements: None.
GroupOperatorOption¶
-
TBSBaseDesignVariableBuilder.GroupOperatorOption¶ Returns or sets the group operator option
-------------------------------------Getter Method
Signature
GroupOperatorOptionReturns: Return type: NXOpen.CAE.Optimization.TBSBaseDesignVariableBuilderGroupOperatorNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
GroupOperatorOptionParameters: groupOperatorOption ( NXOpen.CAE.Optimization.TBSBaseDesignVariableBuilderGroupOperator) –New in version NX8.0.0.
License requirements: cae_opt_topo (“NX Topology Optimization”) OR cae_opt_topobead (“NX Bead Optimization”) OR cae_opt_toposhape (“NX Shape Optimization”)
LoadCases¶
-
TBSBaseDesignVariableBuilder.LoadCases¶ Returns the load cases
-------------------------------------Getter Method
Signature
LoadCasesReturns: Return type: NXOpen.CAE.Optimization.TBSLoadCaseManagerNew in version NX8.0.0.
License requirements: None.
NameDescription¶
-
TBSBaseDesignVariableBuilder.NameDescription¶ Returns the name description
-------------------------------------Getter Method
Signature
NameDescriptionReturns: Return type: NXOpen.CAE.Optimization.NameDescriptionNew in version NX8.0.0.
License requirements: None.
ReferenceCoordinateSystem¶
-
TBSBaseDesignVariableBuilder.ReferenceCoordinateSystem¶ Returns or sets the referenced coordinate system
-------------------------------------Getter Method
Signature
ReferenceCoordinateSystemReturns: Return type: NXOpen.CoordinateSystemNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ReferenceCoordinateSystemParameters: referenceCsys ( NXOpen.CoordinateSystem) –New in version NX8.0.0.
License requirements: cae_opt_topo (“NX Topology Optimization”) OR cae_opt_topobead (“NX Bead Optimization”) OR cae_opt_toposhape (“NX Shape Optimization”)
SelectionAreaType¶
-
TBSBaseDesignVariableBuilder.SelectionAreaType¶ Returns or sets the type of selection location on which design variable is applied
-------------------------------------Getter Method
Signature
SelectionAreaTypeReturns: Return type: NXOpen.CAE.Optimization.TBSGroupDefinitionGroupElementTypeNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SelectionAreaTypeParameters: areaType ( NXOpen.CAE.Optimization.TBSGroupDefinitionGroupElementType) –New in version NX8.0.0.
License requirements: cae_opt_topo (“NX Topology Optimization”) OR cae_opt_topobead (“NX Bead Optimization”) OR cae_opt_toposhape (“NX Shape Optimization”)
Method Detail¶
Validate¶
-
TBSBaseDesignVariableBuilder.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.