VAPoR::AnnotationParams Class Reference

A class for describing visual features displayed in the visualizer. More...

#include <AnnotationParams.h>

Inheritance diagram for VAPoR::AnnotationParams:

Public Member Functions
	AnnotationParams (ParamsBase::StateSave *ssave)
	Create a AnnotationParams object from scratch.
	AnnotationParams (ParamsBase::StateSave *ssave, XmlNode *node)
	Create a AnnotationParams object from an existing XmlNode tree.
	AnnotationParams (const AnnotationParams &rhs)
	Copy from already existing instance.
virtual	~AnnotationParams ()
void	GetDomainColor (double color[3]) const
void	GetDomainColor (std::vector< double > &color) const
void	SetDomainColor (vector< double > color)
bool	GetUseDomainFrame () const
void	SetUseDomainFrame (bool onOff)
bool	GetUseRegionFrame () const
void	SetUseRegionFrame (bool onOff)
void	GetRegionColor (double color[3]) const
void	GetRegionColor (std::vector< double > &color) const
void	SetRegionColor (vector< double > color)
void	GetBackgroundColor (double color[3]) const
void	GetBackgroundColor (std::vector< double > &color) const
void	SetBackgroundColor (std::vector< double > color)
string	GetCurrentAxisDataMgrName () const
void	SetCurrentAxisDataMgrName (string dataMgr="default")
AxisAnnotation *	GetAxisAnnotation ()
void	SetAxisFontSize (int size)
int	GetAxisFontSize ()
double	GetTimeLLX () const
void	SetTimeLLX (double llx)
double	GetTimeLLY () const
void	SetTimeLLY (double lly)
std::vector< double >	GetTimeColor () const
template<typename T >
void	GetTimeColor (T color[]) const
void	SetTimeColor (std::vector< double > color)
int	GetTimeType () const
void	SetTimeType (int type)
int	GetTimeSize () const
void	SetTimeSize (int size)
bool	GetAxisArrowEnabled () const
double	GetAxisArrowSize () const
double	GetAxisArrowXPos () const
double	GetAxisArrowYPos () const
void	SetAxisArrowEnabled (bool enabled)
void	SetAxisArrowSize (double pos)
void	SetAxisArrowXPos (double pos)
void	SetAxisArrowYPos (double pos)
Public Member Functions inherited from VAPoR::ParamsBase
	ParamsBase (StateSave *ssave, const string &classname)
	ParamsBase (StateSave *ssave, XmlNode *node)
	ParamsBase (const ParamsBase &rhs)
	Copy constructor.
ParamsBase &	operator= (const ParamsBase &rhs)
	ParamsBase (ParamsBase &&)=delete
ParamsBase &	operator= (ParamsBase &)=delete
bool	operator== (const ParamsBase &rhs) const
	Equivalence operator.
bool	operator!= (const ParamsBase &rhs) const
virtual	~ParamsBase ()
void	SetParent (ParamsBase *parent)
XmlNode *	GetNode () const
void	BeginGroup (const string &description)
void	EndGroup ()
void	IntermediateChange ()
virtual vector< long >	GetValueLongVec (const string tag) const
virtual vector< long >	GetValueLongVec (const string tag, const vector< long > &defaultVal) const
virtual long	GetValueLong (const string tag, long defaultVal) const
virtual vector< double >	GetValueDoubleVec (const string tag) const
virtual vector< double >	GetValueDoubleVec (const string tag, const vector< double > &defaultVal) const
virtual double	GetValueDouble (const string tag, double defaultVal) const
virtual vector< string >	GetValueStringVec (const string tag) const
virtual vector< string >	GetValueStringVec (const string tag, const vector< string > &defaultVal) const
virtual string	GetValueString (const string tag, string defaultVal) const
virtual void	SetValueLongVec (const string &tag, string description, const vector< long > &values)
virtual void	SetValueLong (const string &tag, string description, long value)
virtual void	SetValueDoubleVec (const string &tag, string description, const vector< double > &values)
virtual void	SetValueDouble (const string &tag, string description, double value)
virtual void	SetValueStringVec (const string &tag, string description, const vector< string > &values)
virtual void	SetValueString (const string &tag, string description, const string &value)
string	GetName () const
Public Member Functions inherited from Wasp::MyBase
	MyBase ()
const string &	getClassName () const

Static Public Member Functions
static string	GetClassType ()
Static Public Member Functions inherited from Wasp::MyBase
static void	SetErrMsg (const char *format,...)
	Record a formatted error message.
static void	SetErrMsg (int errcode, const char *format,...)
	Record a formatted error message and an error code.
static const char *	GetErrMsg ()
static void	SetErrCode (int err_code)
	Record an error code.
static int	GetErrCode ()
	Retrieve the current error code.
static void	SetErrMsgCB (ErrMsgCB_T cb)
static ErrMsgCB_T	GetErrMsgCB ()
static void	SetErrMsgFilePtr (FILE *fp)
static const FILE *	SetErrMsgFilePtr ()
static void	SetDiagMsg (const char *format,...)
	Record a formatted diagnostic message.
static const char *	GetDiagMsg ()
static void	SetDiagMsgCB (DiagMsgCB_T cb)
static DiagMsgCB_T	GetDiagMsgCB ()
static void	SetDiagMsgFilePtr (FILE *fp)
static bool	EnableErrMsg (bool enable)
static bool	GetEnableErrMsg ()

Static Public Attributes
static const string	AxisArrowSizeTag
static const string	AxisArrowXPosTag
static const string	AxisArrowYPosTag
static const string	AxisArrowEnabledTag
static const string	_domainColorTag
static const string	_domainFrameTag
static const string	_regionFrameTag
static const string	_regionColorTag
static const string	_axisColorTag
static const string	_axisDigitsTag
static const string	_axisTextHeightTag
static const string	_axisFontSizeTag
static const string	_ticWidthTag
static const string	_ticDirsTag
static const string	_ticSizeTag
static const string	_minTicsTag
static const string	_maxTicsTag
static const string	_numTicsTag
static const string	_axisOriginTag
static const string	_backgroundColorTag
static const string	_axisAnnotationEnabledTag
static const string	_axisAnnotationsTag
static const string	_latLonAxesTag
static const string	_currentAxisDataMgrTag
static vector< double >	_previousStretch
static const string	_timeLLXTag
static const string	_timeLLYTag
static const string	_timeColorTag
static const string	_timeTypeTag
static const string	_timeSizeTag
static const string	_projStringTag
Static Public Attributes inherited from Wasp::MyBase
static char *	ErrMsg
static int	ErrCode
static int	ErrMsgSize
static FILE *	ErrMsgFilePtr
static ErrMsgCB_T	ErrMsgCB
static char *	DiagMsg
static int	DiagMsgSize
static FILE *	DiagMsgFilePtr
static DiagMsgCB_T	DiagMsgCB
static bool	Enabled

Additional Inherited Members
Public Types inherited from Wasp::MyBase
typedef void(*	ErrMsgCB_T) (const char *msg, int err_code)
typedef void(*	DiagMsgCB_T) (const char *msg)
Protected Member Functions inherited from VAPoR::ParamsBase
	ParamsBase (StateSave *ssave)
void	Remove (const string &name)
const map< string, string > &	GetAttributes ()
void	Clear ()
Protected Member Functions inherited from Wasp::MyBase
void	SetClassName (const string &name)
Protected Attributes inherited from VAPoR::ParamsBase
StateSave *	_ssave
XmlNode *	_node

Detailed Description

A class for describing visual features displayed in the visualizer.

The AnnotationParams class controls various features displayed in the visualizers There is a global AnnotationParams, that is shared by all windows whose vizfeature is set to "global". There is also a local AnnotationParams for each window, that users can select whenever there are multiple windows. When local settings are used, they only affect one currently active visualizer. The AnnotationParams class also has several methods that are useful in setting up data requests from the DataMgr.

Author

Alan Norton

Version

3.0

Date

June 2015

Definition at line 51 of file AnnotationParams.h.

Constructor & Destructor Documentation

AnnotationParams() [1/3]

VAPoR::AnnotationParams::AnnotationParams

(

ParamsBase::StateSave *

ssave

)

Create a AnnotationParams object from scratch.

AnnotationParams() [2/3]

VAPoR::AnnotationParams::AnnotationParams	(	ParamsBase::StateSave *	ssave,
		XmlNode *	node
	)

Create a AnnotationParams object from an existing XmlNode tree.

AnnotationParams() [3/3]

VAPoR::AnnotationParams::AnnotationParams

(

const AnnotationParams &

rhs

)

Copy from already existing instance.

~AnnotationParams()

virtual VAPoR::AnnotationParams::~AnnotationParams ( )

inlinevirtual

Definition at line 65 of file AnnotationParams.h.

Member Function Documentation

GetAxisAnnotation()

AxisAnnotation * VAPoR::AnnotationParams::GetAxisAnnotation

(

)

GetAxisArrowEnabled()

bool VAPoR::AnnotationParams::GetAxisArrowEnabled

(

)

const

GetAxisArrowSize()

double VAPoR::AnnotationParams::GetAxisArrowSize

(

)

const

GetAxisArrowXPos()

double VAPoR::AnnotationParams::GetAxisArrowXPos

(

)

const

GetAxisArrowYPos()

double VAPoR::AnnotationParams::GetAxisArrowYPos

(

)

const

GetAxisFontSize()

int VAPoR::AnnotationParams::GetAxisFontSize

(

)

GetBackgroundColor() [1/2]

void VAPoR::AnnotationParams::GetBackgroundColor

(

double

color[3]

)

const

GetBackgroundColor() [2/2]

void VAPoR::AnnotationParams::GetBackgroundColor ( std::vector< double > &  color ) const

inline

Definition at line 84 of file AnnotationParams.h.

GetClassType()

static string VAPoR::AnnotationParams::GetClassType ( )

inlinestatic

Definition at line 123 of file AnnotationParams.h.

GetCurrentAxisDataMgrName()

string VAPoR::AnnotationParams::GetCurrentAxisDataMgrName

(

)

const

GetDomainColor() [1/2]

void VAPoR::AnnotationParams::GetDomainColor

(

double

color[3]

)

const

GetDomainColor() [2/2]

void VAPoR::AnnotationParams::GetDomainColor ( std::vector< double > &  color ) const

inline

Definition at line 68 of file AnnotationParams.h.

GetRegionColor() [1/2]

void VAPoR::AnnotationParams::GetRegionColor

(

double

color[3]

)

const

GetRegionColor() [2/2]

void VAPoR::AnnotationParams::GetRegionColor ( std::vector< double > &  color ) const

inline

Definition at line 79 of file AnnotationParams.h.

GetTimeColor() [1/2]

std::vector< double > VAPoR::AnnotationParams::GetTimeColor

(

)

const

GetTimeColor() [2/2]

template<typename T >

void VAPoR::AnnotationParams::GetTimeColor ( T  color[] ) const

inline

Definition at line 103 of file AnnotationParams.h.

GetTimeLLX()

double VAPoR::AnnotationParams::GetTimeLLX

(

)

const

GetTimeLLY()

double VAPoR::AnnotationParams::GetTimeLLY

(

)

const

GetTimeSize()

int VAPoR::AnnotationParams::GetTimeSize

(

)

const

GetTimeType()

int VAPoR::AnnotationParams::GetTimeType

(

)

const

GetUseDomainFrame()

bool VAPoR::AnnotationParams::GetUseDomainFrame ( ) const

inline

Definition at line 72 of file AnnotationParams.h.

GetUseRegionFrame()

bool VAPoR::AnnotationParams::GetUseRegionFrame ( ) const

inline

Definition at line 75 of file AnnotationParams.h.

SetAxisArrowEnabled()

void VAPoR::AnnotationParams::SetAxisArrowEnabled

(

bool

enabled

)

SetAxisArrowSize()

void VAPoR::AnnotationParams::SetAxisArrowSize

(

double

pos

)

SetAxisArrowXPos()

void VAPoR::AnnotationParams::SetAxisArrowXPos

(

double

pos

)

SetAxisArrowYPos()

void VAPoR::AnnotationParams::SetAxisArrowYPos

(

double

pos

)

SetAxisFontSize()

void VAPoR::AnnotationParams::SetAxisFontSize

(

int

size

)

SetBackgroundColor()

void VAPoR::AnnotationParams::SetBackgroundColor

(

std::vector< double >

color

)

SetCurrentAxisDataMgrName()

void VAPoR::AnnotationParams::SetCurrentAxisDataMgrName

(

string

dataMgr = "default"

)

SetDomainColor()

void VAPoR::AnnotationParams::SetDomainColor

(

vector< double >

color

)

SetRegionColor()

void VAPoR::AnnotationParams::SetRegionColor

(

vector< double >

color

)

SetTimeColor()

void VAPoR::AnnotationParams::SetTimeColor

(

std::vector< double >

color

)

SetTimeLLX()

void VAPoR::AnnotationParams::SetTimeLLX

(

double

llx

)

SetTimeLLY()

void VAPoR::AnnotationParams::SetTimeLLY

(

double

lly

)

SetTimeSize()

void VAPoR::AnnotationParams::SetTimeSize

(

int

size

)

SetTimeType()

void VAPoR::AnnotationParams::SetTimeType

(

int

type

)

SetUseDomainFrame()

void VAPoR::AnnotationParams::SetUseDomainFrame ( bool  onOff )

inline

Definition at line 73 of file AnnotationParams.h.

SetUseRegionFrame()

void VAPoR::AnnotationParams::SetUseRegionFrame ( bool  onOff )

inline

Definition at line 76 of file AnnotationParams.h.

Member Data Documentation

_axisAnnotationEnabledTag

const string VAPoR::AnnotationParams::_axisAnnotationEnabledTag

static

Definition at line 151 of file AnnotationParams.h.

_axisAnnotationsTag

const string VAPoR::AnnotationParams::_axisAnnotationsTag

static

Definition at line 152 of file AnnotationParams.h.

_axisColorTag

const string VAPoR::AnnotationParams::_axisColorTag

static

Definition at line 139 of file AnnotationParams.h.

_axisDigitsTag

const string VAPoR::AnnotationParams::_axisDigitsTag

static

Definition at line 140 of file AnnotationParams.h.

_axisFontSizeTag

const string VAPoR::AnnotationParams::_axisFontSizeTag

static

Definition at line 142 of file AnnotationParams.h.

_axisOriginTag

const string VAPoR::AnnotationParams::_axisOriginTag

static

Definition at line 149 of file AnnotationParams.h.

_axisTextHeightTag

const string VAPoR::AnnotationParams::_axisTextHeightTag

static

Definition at line 141 of file AnnotationParams.h.

_backgroundColorTag

const string VAPoR::AnnotationParams::_backgroundColorTag

static

Definition at line 150 of file AnnotationParams.h.

_currentAxisDataMgrTag

const string VAPoR::AnnotationParams::_currentAxisDataMgrTag

static

Definition at line 155 of file AnnotationParams.h.

_domainColorTag

const string VAPoR::AnnotationParams::_domainColorTag

static

Definition at line 134 of file AnnotationParams.h.

_domainFrameTag

const string VAPoR::AnnotationParams::_domainFrameTag

static

Definition at line 135 of file AnnotationParams.h.

_latLonAxesTag

const string VAPoR::AnnotationParams::_latLonAxesTag

static

Definition at line 153 of file AnnotationParams.h.

_maxTicsTag

const string VAPoR::AnnotationParams::_maxTicsTag

static

Definition at line 147 of file AnnotationParams.h.

_minTicsTag

const string VAPoR::AnnotationParams::_minTicsTag

static

Definition at line 146 of file AnnotationParams.h.

_numTicsTag

const string VAPoR::AnnotationParams::_numTicsTag

static

Definition at line 148 of file AnnotationParams.h.

_previousStretch

vector<double> VAPoR::AnnotationParams::_previousStretch

static

Definition at line 156 of file AnnotationParams.h.

_projStringTag

const string VAPoR::AnnotationParams::_projStringTag

static

Definition at line 164 of file AnnotationParams.h.

_regionColorTag

const string VAPoR::AnnotationParams::_regionColorTag

static

Definition at line 137 of file AnnotationParams.h.

_regionFrameTag

const string VAPoR::AnnotationParams::_regionFrameTag

static

Definition at line 136 of file AnnotationParams.h.

_ticDirsTag

const string VAPoR::AnnotationParams::_ticDirsTag

static

Definition at line 144 of file AnnotationParams.h.

_ticSizeTag

const string VAPoR::AnnotationParams::_ticSizeTag

static

Definition at line 145 of file AnnotationParams.h.

_ticWidthTag

const string VAPoR::AnnotationParams::_ticWidthTag

static

Definition at line 143 of file AnnotationParams.h.

_timeColorTag

const string VAPoR::AnnotationParams::_timeColorTag

static

Definition at line 160 of file AnnotationParams.h.

_timeLLXTag

const string VAPoR::AnnotationParams::_timeLLXTag

static

Definition at line 158 of file AnnotationParams.h.

_timeLLYTag

const string VAPoR::AnnotationParams::_timeLLYTag

static

Definition at line 159 of file AnnotationParams.h.

_timeSizeTag

const string VAPoR::AnnotationParams::_timeSizeTag

static

Definition at line 162 of file AnnotationParams.h.

_timeTypeTag

const string VAPoR::AnnotationParams::_timeTypeTag

static

Definition at line 161 of file AnnotationParams.h.

AxisArrowEnabledTag

const string VAPoR::AnnotationParams::AxisArrowEnabledTag

static

Definition at line 128 of file AnnotationParams.h.

AxisArrowSizeTag

const string VAPoR::AnnotationParams::AxisArrowSizeTag

static

Definition at line 125 of file AnnotationParams.h.

AxisArrowXPosTag

const string VAPoR::AnnotationParams::AxisArrowXPosTag

static

Definition at line 126 of file AnnotationParams.h.

AxisArrowYPosTag

const string VAPoR::AnnotationParams::AxisArrowYPosTag

static

Definition at line 127 of file AnnotationParams.h.

---

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

• /Users/pearse/VAPOR/include/vapor/AnnotationParams.h