NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
NXOpen::CAE::PostColorbarUnderFlowOverFlowParameters Class Reference

This class has the information related to post colorbar underflow overflow values. More...

Inheritance diagram for NXOpen::CAE::PostColorbarUnderFlowOverFlowParameters:
NXOpen::TransientObject

Public Types

enum  LimitDisplay { LimitDisplayNone, LimitDisplayShaded, LimitDisplayTranslucent, LimitDisplayClipped }
 Colorbar drawing methods for overflow and under flor values. More...
 

Public Member Functions

NXOpen::NXColorGetOverflowAboveColor ()
 Gets the overflow above color value for the colorbar. More...
 
bool GetOverflowAboveVisibility ()
 Gets the overflow limit display visibility state for the colorbar and postview. More...
 
NXOpen::CAE::PostColorbarUnderFlowOverFlowParameters::LimitDisplay GetOverflowDisplayStyle ()
 Gets the overflow limit display style for the colorbar. More...
 
NXOpen::NXColorGetUnderflowBelowColor ()
 Gets the underflow below color value for the colorbar. More...
 
bool GetUnderflowBelowVisibility ()
 Gets the underflow limit display visibility state for the colorbar and postview. More...
 
NXOpen::CAE::PostColorbarUnderFlowOverFlowParameters::LimitDisplay GetUnderflowDisplayStyle ()
 Gets the underflow limit display style for the colorbar. More...
 
void SetOverflowAboveColor (NXOpen::NXColor *colorId)
 Sets the overflow above color value for the colorbar. More...
 
void SetOverflowAboveVisibility (bool showoverflowabove)
 Sets the overflow limit display visibility state for the colorbar and postview
Created in NX1847.0.0. More...
 
void SetOverflowDisplayStyle (NXOpen::CAE::PostColorbarUnderFlowOverFlowParameters::LimitDisplay overflow)
 Sets the overflow limit display style for the colorbar
Created in NX1847.0.0. More...
 
void SetUnderflowBelowColor (NXOpen::NXColor *colorId)
 Sets the underflow below color value for the colorbar. More...
 
void SetUnderflowBelowVisibility (bool showunderflowbelow)
 Sets the underflow limit display visibility state for the colorbar and postview
Created in NX1847.0.0. More...
 
void SetUnderflowDisplayStyle (NXOpen::CAE::PostColorbarUnderFlowOverFlowParameters::LimitDisplay underflow)
 Sets the underflow limit display style for the colorbar
Created in NX1847.0.0. More...
 
virtual ~PostColorbarUnderFlowOverFlowParameters ()
 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...
 

Detailed Description

This class has the information related to post colorbar underflow overflow values.


An instance of this class can not be created. To obtain the object use NXOpen::CAE::PostColorbar::GetUnderFlowOverFlowParameters method.

Created in NX1847.0.0.

Member Enumeration Documentation

Colorbar drawing methods for overflow and under flor values.

Enumerator
LimitDisplayNone 

none

LimitDisplayShaded 

shaded

LimitDisplayTranslucent 

translucent

LimitDisplayClipped 

clipped

Constructor & Destructor Documentation

virtual NXOpen::CAE::PostColorbarUnderFlowOverFlowParameters::~PostColorbarUnderFlowOverFlowParameters ( )
virtual

Destroys the object
Created in NX1847.0.0.



License requirements : None

Member Function Documentation

NXOpen::NXColor* NXOpen::CAE::PostColorbarUnderFlowOverFlowParameters::GetOverflowAboveColor ( )

Gets the overflow above color value for the colorbar.

This denotes the color id to draw the result values above the maximum value in the colorbar range.

Returns

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")
bool NXOpen::CAE::PostColorbarUnderFlowOverFlowParameters::GetOverflowAboveVisibility ( )

Gets the overflow limit display visibility state for the colorbar and postview.

Returns

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")
NXOpen::CAE::PostColorbarUnderFlowOverFlowParameters::LimitDisplay NXOpen::CAE::PostColorbarUnderFlowOverFlowParameters::GetOverflowDisplayStyle ( )

Gets the overflow limit display style for the colorbar.

Returns

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")
NXOpen::NXColor* NXOpen::CAE::PostColorbarUnderFlowOverFlowParameters::GetUnderflowBelowColor ( )

Gets the underflow below color value for the colorbar.

This denotes the color id to draw the result values below the minimum value in the colorbar range.

Returns

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")
bool NXOpen::CAE::PostColorbarUnderFlowOverFlowParameters::GetUnderflowBelowVisibility ( )

Gets the underflow limit display visibility state for the colorbar and postview.

Returns

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")
NXOpen::CAE::PostColorbarUnderFlowOverFlowParameters::LimitDisplay NXOpen::CAE::PostColorbarUnderFlowOverFlowParameters::GetUnderflowDisplayStyle ( )

Gets the underflow limit display style for the colorbar.

Returns

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")
void NXOpen::CAE::PostColorbarUnderFlowOverFlowParameters::SetOverflowAboveColor ( NXOpen::NXColor colorId)

Sets the overflow above color value for the colorbar.

This denotes the color id to draw the result values above the maximum value in the 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")

Parameters
colorIdcolor id
void NXOpen::CAE::PostColorbarUnderFlowOverFlowParameters::SetOverflowAboveVisibility ( bool  showoverflowabove)

Sets the overflow limit display visibility state for the colorbar and postview
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")

Parameters
showoverflowaboveshowoverflowabove
void NXOpen::CAE::PostColorbarUnderFlowOverFlowParameters::SetOverflowDisplayStyle ( NXOpen::CAE::PostColorbarUnderFlowOverFlowParameters::LimitDisplay  overflow)

Sets the overflow limit display style 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")

Parameters
overflowoverflow
void NXOpen::CAE::PostColorbarUnderFlowOverFlowParameters::SetUnderflowBelowColor ( NXOpen::NXColor colorId)

Sets the underflow below color value for the colorbar.

This denotes the color id to draw the result values below the minimum value in the 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")

Parameters
colorIdcolor id
void NXOpen::CAE::PostColorbarUnderFlowOverFlowParameters::SetUnderflowBelowVisibility ( bool  showunderflowbelow)

Sets the underflow limit display visibility state for the colorbar and postview
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")

Parameters
showunderflowbelowshowunderflowbelow
void NXOpen::CAE::PostColorbarUnderFlowOverFlowParameters::SetUnderflowDisplayStyle ( NXOpen::CAE::PostColorbarUnderFlowOverFlowParameters::LimitDisplay  underflow)

Sets the underflow limit display style 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")

Parameters
underflowunderflow

The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.