ConvertToConvergentBodyBuilder Class¶
-
class
NXOpen.CAE.
ConvertToConvergentBodyBuilder
¶ Bases:
NXOpen.Builder
Builder for creating a convergent body from CAE.
CAEBody To create a new instance of this class, use
NXOpen.CAE.CaePart.CreateConvertToConvergentBodyBuilder()
New in version NX12.0.0.
Properties¶
Property | Description |
---|---|
Associate | Returns or sets a value indicating whether to associate the convergent body to the polygon body or not |
BodySelection | Returns the polygon body selection list inside of FEM part |
ExistingFile | Returns or sets the existing part file name which is required if NXOpen.CAE.ConvertToConvergentBodyBuilderOption is set to CAE.ConvertToConvergentBodyBuilderOption.ExistingPart |
NewFile | Returns or sets the new part file name which is required if NXOpen.CAE.ConvertToConvergentBodyBuilderOption is set to CAE.ConvertToConvergentBodyBuilderOption.NewPart |
Tag | Returns the Tag for this object. |
TargetOption | Returns or sets the target option which indicates where the resulting convergent body will be created |
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¶
ConvertToConvergentBodyBuilderOption Enumeration | Represents the supported export locations of convergent body |
Property Detail¶
Associate¶
-
ConvertToConvergentBodyBuilder.
Associate
¶ Returns or sets a value indicating whether to associate the convergent body to the polygon body or not
-------------------------------------
Getter Method
Signature
Associate
Returns: Return type: bool New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Associate
Parameters: associateToggle (bool) – New in version NX12.0.0.
License requirements: None.
BodySelection¶
-
ConvertToConvergentBodyBuilder.
BodySelection
¶ Returns the polygon body selection list inside of FEM part
-------------------------------------
Getter Method
Signature
BodySelection
Returns: Return type: NXOpen.CAE.SelectCAEBodyList
New in version NX12.0.0.
License requirements: None.
ExistingFile¶
-
ConvertToConvergentBodyBuilder.
ExistingFile
¶ Returns or sets the existing part file name which is required if
NXOpen.CAE.ConvertToConvergentBodyBuilderOption
is set toCAE.ConvertToConvergentBodyBuilderOption.ExistingPart
-------------------------------------
Getter Method
Signature
ExistingFile
Returns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ExistingFile
Parameters: filename (str) – New in version NX12.0.0.
License requirements: None.
NewFile¶
-
ConvertToConvergentBodyBuilder.
NewFile
¶ Returns or sets the new part file name which is required if
NXOpen.CAE.ConvertToConvergentBodyBuilderOption
is set toCAE.ConvertToConvergentBodyBuilderOption.NewPart
-------------------------------------
Getter Method
Signature
NewFile
Returns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NewFile
Parameters: foldername (str) – New in version NX12.0.0.
License requirements: None.
TargetOption¶
-
ConvertToConvergentBodyBuilder.
TargetOption
¶ Returns or sets the target option which indicates where the resulting convergent body will be created
-------------------------------------
Getter Method
Signature
TargetOption
Returns: Return type: NXOpen.CAE.ConvertToConvergentBodyBuilderOption
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TargetOption
Parameters: targetOptions ( NXOpen.CAE.ConvertToConvergentBodyBuilderOption
) –New in version NX12.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
ConvertToConvergentBodyBuilder.
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.