NX Open C++ Reference Guide
|
Represents a NXOpen::Features::BodyByEquation builder. More...
Public Types | |
enum | LocationTypes { LocationTypesOperatingSystem, LocationTypesTeamcenter, LocationTypesEmbedded } |
The option to specify where the Symbolica or Maple worksheet exists. More... | |
enum | StlFileUnitTypes { StlFileUnitTypesMeters, StlFileUnitTypesMillimeters, StlFileUnitTypesInches } |
The option to specify the size of an STL unit (e.g. More... | |
Public Member Functions | |
bool | Associative () |
Returns the option to identify if the feature should associatively update. More... | |
int | EmbeddedWorksheet () |
Returns the currently selected embedded worksheet index. More... | |
bool | EmbedWorksheet () |
Returns the option to embed worksheet in part Created in NX12.0.0. More... | |
NXString | FileBrowser () |
Returns the Symbolica or Maple file. More... | |
NXOpen::Features::BodyByEquationBuilder::LocationTypes | Location () |
Returns the source location of the Symbolica or Maple worksheet. More... | |
NXString | NativeFileBrowser () |
Returns the native OS file browser Created in NX12.0.0. More... | |
int | PlotVariableName () |
Returns the Symbolica or Maple plot3D variable index to export that defines the surface to be used in this feature. More... | |
void | SetAssociative (bool associative) |
Sets the option to identify if the feature should associatively update. More... | |
void | SetEmbeddedWorksheet (int embeddedWorksheet) |
Sets the currently selected embedded worksheet index. More... | |
void | SetEmbedWorksheet (bool embedWorksheet) |
Sets the option to embed worksheet in part Created in NX12.0.0. More... | |
void | SetFileBrowser (const NXString &filename) |
Sets the Symbolica or Maple file. More... | |
void | SetFileBrowser (const char *filename) |
Sets the Symbolica or Maple file. More... | |
void | SetLocation (NXOpen::Features::BodyByEquationBuilder::LocationTypes location) |
Sets the source location of the Symbolica or Maple worksheet. More... | |
void | SetNativeFileBrowser (const NXString &filename) |
Sets the native OS file browser Created in NX12.0.0. More... | |
void | SetNativeFileBrowser (const char *filename) |
Sets the native OS file browser Created in NX12.0.0. More... | |
void | SetPlotVariableName (int plotVariableName) |
Sets the Symbolica or Maple plot3D variable index to export that defines the surface to be used in this feature. More... | |
void | SetStlFileUnits (NXOpen::Features::BodyByEquationBuilder::StlFileUnitTypes stlFileUnits) |
Sets the option to specify the size of an STL unit. More... | |
NXOpen::Features::BodyByEquationBuilder::StlFileUnitTypes | StlFileUnits () |
Returns the option to specify the size of an STL unit. More... | |
Public Member Functions inherited from NXOpen::Features::FeatureBuilder | |
NXOpen::Features::Feature * | CommitFeature () |
Commits the feature parameters and creates the feature. More... | |
NXOpen::Features::Feature * | GetFeature () |
Returns the feature currently being edited by this builder. More... | |
void | HideInternalParentFeatureAfterEdit (NXOpen::Features::Feature *parentFeature) |
Re-suppress an internal parent feature (a slave feature) after it has been edited. More... | |
bool | ParentFeatureInternal () |
Returns whether or not the latest timestamped parent feature of this feature should be made internal Created in NX5.0.0. More... | |
bool | PatchSolutionFlag () |
Returns the patch solution flag Created in NX8.0.1. More... | |
NXString | PatchSurfaceFilename () |
Returns the patch surface filename Created in NX8.0.1. More... | |
void | SetParentFeatureInternal (NXOpen::Features::Feature *parentFeature) |
Set the parent features which would be internal or slaves to the feature being created or commited Created in NX6.0.0. More... | |
void | SetParentFeatureInternal (bool isInternal) |
Sets whether or not the latest timestamped parent feature of this feature should be made internal Created in NX5.0.0. More... | |
void | SetPatchSolutionFlag (bool optionValue) |
Sets the patch solution flag Created in NX8.0.1. More... | |
void | SetPatchSurfaceFilename (const NXString &surfaceFilename) |
Sets the patch surface filename Created in NX8.0.1. More... | |
void | SetPatchSurfaceFilename (const char *surfaceFilename) |
Sets the patch surface filename Created in NX8.0.1. More... | |
void | SetSurroundingPatchSurfaceFilename (const NXString &surroundingSurfaceFilename) |
Sets the surrounding patch surface filename Created in NX8.0.1. More... | |
void | SetSurroundingPatchSurfaceFilename (const char *surroundingSurfaceFilename) |
Sets the surrounding patch surface filename Created in NX8.0.1. More... | |
void | ShowInternalParentFeatureForEdit (NXOpen::Features::Feature *parentFeature) |
Unsuppress an internal parent feature (a slave feature) so it can be edited. More... | |
NXString | SurroundingPatchSurfaceFilename () |
Returns the surrounding patch surface filename Created in NX8.0.1. More... | |
void | UnsetParentFeatureInternal (NXOpen::Features::Feature *parentFeature) |
Set the internal parent feature of the feature being edited to external Created in NX6.0.0. More... | |
Public Member Functions inherited from NXOpen::Builder | |
NXOpen::NXObject * | Commit () |
Commits any edits that have been applied to the builder. More... | |
void | Destroy () |
Deletes the builder, and cleans up any objects created by the builder. More... | |
std::vector< NXOpen::NXObject * > | GetCommittedObjects () |
For builders that create more than one object, this method returns the objects that are created by commit. More... | |
NXOpen::NXObject * | GetObject () |
Returns the object currently being edited by this builder. More... | |
void | ShowResults () |
Updates the model to reflect the result of an edit to the model for all builders that support showing results. More... | |
virtual bool | Validate () |
Validate whether the inputs to the component are sufficient for commit to be called. More... | |
Public Member Functions inherited from NXOpen::TaggedObject | |
tag_t | Tag () const |
Returns the tag of this object. More... | |
Represents a NXOpen::Features::BodyByEquation builder.
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 |
Created in NX12.0.0.
The option to specify the size of an STL unit (e.g.
selecting Millimeters means that every STL unit is represented as 1 mm within the NX work part). The unit the work part is in does not matter.
Enumerator | |
---|---|
StlFileUnitTypesMeters |
STL unit is meters. |
StlFileUnitTypesMillimeters |
STL unit is millimeters. |
StlFileUnitTypesInches |
STL unit is inches. |
bool NXOpen::Features::BodyByEquationBuilder::Associative | ( | ) |
Returns the option to identify if the feature should associatively update.
Created in NX12.0.0.
License requirements : None
int NXOpen::Features::BodyByEquationBuilder::EmbeddedWorksheet | ( | ) |
Returns the currently selected embedded worksheet index.
Created in NX12.0.0.
License requirements : None
bool NXOpen::Features::BodyByEquationBuilder::EmbedWorksheet | ( | ) |
Returns the option to embed worksheet in part
Created in NX12.0.0.
License requirements : None
NXString NXOpen::Features::BodyByEquationBuilder::FileBrowser | ( | ) |
Returns the Symbolica or Maple file.
Created in NX12.0.0.
License requirements : None
NXOpen::Features::BodyByEquationBuilder::LocationTypes NXOpen::Features::BodyByEquationBuilder::Location | ( | ) |
Returns the source location of the Symbolica or Maple worksheet.
Created in NX12.0.0.
License requirements : None
NXString NXOpen::Features::BodyByEquationBuilder::NativeFileBrowser | ( | ) |
Returns the native OS file browser
Created in NX12.0.0.
License requirements : None
int NXOpen::Features::BodyByEquationBuilder::PlotVariableName | ( | ) |
Returns the Symbolica or Maple plot3D variable index to export that defines the surface to be used in this feature.
Created in NX12.0.0.
License requirements : None
void NXOpen::Features::BodyByEquationBuilder::SetAssociative | ( | bool | associative | ) |
Sets the option to identify if the feature should associatively update.
Created in NX12.0.0.
License requirements : solid_modeling ("SOLIDS MODELING")
associative | associative |
void NXOpen::Features::BodyByEquationBuilder::SetEmbeddedWorksheet | ( | int | embeddedWorksheet | ) |
Sets the currently selected embedded worksheet index.
Created in NX12.0.0.
License requirements : solid_modeling ("SOLIDS MODELING")
embeddedWorksheet | embeddedworksheet |
void NXOpen::Features::BodyByEquationBuilder::SetEmbedWorksheet | ( | bool | embedWorksheet | ) |
Sets the option to embed worksheet in part
Created in NX12.0.0.
License requirements : solid_modeling ("SOLIDS MODELING")
embedWorksheet | embedworksheet |
void NXOpen::Features::BodyByEquationBuilder::SetFileBrowser | ( | const NXString & | filename | ) |
Sets the Symbolica or Maple file.
Created in NX12.0.0.
License requirements : solid_modeling ("SOLIDS MODELING")
filename | filename |
void NXOpen::Features::BodyByEquationBuilder::SetFileBrowser | ( | const char * | filename | ) |
Sets the Symbolica or Maple file.
Created in NX12.0.0.
License requirements : solid_modeling ("SOLIDS MODELING")
filename | filename |
void NXOpen::Features::BodyByEquationBuilder::SetLocation | ( | NXOpen::Features::BodyByEquationBuilder::LocationTypes | location | ) |
Sets the source location of the Symbolica or Maple worksheet.
Created in NX12.0.0.
License requirements : solid_modeling ("SOLIDS MODELING")
location | location |
void NXOpen::Features::BodyByEquationBuilder::SetNativeFileBrowser | ( | const NXString & | filename | ) |
Sets the native OS file browser
Created in NX12.0.0.
License requirements : solid_modeling ("SOLIDS MODELING")
filename | filename |
void NXOpen::Features::BodyByEquationBuilder::SetNativeFileBrowser | ( | const char * | filename | ) |
Sets the native OS file browser
Created in NX12.0.0.
License requirements : solid_modeling ("SOLIDS MODELING")
filename | filename |
void NXOpen::Features::BodyByEquationBuilder::SetPlotVariableName | ( | int | plotVariableName | ) |
Sets the Symbolica or Maple plot3D variable index to export that defines the surface to be used in this feature.
Created in NX12.0.0.
License requirements : solid_modeling ("SOLIDS MODELING")
plotVariableName | plotvariablename |
void NXOpen::Features::BodyByEquationBuilder::SetStlFileUnits | ( | NXOpen::Features::BodyByEquationBuilder::StlFileUnitTypes | stlFileUnits | ) |
Sets the option to specify the size of an STL unit.
Created in NX12.0.0.
License requirements : solid_modeling ("SOLIDS MODELING")
stlFileUnits | stlfileunits |
NXOpen::Features::BodyByEquationBuilder::StlFileUnitTypes NXOpen::Features::BodyByEquationBuilder::StlFileUnits | ( | ) |
Returns the option to specify the size of an STL unit.
Created in NX12.0.0.
License requirements : None