BodyByEquationBuilder Class¶
-
class
NXOpen.Features.BodyByEquationBuilder¶ Bases:
NXOpen.Features.FeatureBuilderRepresents a
NXOpen.Features.BodyByEquationbuilder.This feature is dependent on either a Symbolica or Maple spreadsheet to drive the mathematical representation of the feature body.
To create a new instance of this class, use
NXOpen.Features.FeatureCollection.CreateBodyByEquationBuilder()Default values.
Property Value Associative 1 StlFileUnits Millimeters New in version NX12.0.0.
Properties¶
| Property | Description |
|---|---|
| Associative | Returns or sets the option to identify if the feature should associatively update. |
| EmbedWorksheet | Returns or sets the option to embed worksheet in part |
| EmbeddedWorksheet | Returns or sets the currently selected embedded worksheet index. |
| FileBrowser | Returns or sets the Symbolica or Maple file. |
| Location | Returns or sets the source location of the Symbolica or Maple worksheet. |
| NativeFileBrowser | Returns or sets the native OS file browser |
| ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal |
| PatchSolutionFlag | Returns or sets the patch solution flag |
| PatchSurfaceFilename | Returns or sets the patch surface filename |
| PlotVariableName | Returns or sets the Symbolica or Maple plot3D variable index to export that defines the surface to be used in this feature. |
| StlFileUnits | Returns or sets the option to specify the size of an STL unit. |
| SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| CommitFeature | Commits the feature parameters and creates the feature |
| 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. |
| GetFeature | Returns the feature currently being edited by this builder. |
| GetObject | Returns the object currently being edited by this builder. |
| HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited. |
| SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited |
| ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited. |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| BodyByEquationBuilderLocationTypes Enumeration | The option to specify where the Symbolica or Maple worksheet exists. |
| BodyByEquationBuilderStlFileUnitTypes Enumeration | The option to specify the size of an STL unit (e. |
Property Detail¶
Associative¶
-
BodyByEquationBuilder.Associative¶ Returns or sets the option to identify if the feature should associatively update.
-------------------------------------Getter Method
Signature
AssociativeReturns: Return type: bool New in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AssociativeParameters: associative (bool) – New in version NX12.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
EmbedWorksheet¶
-
BodyByEquationBuilder.EmbedWorksheet¶ Returns or sets the option to embed worksheet in part
-------------------------------------Getter Method
Signature
EmbedWorksheetReturns: Return type: bool New in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
EmbedWorksheetParameters: embedWorksheet (bool) – New in version NX12.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
EmbeddedWorksheet¶
-
BodyByEquationBuilder.EmbeddedWorksheet¶ Returns or sets the currently selected embedded worksheet index.
-------------------------------------Getter Method
Signature
EmbeddedWorksheetReturns: Return type: int New in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
EmbeddedWorksheetParameters: embeddedWorksheet (int) – New in version NX12.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
FileBrowser¶
-
BodyByEquationBuilder.FileBrowser¶ Returns or sets the Symbolica or Maple file.
-------------------------------------Getter Method
Signature
FileBrowserReturns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
FileBrowserParameters: filename (str) – New in version NX12.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Location¶
-
BodyByEquationBuilder.Location¶ Returns or sets the source location of the Symbolica or Maple worksheet.
-------------------------------------Getter Method
Signature
LocationReturns: Return type: NXOpen.Features.BodyByEquationBuilderLocationTypesNew in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LocationParameters: location ( NXOpen.Features.BodyByEquationBuilderLocationTypes) –New in version NX12.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
NativeFileBrowser¶
-
BodyByEquationBuilder.NativeFileBrowser¶ Returns or sets the native OS file browser
-------------------------------------Getter Method
Signature
NativeFileBrowserReturns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
NativeFileBrowserParameters: filename (str) – New in version NX12.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
PlotVariableName¶
-
BodyByEquationBuilder.PlotVariableName¶ Returns or sets the Symbolica or Maple plot3D variable index to export that defines the surface to be used in this feature.
-------------------------------------Getter Method
Signature
PlotVariableNameReturns: Return type: int New in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PlotVariableNameParameters: plotVariableName (int) – New in version NX12.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
StlFileUnits¶
-
BodyByEquationBuilder.StlFileUnits¶ Returns or sets the option to specify the size of an STL unit.
-------------------------------------Getter Method
Signature
StlFileUnitsReturns: Return type: NXOpen.Features.BodyByEquationBuilderStlFileUnitTypesNew in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
StlFileUnitsParameters: stlFileUnits ( NXOpen.Features.BodyByEquationBuilderStlFileUnitTypes) –New in version NX12.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Method Detail¶
Validate¶
-
BodyByEquationBuilder.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.