SettingsParams Class Reference

A class for describing settings at settings. More...

#include <SettingsParams.h>

Inheritance diagram for SettingsParams:

Public Member Functions
	SettingsParams (VAPoR::ParamsBase::StateSave *ssave, bool loadFromFile=true)
	SettingsParams (VAPoR::ParamsBase::StateSave *ssave, VAPoR::XmlNode *node)
	SettingsParams (const SettingsParams &rhs)
SettingsParams &	operator= (const SettingsParams &rhs)
void	Init ()
	~SettingsParams ()
int	GetNumThreads () const
void	SetNumThreads (int num)
long	GetCacheMB () const
void	SetCacheMB (long val)
long	GetTextureSize () const
void	SetTextureSize (long val)
void	SetTexSizeEnable (bool val)
bool	GetTexSizeEnable () const
bool	GetAutoStretchEnabled () const
void	SetAutoStretchEnabled (bool val)
int	GetJpegQuality () const
void	SetJpegQuality (int quality)
bool	GetSessionAutoSaveEnabled () const
void	SetSessionAutoSaveEnabled (bool enabled)
int	GetChangesPerAutoSave () const
void	SetChangesPerAutoSave (int changes)
string	GetAutoSaveSessionFile () const
void	SetAutoSaveSessionFile (string file)
void	SetDefaultAutoSaveFile (string file)
string	GetSessionDir () const
void	SetSessionDir (string name)
string	GetDefaultSessionDir () const
void	SetDefaultSessionDir (string dir)
string	GetMetadataDir () const
void	SetMetadataDir (string dir)
string	GetDefaultMetadataDir () const
void	SetDefaultMetadataDir (string dir)
string	GetTFDir () const
void	SetTFDir (string dir)
string	GetDefaultTFDir () const
void	SetDefaultTFDir (string dir)
string	GetFlowDir () const
void	SetFlowDir (string dir)
string	GetDefaultFlowDir () const
void	SetDefaultFlowDir (string dir)
string	GetPythonDir () const
void	SetPythonDir (string dir)
string	GetDefaultPythonDir () const
void	SetDefaultPythonDir (string dir)
int	GetFontSize () const
void	SetFontSize (int size)
string	GetFontFile () const
void	SetFontFile (string file)
bool	GetDontShowIntelDriverWarning () const
void	SetDontShowIntelDriverWarning (bool b)
string	GetCurrentPrefsPath () const
void	SetCurrentPrefsPath (string pth)
void	Reinit ()
const std::string	getShortName ()
void	SetFidelityDefault3D (long lodDef, long refDef)
void	SetFidelityDefault2D (long lodDef, long refDef)
int	SaveSettings () const
std::string	GetSettingsPath () const
void	SetAutoCheckForUpdates (bool b)
bool	GetAutoCheckForUpdates () const
void	SetAutoCheckForNotices (bool b)
bool	GetAutoCheckForNotices () const
void	SetCasperCheckForVGL (bool b)
bool	GetCasperCheckForVGL () const
bool	LoadFromSettingsFile ()
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	_sessionAutoSaveEnabledTag
static const string	UseAllCoresTag
static const string	AutoCheckForUpdatesTag
static const string	AutoCheckForNoticesTag
static const string	CasperVGLCheck
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 settings at settings.

The SettingsParams class controls various features set when the application starts. There is only a global SettingsParams, that is used throughout the application

Authors

Scott Pearse, Alan Norton

Version

3.0

Date

February 2018

Definition at line 40 of file SettingsParams.h.

Constructor & Destructor Documentation

SettingsParams() [1/3]

SettingsParams::SettingsParams	(	VAPoR::ParamsBase::StateSave *	ssave,
		bool	loadFromFile = true
	)

SettingsParams() [2/3]

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

SettingsParams() [3/3]

SettingsParams::SettingsParams

(

const SettingsParams &

rhs

)

~SettingsParams()

SettingsParams::~SettingsParams

(

)

Member Function Documentation

GetAutoCheckForNotices()

bool SettingsParams::GetAutoCheckForNotices

(

)

const

GetAutoCheckForUpdates()

bool SettingsParams::GetAutoCheckForUpdates

(

)

const

GetAutoSaveSessionFile()

string SettingsParams::GetAutoSaveSessionFile

(

)

const

GetAutoStretchEnabled()

bool SettingsParams::GetAutoStretchEnabled

(

)

const

GetCacheMB()

long SettingsParams::GetCacheMB

(

)

const

GetCasperCheckForVGL()

bool SettingsParams::GetCasperCheckForVGL

(

)

const

GetChangesPerAutoSave()

int SettingsParams::GetChangesPerAutoSave

(

)

const

GetClassType()

static string SettingsParams::GetClassType ( )

inlinestatic

Definition at line 121 of file SettingsParams.h.

GetCurrentPrefsPath()

string SettingsParams::GetCurrentPrefsPath

(

)

const

GetDefaultFlowDir()

string SettingsParams::GetDefaultFlowDir

(

)

const

GetDefaultMetadataDir()

string SettingsParams::GetDefaultMetadataDir

(

)

const

GetDefaultPythonDir()

string SettingsParams::GetDefaultPythonDir

(

)

const

GetDefaultSessionDir()

string SettingsParams::GetDefaultSessionDir

(

)

const

GetDefaultTFDir()

string SettingsParams::GetDefaultTFDir

(

)

const

GetDontShowIntelDriverWarning()

bool SettingsParams::GetDontShowIntelDriverWarning

(

)

const

GetFlowDir()

string SettingsParams::GetFlowDir

(

)

const

GetFontFile()

string SettingsParams::GetFontFile

(

)

const

GetFontSize()

int SettingsParams::GetFontSize

(

)

const

GetJpegQuality()

int SettingsParams::GetJpegQuality

(

)

const

GetMetadataDir()

string SettingsParams::GetMetadataDir

(

)

const

GetNumThreads()

int SettingsParams::GetNumThreads

(

)

const

GetPythonDir()

string SettingsParams::GetPythonDir

(

)

const

GetSessionAutoSaveEnabled()

bool SettingsParams::GetSessionAutoSaveEnabled

(

)

const

GetSessionDir()

string SettingsParams::GetSessionDir

(

)

const

GetSettingsPath()

std::string SettingsParams::GetSettingsPath

(

)

const

getShortName()

const std::string SettingsParams::getShortName ( )

inline

Definition at line 116 of file SettingsParams.h.

GetTexSizeEnable()

bool SettingsParams::GetTexSizeEnable

(

)

const

GetTextureSize()

long SettingsParams::GetTextureSize

(

)

const

GetTFDir()

string SettingsParams::GetTFDir

(

)

const

Init()

void SettingsParams::Init

(

)

LoadFromSettingsFile()

bool SettingsParams::LoadFromSettingsFile

(

)

operator=()

SettingsParams & SettingsParams::operator=

(

const SettingsParams &

rhs

)

Reinit()

void SettingsParams::Reinit

(

)

SaveSettings()

int SettingsParams::SaveSettings

(

)

const

SetAutoCheckForNotices()

void SettingsParams::SetAutoCheckForNotices

(

bool

b

)

SetAutoCheckForUpdates()

void SettingsParams::SetAutoCheckForUpdates

(

bool

b

)

SetAutoSaveSessionFile()

void SettingsParams::SetAutoSaveSessionFile

(

string

file

)

SetAutoStretchEnabled()

void SettingsParams::SetAutoStretchEnabled

(

bool

val

)

SetCacheMB()

void SettingsParams::SetCacheMB

(

long

val

)

SetCasperCheckForVGL()

void SettingsParams::SetCasperCheckForVGL

(

bool

b

)

SetChangesPerAutoSave()

void SettingsParams::SetChangesPerAutoSave

(

int

changes

)

SetCurrentPrefsPath()

void SettingsParams::SetCurrentPrefsPath

(

string

pth

)

SetDefaultAutoSaveFile()

void SettingsParams::SetDefaultAutoSaveFile

(

string

file

)

SetDefaultFlowDir()

void SettingsParams::SetDefaultFlowDir

(

string

dir

)

SetDefaultMetadataDir()

void SettingsParams::SetDefaultMetadataDir

(

string

dir

)

SetDefaultPythonDir()

void SettingsParams::SetDefaultPythonDir

(

string

dir

)

SetDefaultSessionDir()

void SettingsParams::SetDefaultSessionDir

(

string

dir

)

SetDefaultTFDir()

void SettingsParams::SetDefaultTFDir

(

string

dir

)

SetDontShowIntelDriverWarning()

void SettingsParams::SetDontShowIntelDriverWarning

(

bool

b

)

SetFidelityDefault2D()

void SettingsParams::SetFidelityDefault2D	(	long	lodDef,
		long	refDef
	)

SetFidelityDefault3D()

void SettingsParams::SetFidelityDefault3D	(	long	lodDef,
		long	refDef
	)

SetFlowDir()

void SettingsParams::SetFlowDir

(

string

dir

)

SetFontFile()

void SettingsParams::SetFontFile

(

string

file

)

SetFontSize()

void SettingsParams::SetFontSize

(

int

size

)

SetJpegQuality()

void SettingsParams::SetJpegQuality

(

int

quality

)

SetMetadataDir()

void SettingsParams::SetMetadataDir

(

string

dir

)

SetNumThreads()

void SettingsParams::SetNumThreads

(

int

num

)

SetPythonDir()

void SettingsParams::SetPythonDir

(

string

dir

)

SetSessionAutoSaveEnabled()

void SettingsParams::SetSessionAutoSaveEnabled

(

bool

enabled

)

SetSessionDir()

void SettingsParams::SetSessionDir

(

string

name

)

SetTexSizeEnable()

void SettingsParams::SetTexSizeEnable

(

bool

val

)

SetTextureSize()

void SettingsParams::SetTextureSize

(

long

val

)

SetTFDir()

void SettingsParams::SetTFDir

(

string

dir

)

Member Data Documentation

_sessionAutoSaveEnabledTag

const string SettingsParams::_sessionAutoSaveEnabledTag

static

Definition at line 125 of file SettingsParams.h.

AutoCheckForNoticesTag

const string SettingsParams::AutoCheckForNoticesTag

static

Definition at line 138 of file SettingsParams.h.

AutoCheckForUpdatesTag

const string SettingsParams::AutoCheckForUpdatesTag

static

Definition at line 137 of file SettingsParams.h.

CasperVGLCheck

const string SettingsParams::CasperVGLCheck

static

Definition at line 139 of file SettingsParams.h.

UseAllCoresTag

const string SettingsParams::UseAllCoresTag

static

Definition at line 136 of file SettingsParams.h.

---

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

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