A class for describing the vizualization windows in use in VAPOR. More...

#include <vizwinparams.h>

Inheritance diagram for VAPoR::VizWinParams:

Static Public Member Functions
static int	AddVizWin (const std::string name, int viznum, int width, int height)

static int	RemoveVizWin (int viz)

static int	GetCurrentVizWin ()

static int	SetCurrentVizWin (int viz)

static int	GetWindowWidth (int viznum)

static int	GetWindowHeight (int viznum)

static int	SetWindowWidth (int viznum, int width)

static int	SetWindowHeight (int viznum, int height)

static int	SetVizName (int viznum, string name)

static string	GetVizName (int viznum)

static int	GetNumVizWins ()

static vector< long >	GetVisualizerNums ()

static void	SetVizDirty (int viznum, bool val=true)

static bool	VizIsDirty (int viznum)

Static Public Member Functions inherited from VAPoR::Params
static bool	IsRenderingEnabled (int winnum)

static int	GetCurrentParamsInstanceIndex (int pType, int winnum)

static int	GetCurrentParamsInstanceIndex (const std::string tag, int winnum)

static void	SetCurrentParamsInstanceIndex (int pType, int winnum, int instance)

static Params *	GetParamsInstance (int pType, int winnum=-1, int instance=-1)

static Params *	GetParamsInstance (const std::string tag, int winnum=-1, int instance=-1)

static Params *	GetCurrentParamsInstance (int pType, int winnum)

static Params *	GetDefaultParams (ParamsBase::ParamsBaseType pType)

static Params *	GetDefaultParams (const string &tag)

static void	SetDefaultParams (int pType, Params *p)

static void	SetDefaultParams (const string &tag, Params *p)

static Params *	CreateDefaultParams (int pType)

static int	GetNumParamsInstances (int pType, int winnum)

static int	GetNumParamsInstances (const std::string tag, int winnum)

static void	AppendParamsInstance (int pType, int winnum, Params *p)

static void	AppendParamsInstance (const std::string tag, int winnum, Params *p)

static void	RemoveParamsInstance (int pType, int winnum, int instance)

static vector< Params * > &	GetAllParamsInstances (int pType, int winnum)

static int	GetAllParamsInstances (string tag, vector< Params * > &)

static int	DeleteVisualizer (int viznum)

static vector< Params * > &	GetAllParamsInstances (const std::string tag, int winnum)

static map< int, vector< Params * > > *	cloneAllParamsInstances (int winnum)

static vector< Params * > *	cloneAllDefaultParams ()

Static Public Member Functions inherited from VetsUtil::MyBase
static void	SetErrMsg (const char *format,...)
	Record a formatted error message. More...

static void	SetErrMsg (int errcode, const char *format,...)
	Record a formatted error message and an error code. More...

static const char *	GetErrMsg ()

static void	SetErrCode (int err_code)
	Record an error code. More...

static int	GetErrCode ()
	Retrieve the current error code. More...

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. More...

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 Public Member Functions inherited from VAPoR::ParamsBase
static ParamsBaseType	GetTypeFromTag (const string &tag)

static const string	GetTagFromType (ParamsBaseType t)

static ParamsBase *	CreateDefaultParamsBase (int pType)

static ParamsBase *	CreateDefaultParamsBase (const string &tag)

static int	RegisterParamsBaseClass (const string &tag, BaseCreateFcn fcn, bool isParams)

static int	ReregisterParamsBaseClass (const string &tag, const string &newtag, bool isParams)

static int	GetNumParamsClasses ()

static int	GetNumBasicParamsClasses ()

static bool	IsParamsTag (const string &tag)

Internal
Internal methods not intended for general use
static ParamsBase *	CreateDefaultInstance ()

	VizWinParams (XmlNode *parent, int winnum)

virtual	~VizWinParams ()
	Destructor. More...

virtual void	Validate (int type)

virtual void	restart ()
	Method to initialize a new VizWinParams instance. More...

const std::string	getShortName ()

vector< long >	getVisualizerNums ()

int	getCurrentVizWin ()

Additional Inherited Members
Public Types inherited from VetsUtil::MyBase
typedef void(*	ErrMsgCB_T) (const char *msg, int err_code)

typedef void(*	DiagMsgCB_T) (const char *msg)

Public Types inherited from VAPoR::ParamsBase
typedef int	ParamsBaseType

Public Member Functions inherited from VAPoR::BasicParams
	BasicParams (XmlNode *parent, const string &name)

Public Member Functions inherited from VAPoR::Params
	Params (const Params &p)
	Default copy constructor. More...

virtual	~Params ()

bool	isRenderParams () const

bool	isBasicParams () const

virtual int	GetVizNum ()

virtual int	SetLocal (bool lg)

virtual bool	IsLocal ()

virtual Box *	GetBox ()

	Params (XmlNode *parent, const string &name, int winNum)

	Params (int winNum, const string &name)
	Deprecated constructor, needed for built-in classes that do not have associated XML node: More...

virtual int	GetInstanceIndex ()

virtual void	SetVizNum (int vnum)

Public Member Functions inherited from VetsUtil::MyBase
	MyBase ()

const string &	getClassName () const

Public Member Functions inherited from VAPoR::ParamsBase
	ParamsBase (XmlNode *parent, const string &name)

	ParamsBase (const string &name)
	Default constructor. More...

	ParamsBase (const ParamsBase &pbase)
	Copy constructor. More...

virtual	~ParamsBase ()
	destructor..destroys the xml tree based at the root node. More...

ParamNode *	GetRootNode () const

const string	GetName () const

virtual long	GetValueLong (const string &tag, const vector< long > &defaultVal=_emptyLongVec)

virtual double	GetValueDouble (const string &tag, const vector< double > &defaultVal=_emptyDoubleVec)

virtual const string	GetValueString (const string &tag, const string &defaultVal=_emptyString)

virtual const vector< long >	GetValueLongVec (const string &tag, const vector< long > &defaultVal=_emptyLongVec)

virtual const vector< double >	GetValueDoubleVec (const string &tag, const vector< double > &defaultVal=_emptyDoubleVec)

virtual void	GetValueStringVec (const string &tag, vector< string > &vec, const vector< string > &defaultVal=_emptyStringVec)

virtual int	SetValueLong (string tag, const char description, long value, Params p)

virtual int	SetValueLong (string tag, const char description, const vector< long > &value, Params p)

virtual int	SetValueDouble (string tag, const char description, double value, Params p)

virtual int	SetValueDouble (string tag, const char description, const vector< double > &value, Params p)

virtual int	SetValueString (string tag, const char description, const string &value, Params p)

virtual int	SetValueStringVec (string tag, const char description, const vector< string > &value, Params p)

ParamsBaseType	GetParamsBaseTypeId ()

virtual void	SetRootParamNode (ParamNode *pn)

ParamsBase *	GetParamsBase (const vector< string > &path) const

int	SetParamsBase (const vector< string > &path, ParamsBase *pbase)

int	RemoveParamsBase (const vector< string > &path, ParamsBase *pbase)

void	SetParent (XmlNode *parent)

virtual bool	elementStartHandler (ExpatParseMgr pm, int depth, string &tag, const char *attribs)

virtual bool	elementEndHandler (ExpatParseMgr *pm, int depth, string &tag)

virtual ParamNode *	buildNode ()

ParamNode *	GetCurrentNode ()

ParamNode *	Push (string &tag, ParamsBase *pBase=0)

ParamNode *	Pop ()

void	Remove (const string &name)

const map< string, string > &	GetAttributes ()

void	Clear ()

Static Public Attributes inherited from VetsUtil::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

Protected Member Functions inherited from VAPoR::Params
virtual int	SetValueLong (string tag, const char *description, long value)

virtual int	SetValueLong (string tag, const char *description, const vector< long > &value)

virtual int	SetValueDouble (string tag, const char *description, double value)

virtual int	SetValueDouble (string tag, const char *description, const vector< double > &value)

virtual int	SetValueString (string tag, const char *description, const string &value)

virtual int	SetValueStringVec (string tag, const char *description, const vector< string > &value)

Protected Member Functions inherited from VetsUtil::MyBase
void	SetClassName (const string &name)

Detailed Description

A class for describing the vizualization windows in use in VAPOR.

Author: Alan Norton

Version: 3.0

Date: April 2014

Definition at line 53 of file vizwinparams.h.

Constructor & Destructor Documentation

VAPoR::VizWinParams::VizWinParams	(	XmlNode *	parent,
		int	winnum
	)

constructor

Parameters

[in]	parent	Root ParamNode
[in]	int	winnum The window number, -1 since it's global

virtual VAPoR::VizWinParams::~VizWinParams ( )

virtual

Destructor.

Member Function Documentation

static int VAPoR::VizWinParams::AddVizWin	(	const std::string	name,
		int	viznum,
		int	width,
		int	height
	)

static

Static method used to add a new Viz Win to the list of viz windows If the specified visualizer already exists returns -1. Otherwise returns the window index, which is the total number of visualizers minus 1.

Parameters

[in]	const	char* name of window
[in]	int	visualizer index (as returned by ControlExec::NewVisualizer)
[in]	width	desired width
[in]	height	desired height

Return values

int	window index associated with this visualizer

static ParamsBase* VAPoR::VizWinParams::CreateDefaultInstance ( )

inlinestatic

Required static method (for extensibility):

Return values

ParamsBase* pointer to a default Params instance

Definition at line 193 of file vizwinparams.h.

static int VAPoR::VizWinParams::GetCurrentVizWin ( )

inlinestatic

Static method identifies the current visualizer

Return values

visualizer index

Definition at line 75 of file vizwinparams.h.

int VAPoR::VizWinParams::getCurrentVizWin ( )

inline

Non-static method identifies the current visualizer. Only needed for Undo/Redo

Return values

visualizer index

Definition at line 206 of file vizwinparams.h.

static int VAPoR::VizWinParams::GetNumVizWins ( )

inlinestatic

Static method indicates how many windows exist

Return values

returns the number of available windows.

Definition at line 147 of file vizwinparams.h.

const std::string VAPoR::VizWinParams::getShortName ( )

inlinevirtual

Pure virtual method on Params. Provide a short name suitable for use in the GUI

Return values

string name

Implements VAPoR::Params.

Definition at line 196 of file vizwinparams.h.

static vector<long> VAPoR::VizWinParams::GetVisualizerNums ( )

inlinestatic

Static method returns a vector of visualizer indices indicating the visualizer numbers being used in this session

Definition at line 152 of file vizwinparams.h.

vector<long> VAPoR::VizWinParams::getVisualizerNums ( )

inline

Method returns a vector of visualizer indices indicating the visualizer numbers being used in the session associated with this current VizWinParams instance

Definition at line 200 of file vizwinparams.h.

static string VAPoR::VizWinParams::GetVizName ( int viznum )

inlinestatic

Static method obtains the name of the specified visualizer

Parameters

[in] winnum is the visualizer index.

Return values

0	if successful

Definition at line 139 of file vizwinparams.h.

static int VAPoR::VizWinParams::GetWindowHeight ( int viznum )

inlinestatic

Static method identifies the height of the specified visualizer

Parameters

[in] winnum is the visualizer index.

Return values

width of window, or -1 if it does not exist.

Definition at line 96 of file vizwinparams.h.

static int VAPoR::VizWinParams::GetWindowWidth ( int viznum )

inlinestatic

Static method identifies the width of the specified visualizer

Parameters

[in] winnum is the visualizer index.

Return values

width of window, or -1 if it does not exist.

Definition at line 87 of file vizwinparams.h.

static int VAPoR::VizWinParams::RemoveVizWin ( int viz )

static

Static method used to remove a Viz Win from the list of viz windows

Parameters

[in] index is visualizer index associated with the window

Return values

int	indicates 0 if successful

virtual void VAPoR::VizWinParams::restart ( )

virtual

Method to initialize a new VizWinParams instance.

Implements VAPoR::Params.

static int VAPoR::VizWinParams::SetCurrentVizWin ( int viz )

inlinestatic

Static method makes a visualizer current

Parameters

[in] int t current viz win

Return values

0	if successful.

Definition at line 81 of file vizwinparams.h.

static void VAPoR::VizWinParams::SetVizDirty	(	int	viznum,
		bool	val = `true`
	)

inlinestatic

Static method sets a dirty bit on a visualizer, indicating the need to re-render

Parameters

[in]	viznum	visualizer index, or -1 to dirty them all.
[in]	optional	bool argument indicates the value to be set

Definition at line 159 of file vizwinparams.h.

static int VAPoR::VizWinParams::SetVizName	(	int	viznum,
		string	name
	)

inlinestatic

Static method specifies the name of the specified visualizer Note that names with embedded underscores will have these characters converted to blanks.

Parameters

[in] winnum is the visualizer index.

Return values

0	if successful

Definition at line 129 of file vizwinparams.h.

static int VAPoR::VizWinParams::SetWindowHeight	(	int	viznum,
		int	height
	)

inlinestatic

Static method sets the height of the specified visualizer

Parameters

[in]	viznum	is the visualizer index.
[in]	width	is window width

Return values

0	if successful

Definition at line 117 of file vizwinparams.h.

static int VAPoR::VizWinParams::SetWindowWidth	(	int	viznum,
		int	width
	)

inlinestatic

Static method sets the width of the specified visualizer

Parameters

[in]	viznum	is the visualizer index.
[in]	width	is window width

Return values

0	if successful

Definition at line 106 of file vizwinparams.h.

virtual void VAPoR::VizWinParams::Validate ( int type )

virtual

Method to validate all values in a VizWinParams instance

Parameters

[in] type indicates whether or not to set to default values associated with the current DataMgr, or if the DataMgr has not changed

See also: DataMgr

Implements VAPoR::Params.

static bool VAPoR::VizWinParams::VizIsDirty ( int viznum )

inlinestatic

Static method to query status of dirty bits on a particular visualizer

Parameters

[in] viznum Index of visualizer being checked

Returns: bool true if visualizer is dirty.

Definition at line 168 of file vizwinparams.h.

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

/Users/clyne/src/vapor-3.0/lib/params/vizwinparams.h

Static Public Member Functions

Internal

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation