|
NXOpen C++ Reference Guide
|
|
NXOpen C++ Reference Guide
|
This class has the information related to post colorbar value control. More...
Public Types | |
| enum | Extreme { ExtremeResult, ExtremeDisplayed, ExtremeSpecified, ExtremeViewportResult, ExtremeViewportDisplayed } |
| Colorbar extremes. More... | |
| enum | Scale { ScaleAutomatic, ScaleLinear, ScaleLogarithmic } |
| Colorbar scales. More... | |
| enum | Spacing { SpacingEquallySpaced, SpacingRoundOff, SpacingLevelIncrement } |
| Colorbar spacing scheme. More... | |
Public Member Functions | |
| bool | GetCustomOverwriteValue () |
| Asks the custom overwrite value setting for the colorbar. More... | |
| NXOpen::CAE::PostColorbarValueParameters::Extreme | GetExtreme () |
| Gets the range extreme type for the colorbar. More... | |
| double | GetExtremeMaximum () |
| Gets the maximum value in the range of selected extreme for the colorbar. More... | |
| double | GetExtremeMinimum () |
| Gets the minimum value in the range of selected extreme for the colorbar. More... | |
| double | GetIncrementPerLevel () |
| Gets the increment value per level for the colorbar range. More... | |
| int | GetNumLevels () |
| Gets the number of levels for the given colorbar range. More... | |
| NXOpen::CAE::PostColorbarValueParameters::Scale | GetScale () |
| Gets the scale type for the colorbar, this includes automatic, logarithmic and linear. More... | |
| NXOpen::CAE::PostColorbarValueParameters::Spacing | GetSpacing () |
| Gets the range spacing style for the colorbar. More... | |
| std::vector< double > | GetValueRange () |
| Asks the result value range for the colorbar. More... | |
| void | SetCustomOverwriteValue (bool customoverwritevalue) |
| Sets the custom overwrite value setting for the colorbar. More... | |
| void | SetExtreme (NXOpen::CAE::PostColorbarValueParameters::Extreme extreme) |
| Sets the extreme type for the colorbar. More... | |
| void | SetExtremeMaximum (double maximum) |
| Sets the maximum value in the range of selected extreme for the colorbar Created in NX1847.0.0. More... | |
| void | SetExtremeMinimum (double minimum) |
| Sets the minimum value in the range of selected extreme for the colorbar Created in NX1847.0.0. More... | |
| void | SetIncrementPerLevel (double incrementperlevel) |
| Sets the increment value per level for the colorbar range. More... | |
| void | SetNumLevels (int numlevels) |
| Sets the number of levels for the given colorbar range Created in NX1847.0.0. More... | |
| void | SetScale (NXOpen::CAE::PostColorbarValueParameters::Scale scale) |
| Sets the scale setting for the colorbar, this includes automatic, logarithmic and linear. More... | |
| void | SetSpacing (NXOpen::CAE::PostColorbarValueParameters::Spacing spacing) |
| Sets the range spacing style for the colorbar. More... | |
| void | SetValueRange (const std::vector< double > &valuerange) |
| Sets the value range for the colorbar. More... | |
| virtual | ~PostColorbarValueParameters () |
| Destroys the object Created in NX1847.0.0. More... | |
 Public Member Functions inherited from NXOpen::TransientObject | |
| void * | GetHandle () |
| Handle of the internal object represented by this object. More... | |
This class has the information related to post colorbar value control.
An instance of this class can not be created. To obtain the object use NXOpen::CAE::PostColorbar::GetValueParameters method.
Created in NX1847.0.0.
|
virtual |
Destroys the object
Created in NX1847.0.0.
License requirements : None
| bool NXOpen::CAE::PostColorbarValueParameters::GetCustomOverwriteValue | ( | ) |
Asks the custom overwrite value setting for the colorbar.
This indicates whether custom color values has been applied to colorbar scale or not.
| NXOpen::CAE::PostColorbarValueParameters::Extreme NXOpen::CAE::PostColorbarValueParameters::GetExtreme | ( | ) |
Gets the range extreme type for the colorbar.
This is the range minimum-maximum calculation value cariteria to draw colorbar scale
| double NXOpen::CAE::PostColorbarValueParameters::GetExtremeMaximum | ( | ) |
Gets the maximum value in the range of selected extreme for the colorbar.
| double NXOpen::CAE::PostColorbarValueParameters::GetExtremeMinimum | ( | ) |
Gets the minimum value in the range of selected extreme for the colorbar.
| double NXOpen::CAE::PostColorbarValueParameters::GetIncrementPerLevel | ( | ) |
Gets the increment value per level for the colorbar range.
This is applicable for only spacing type Level Increment.
| int NXOpen::CAE::PostColorbarValueParameters::GetNumLevels | ( | ) |
Gets the number of levels for the given colorbar range.
| NXOpen::CAE::PostColorbarValueParameters::Scale NXOpen::CAE::PostColorbarValueParameters::GetScale | ( | ) |
Gets the scale type for the colorbar, this includes automatic, logarithmic and linear.
| NXOpen::CAE::PostColorbarValueParameters::Spacing NXOpen::CAE::PostColorbarValueParameters::GetSpacing | ( | ) |
Gets the range spacing style for the colorbar.
This include eqally spaced, round off or level increment type of spacing in the colorbar scale.
| std::vector<double> NXOpen::CAE::PostColorbarValueParameters::GetValueRange | ( | ) |
Asks the result value range for the colorbar.
This contains the values calculated in the range with given number of levels.
| void NXOpen::CAE::PostColorbarValueParameters::SetCustomOverwriteValue | ( | bool | customoverwritevalue | ) |
Sets the custom overwrite value setting for the colorbar.
This indicates whether custom color values has been applied to colorbar scale or not.
Created in NX1847.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")
| customoverwritevalue | customoverwritevalue |
| void NXOpen::CAE::PostColorbarValueParameters::SetExtreme | ( | NXOpen::CAE::PostColorbarValueParameters::Extreme | extreme | ) |
Sets the extreme type for the colorbar.
This is the range minimum-maximum calculation value cariteria to draw colorbar scale
Created in NX1847.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")
| extreme | extreme |
| void NXOpen::CAE::PostColorbarValueParameters::SetExtremeMaximum | ( | double | maximum | ) |
Sets the maximum value in the range of selected extreme for the colorbar
Created in NX1847.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")
| maximum | maximum |
| void NXOpen::CAE::PostColorbarValueParameters::SetExtremeMinimum | ( | double | minimum | ) |
Sets the minimum value in the range of selected extreme for the colorbar
Created in NX1847.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")
| minimum | minimum |
| void NXOpen::CAE::PostColorbarValueParameters::SetIncrementPerLevel | ( | double | incrementperlevel | ) |
Sets the increment value per level for the colorbar range.
This is applicable for only spacing type Level Increment.
Created in NX1847.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")
| incrementperlevel | incrementperlevel |
| void NXOpen::CAE::PostColorbarValueParameters::SetNumLevels | ( | int | numlevels | ) |
Sets the number of levels for the given colorbar range
Created in NX1847.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")
| numlevels | numlevels |
| void NXOpen::CAE::PostColorbarValueParameters::SetScale | ( | NXOpen::CAE::PostColorbarValueParameters::Scale | scale | ) |
Sets the scale setting for the colorbar, this includes automatic, logarithmic and linear.
Created in NX1847.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")
| scale | scale |
| void NXOpen::CAE::PostColorbarValueParameters::SetSpacing | ( | NXOpen::CAE::PostColorbarValueParameters::Spacing | spacing | ) |
Sets the range spacing style for the colorbar.
This include eqally spaced, round off or level increment type of spacing in the colorbar scale.
Created in NX1847.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")
| spacing | spacing |
| void NXOpen::CAE::PostColorbarValueParameters::SetValueRange | ( | const std::vector< double > & | valuerange | ) |
Sets the value range for the colorbar.
This contains the values calculated in the range with given number of levels.
Created in NX1847.0.0.
License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")
| valuerange | valuerange |
