NX Open C++ Reference Guide
|
Represents a NXOpen::CAE::SimBcPlotContoursBuilder builder which can be used to generate a plot of a NXOpen::CAE::SimBC in the graphics area. More...
Public Types | |
enum | PlotType { PlotTypeStatic, PlotTypeAnimation } |
Plot types. More... | |
enum | ResolveOverlapType { ResolveOverlapTypeAdd, ResolveOverlapTypeAverage, ResolveOverlapTypeMaximum, ResolveOverlapTypeMinimum, ResolveOverlapTypeSpecify } |
Resolve overlap types. More... | |
Public Member Functions | |
NXOpen::CAE::NxBcPlotContours * | CreatePlotObject () |
Returns NXOpen::CAE::NxBcPlotContours object. More... | |
NXOpen::CAE::Result * | CreateResult () |
Returns NXOpen::CAE::Result object. More... | |
std::vector< NXOpen::CAE::SimBC * > | GetAvailableBcsToPlot () |
Returns all available NXOpen::CAE::SimBC to plot. More... | |
void | GetAvailablePropertyNamesAndIndicesToPlot (NXOpen::CAE::SimBC *tBc, std::vector< int > &pPropIndices, std::vector< NXString > &pPropNames) |
Returns all available property names and indices that can be plotted for the specified NXOpen::CAE::SimBC More... | |
std::vector< NXString > | GetAvailablePropertyNamesToPlot (NXOpen::CAE::SimBC *tBc) |
Returns all available property names that can be plotted for the specified NXOpen::CAE::SimBC. More... | |
NXOpen::CAE::SimBcPlotContoursBuilder::PlotType | GetPlotType () |
Returns plot type. More... | |
int | PropertyIndexToPlot () |
Returns the property index of NXOpen::CAE::SimBC to plot. More... | |
NXString | PropertyNameToPlot () |
Returns the property name of NXOpen::CAE::SimBC to plot. More... | |
NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlapType | ResolveOverlap () |
Returns a NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlapType used in plot to resolve overlapping values Created in NX8.5.0. More... | |
double | ResolveOverlapValue () |
Returns a overlap value to plot. More... | |
NXOpen::Unit * | ResolveOverlapValueUnit () |
Returns a NXOpen::Unit for overlap value to plot. More... | |
void | SetAnimationPoints (double startValue, NXOpen::Unit *startUnit, double endValue, NXOpen::Unit *endUnit, int numFrames) |
Sets animation points Created in NX9.0.0. More... | |
void | SetBcsToPlot (const std::vector< NXOpen::CAE::SimBC * > &bcs) |
Sets NXOpen::CAE::SimBC objects to plot. More... | |
void | SetBcsToPlot (const std::vector< NXOpen::CAE::SimBC * > &bcs, std::vector< NXString > &propertyNames) |
Sets NXOpen::CAE::SimBC objects and property names to plot . More... | |
void | SetEvaluationPoints (const std::vector< double > &values, const std::vector< NXOpen::Unit * > &units) |
Sets evaluation point Created in NX9.0.0. More... | |
void | SetPlotType (NXOpen::CAE::SimBcPlotContoursBuilder::PlotType plotType) |
Sets plot type Created in NX9.0.0. More... | |
void | SetPropertyIndexToPlot (int propertyIndex) |
Sets the property index of NXOpen::CAE::SimBC to plot. More... | |
void | SetPropertyNameToPlot (const NXString &pPropertyName) |
Sets the property name of NXOpen::CAE::SimBC to plot. More... | |
void | SetPropertyNameToPlot (const char *pPropertyName) |
Sets the property name of NXOpen::CAE::SimBC to plot. More... | |
void | SetResolveOverlap (NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlapType resolveOverlapType) |
Sets a NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlapType used in plot to resolve overlapping values Created in NX8.5.0. More... | |
void | SetResolveOverlapValue (double resolveOverlapValue) |
Sets a overlap value to plot. More... | |
void | SetResolveOverlapValueUnit (NXOpen::Unit *resolveOverlapValueUnit) |
Sets a NXOpen::Unit for overlap value to plot. 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::CAE::SimBcPlotContoursBuilder builder which can be used to generate a plot of a NXOpen::CAE::SimBC in the graphics area.
This is limited to NXOpen::CAE::SimBC objects in the active solution. NXOpen::CAE::SimBcPlotContoursBuilder::CreatePlotObject returns a plot object NXOpen::CAE::NxBcPlotContours whose NXOpen::CAE::NxBcPlotContours::PlotContour plots contour.
To create a new instance of this class, use NXOpen::CAE::SimSimulation::CreateSimBcPlotContoursBuilder
Created in NX8.5.0.
NXOpen::CAE::NxBcPlotContours* NXOpen::CAE::SimBcPlotContoursBuilder::CreatePlotObject | ( | ) |
Returns NXOpen::CAE::NxBcPlotContours object.
NXOpen::CAE::Result* NXOpen::CAE::SimBcPlotContoursBuilder::CreateResult | ( | ) |
Returns NXOpen::CAE::Result object.
For time varying result, to get static result at a particular time specify that time using NXOpen::CAE::SimBcPlotContoursBuilder::SetEvaluationPoints and to get transient result for each iteration of time specify the range of time using NXOpen::CAE::SimBcPlotContoursBuilder::SetAnimationPoints .
std::vector<NXOpen::CAE::SimBC *> NXOpen::CAE::SimBcPlotContoursBuilder::GetAvailableBcsToPlot | ( | ) |
Returns all available NXOpen::CAE::SimBC to plot.
void NXOpen::CAE::SimBcPlotContoursBuilder::GetAvailablePropertyNamesAndIndicesToPlot | ( | NXOpen::CAE::SimBC * | tBc, |
std::vector< int > & | pPropIndices, | ||
std::vector< NXString > & | pPropNames | ||
) |
Returns all available property names and indices that can be plotted for the specified NXOpen::CAE::SimBC
There is no replacement for this method.
Created in NX8.5.0.
License requirements : nx_masterfem ("Finite Element Modeling")
tBc | tbc |
pPropIndices | ppropindices |
pPropNames | ppropnames |
std::vector<NXString> NXOpen::CAE::SimBcPlotContoursBuilder::GetAvailablePropertyNamesToPlot | ( | NXOpen::CAE::SimBC * | tBc | ) |
Returns all available property names that can be plotted for the specified NXOpen::CAE::SimBC.
tBc | tbc |
NXOpen::CAE::SimBcPlotContoursBuilder::PlotType NXOpen::CAE::SimBcPlotContoursBuilder::GetPlotType | ( | ) |
Returns plot type.
int NXOpen::CAE::SimBcPlotContoursBuilder::PropertyIndexToPlot | ( | ) |
Returns the property index of NXOpen::CAE::SimBC to plot.
Created in NX8.5.0.
License requirements : nx_masterfem ("Finite Element Modeling")
NXString NXOpen::CAE::SimBcPlotContoursBuilder::PropertyNameToPlot | ( | ) |
Returns the property name of NXOpen::CAE::SimBC to plot.
This name must come from the available property names returned by NXOpen::CAE::SimBcPlotContoursBuilder::GetAvailablePropertyNamesToPlot .
Created in NX8.5.0.
License requirements : nx_masterfem ("Finite Element Modeling")
NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlapType NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlap | ( | ) |
Returns a NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlapType used in plot to resolve overlapping values
Created in NX8.5.0.
License requirements : nx_masterfem ("Finite Element Modeling")
double NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlapValue | ( | ) |
Returns a overlap value to plot.
This is used when NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlap and NXOpen::CAE::SimBcPlotContoursBuilder::SetResolveOverlap is set to NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlapTypeSpecify
Created in NX8.5.0.
License requirements : nx_masterfem ("Finite Element Modeling")
NXOpen::Unit* NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlapValueUnit | ( | ) |
Returns a NXOpen::Unit for overlap value to plot.
This is used when NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlap and NXOpen::CAE::SimBcPlotContoursBuilder::SetResolveOverlap is set to NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlapTypeSpecify
Created in NX8.5.0.
License requirements : nx_masterfem ("Finite Element Modeling")
void NXOpen::CAE::SimBcPlotContoursBuilder::SetAnimationPoints | ( | double | startValue, |
NXOpen::Unit * | startUnit, | ||
double | endValue, | ||
NXOpen::Unit * | endUnit, | ||
int | numFrames | ||
) |
Sets animation points
Created in NX9.0.0.
License requirements : nx_masterfem ("Finite Element Modeling")
startValue | startvalue |
startUnit | startunit |
endValue | endvalue |
endUnit | endunit |
numFrames | numframes |
void NXOpen::CAE::SimBcPlotContoursBuilder::SetBcsToPlot | ( | const std::vector< NXOpen::CAE::SimBC * > & | bcs | ) |
Sets NXOpen::CAE::SimBC objects to plot.
Created in NX8.5.0.
License requirements : nx_masterfem ("Finite Element Modeling")
bcs | bcs |
void NXOpen::CAE::SimBcPlotContoursBuilder::SetBcsToPlot | ( | const std::vector< NXOpen::CAE::SimBC * > & | bcs, |
std::vector< NXString > & | propertyNames | ||
) |
Sets NXOpen::CAE::SimBC objects and property names to plot .
Created in NX9.0.0.
License requirements : nx_masterfem ("Finite Element Modeling")
bcs | bcs |
propertyNames | propertynames |
void NXOpen::CAE::SimBcPlotContoursBuilder::SetEvaluationPoints | ( | const std::vector< double > & | values, |
const std::vector< NXOpen::Unit * > & | units | ||
) |
Sets evaluation point
Created in NX9.0.0.
License requirements : nx_masterfem ("Finite Element Modeling")
values | values |
units | units |
void NXOpen::CAE::SimBcPlotContoursBuilder::SetPlotType | ( | NXOpen::CAE::SimBcPlotContoursBuilder::PlotType | plotType | ) |
Sets plot type
Created in NX9.0.0.
License requirements : nx_masterfem ("Finite Element Modeling")
plotType | plottype |
void NXOpen::CAE::SimBcPlotContoursBuilder::SetPropertyIndexToPlot | ( | int | propertyIndex | ) |
Sets the property index of NXOpen::CAE::SimBC to plot.
Created in NX8.5.0.
License requirements : nx_masterfem ("Finite Element Modeling")
propertyIndex | propertyindex |
void NXOpen::CAE::SimBcPlotContoursBuilder::SetPropertyNameToPlot | ( | const NXString & | pPropertyName | ) |
Sets the property name of NXOpen::CAE::SimBC to plot.
This name must come from the available property names returned by NXOpen::CAE::SimBcPlotContoursBuilder::GetAvailablePropertyNamesToPlot .
Created in NX8.5.0.
License requirements : nx_masterfem ("Finite Element Modeling")
pPropertyName | ppropertyname |
void NXOpen::CAE::SimBcPlotContoursBuilder::SetPropertyNameToPlot | ( | const char * | pPropertyName | ) |
Sets the property name of NXOpen::CAE::SimBC to plot.
This name must come from the available property names returned by NXOpen::CAE::SimBcPlotContoursBuilder::GetAvailablePropertyNamesToPlot .
Created in NX8.5.0.
License requirements : nx_masterfem ("Finite Element Modeling")
pPropertyName | ppropertyname |
void NXOpen::CAE::SimBcPlotContoursBuilder::SetResolveOverlap | ( | NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlapType | resolveOverlapType | ) |
Sets a NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlapType used in plot to resolve overlapping values
Created in NX8.5.0.
License requirements : nx_masterfem ("Finite Element Modeling")
resolveOverlapType | resolveoverlaptype |
void NXOpen::CAE::SimBcPlotContoursBuilder::SetResolveOverlapValue | ( | double | resolveOverlapValue | ) |
Sets a overlap value to plot.
This is used when NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlap and NXOpen::CAE::SimBcPlotContoursBuilder::SetResolveOverlap is set to NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlapTypeSpecify
Created in NX8.5.0.
License requirements : nx_masterfem ("Finite Element Modeling")
resolveOverlapValue | resolveoverlapvalue |
void NXOpen::CAE::SimBcPlotContoursBuilder::SetResolveOverlapValueUnit | ( | NXOpen::Unit * | resolveOverlapValueUnit | ) |
Sets a NXOpen::Unit for overlap value to plot.
This is used when NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlap and NXOpen::CAE::SimBcPlotContoursBuilder::SetResolveOverlap is set to NXOpen::CAE::SimBcPlotContoursBuilder::ResolveOverlapTypeSpecify
Created in NX8.5.0.
License requirements : nx_masterfem ("Finite Element Modeling")
resolveOverlapValueUnit | resolveoverlapvalueunit |