This class has the information related to post colorbar value control. More...

Inheritance diagram for NXOpen.CAE.PostColorbarValueParameters:

Public Types
enum	Extreme { Result, Displayed, Specified, ViewportResult, ViewportDisplayed }
	Colorbar extremes More...

enum	Scale { Automatic, Linear, Logarithmic }
	Colorbar scales More...

enum	Spacing { EquallySpaced, RoundOff, LevelIncrement }
	Colorbar spacing scheme More...

Public Member Functions
unsafe bool	GetCustomOverwriteValue ()
	Asks the custom overwrite value setting for the colorbar. More...

unsafe NXOpen.CAE.PostColorbarValueParameters.Extreme	GetExtreme ()
	Gets the range extreme type for the colorbar. More...

unsafe double	GetExtremeMaximum ()
	Gets the maximum value in the range of selected extreme for the colorbar More...

unsafe double	GetExtremeMinimum ()
	Gets the minimum value in the range of selected extreme for the colorbar More...

unsafe double	GetIncrementPerLevel ()
	Gets the increment value per level for the colorbar range. More...

unsafe int	GetNumLevels ()
	Gets the number of levels for the given colorbar range More...

unsafe NXOpen.CAE.PostColorbarValueParameters.Scale	GetScale ()
	Gets the scale type for the colorbar, this includes automatic, logarithmic and linear. More...

unsafe NXOpen.CAE.PostColorbarValueParameters.Spacing	GetSpacing ()
	Gets the range spacing style for the colorbar. More...

unsafe double[]	GetValueRange ()
	Asks the result value range for the colorbar. More...

unsafe void	SetCustomOverwriteValue (bool customoverwritevalue)
	Sets the custom overwrite value setting for the colorbar. More...

unsafe void	SetExtreme (NXOpen.CAE.PostColorbarValueParameters.Extreme extreme)
	Sets the extreme type for the colorbar. More...

unsafe void	SetExtremeMaximum (double maximum)
	Sets the maximum value in the range of selected extreme for the colorbar More...

unsafe void	SetExtremeMinimum (double minimum)
	Sets the minimum value in the range of selected extreme for the colorbar More...

unsafe void	SetIncrementPerLevel (double incrementperlevel)
	Sets the increment value per level for the colorbar range. More...

unsafe void	SetNumLevels (int numlevels)
	Sets the number of levels for the given colorbar range More...

unsafe void	SetScale (NXOpen.CAE.PostColorbarValueParameters.Scale scale)
	Sets the scale setting for the colorbar, this includes automatic, logarithmic and linear. More...

unsafe void	SetSpacing (NXOpen.CAE.PostColorbarValueParameters.Spacing spacing)
	Sets the range spacing style for the colorbar. More...

unsafe void	SetValueRange (double[] valuerange)
	Sets the value range for the colorbar. More...

Public Member Functions inherited from NXOpen.TransientObject
void	Dispose ()
	Frees the object from memory. More...

void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

new string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Protected Member Functions
override void	FreeResource ()
	Destroys the object More...

Additional Inherited Members
Properties inherited from NXOpen.TransientObject
IntPtr	Handle `[get]`
	Handle of the internal object represented by this object. More...

Detailed Description

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

Member Enumeration Documentation

enum NXOpen.CAE.PostColorbarValueParameters.Extreme

Colorbar extremes

Enumerator
Result
Displayed
Specified
ViewportResult
ViewportDisplayed

enum NXOpen.CAE.PostColorbarValueParameters.Scale

Colorbar scales

Enumerator
Automatic
Linear
Logarithmic

enum NXOpen.CAE.PostColorbarValueParameters.Spacing

Colorbar spacing scheme

Enumerator
EquallySpaced
RoundOff
LevelIncrement

Member Function Documentation

override void NXOpen.CAE.PostColorbarValueParameters.FreeResource ( )

inlineprotectedvirtual

Destroys the object

Created in NX1847.0.0

License requirements: None.

Implements NXOpen.TransientObject.

unsafe bool NXOpen.CAE.PostColorbarValueParameters.GetCustomOverwriteValue ( )

inline

Asks 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")

Returns

unsafe NXOpen.CAE.PostColorbarValueParameters.Extreme NXOpen.CAE.PostColorbarValueParameters.GetExtreme ( )

inline

Gets the range 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")

Returns

unsafe double NXOpen.CAE.PostColorbarValueParameters.GetExtremeMaximum ( )

inline

Gets 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")

Returns

unsafe double NXOpen.CAE.PostColorbarValueParameters.GetExtremeMinimum ( )

inline

Gets 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")

Returns

unsafe double NXOpen.CAE.PostColorbarValueParameters.GetIncrementPerLevel ( )

inline

Gets 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")

Returns

unsafe int NXOpen.CAE.PostColorbarValueParameters.GetNumLevels ( )

inline

Gets 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")

Returns

unsafe NXOpen.CAE.PostColorbarValueParameters.Scale NXOpen.CAE.PostColorbarValueParameters.GetScale ( )

inline

Gets the scale type 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")

Returns

unsafe NXOpen.CAE.PostColorbarValueParameters.Spacing NXOpen.CAE.PostColorbarValueParameters.GetSpacing ( )

inline

Gets 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")

Returns

unsafe double [] NXOpen.CAE.PostColorbarValueParameters.GetValueRange ( )

inline

Asks the result 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")

Returns

unsafe void NXOpen.CAE.PostColorbarValueParameters.SetCustomOverwriteValue ( bool customoverwritevalue )

inline

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")

Parameters

customoverwritevalue

unsafe void NXOpen.CAE.PostColorbarValueParameters.SetExtreme ( NXOpen.CAE.PostColorbarValueParameters.Extreme extreme )

inline

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")

Parameters

extreme

unsafe void NXOpen.CAE.PostColorbarValueParameters.SetExtremeMaximum ( double maximum )

inline

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")

Parameters

maximum

unsafe void NXOpen.CAE.PostColorbarValueParameters.SetExtremeMinimum ( double minimum )

inline

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")

Parameters

minimum

unsafe void NXOpen.CAE.PostColorbarValueParameters.SetIncrementPerLevel ( double incrementperlevel )

inline

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")

Parameters

incrementperlevel

unsafe void NXOpen.CAE.PostColorbarValueParameters.SetNumLevels ( int numlevels )

inline

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")

Parameters

numlevels

unsafe void NXOpen.CAE.PostColorbarValueParameters.SetScale ( NXOpen.CAE.PostColorbarValueParameters.Scale scale )

inline

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")

Parameters

scale

unsafe void NXOpen.CAE.PostColorbarValueParameters.SetSpacing ( NXOpen.CAE.PostColorbarValueParameters.Spacing spacing )

inline

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")

Parameters

spacing

unsafe void NXOpen.CAE.PostColorbarValueParameters.SetValueRange ( double[] valuerange )

inline

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")

Parameters

valuerange

The documentation for this class was generated from the following file:

CAE_PostColorbarValueParameters.cs

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation