---

improvConfig Class Reference

Stores all config values for easy access by all objects. More...

#include <improvConfig.h>

Public Methods
	improvConfig ()
	Constructor. More...
	~improvConfig ()
	Destructor. More...
void	load (int argc, char **argv)
	Load configuration values for the command line arguments. More...
void	loadDefaults (void)
	Load default configuration values. More...
bool	load (void)
	Loads config from the default file (~/CONFIG_FILENAME). More...
bool	load (char *filename)
	Loads config from a file. More...
bool	save (void)
	Saves config to the default file (~/CONFIG_FILENAME). More...
bool	saveAs (char *filename)
	Saves config to a file. More...
void	clear (void)
	Clear (or reset) all configuration details. More...
void	clearLayout (void)
	Clear (or reset) only the configuration details to do with layout. More...
void	setSequencePath (char *sequencePath)
	Set the sequence path. More...
char *	getSequencePath (void)
	Get the sequence path. More...
void	addPluginPath (char *pluginPath)
	Set the plugin path. More...
int	getNumPluginPaths (void)
	Return the number of plugin paths. More...
char *	getPluginPath (int num)
	Get a plugin path. More...
void	clearPluginPaths (void)
	Removes all plugin paths from the configuration. More...
void	setWindowWidth (int width)
	Set the window width. More...
int	getWindowWidth (void)
	Get the window width. More...
void	setWindowHeight (int height)
	Set the window height. More...
int	getWindowHeight (void)
	Get the window height. More...
void	setNumSources (int number)
	Set the number of image windows. More...
int	getNumSources (void)
	Get the number of windows. More...
void	setNumWindows (int number)
	Set the number of image windows. More...
int	getNumWindows (void)
	Get the number of windows. More...
void	setUseSequence (char *name)
	Set the sequence to start with. More...
char *	getUseSequence (void)
	Get the sequence that was started with. More...
void	setCameraType (imageSeqType camera)
	Set the type of camera. More...
imageSeqType	getCameraType (void)
	Get the type of camera. More...
bool	isModified (void)
	Return whether the config has been modified or not. More...
void	setModified (bool on)
	Set whether the configuration has been modified or not. More...
widgetConfig *	getWidgetConfig (int posn)
	Return the widget configuration for a given position. More...

---

Detailed Description

Stores all config values for easy access by all objects.

An instance of this class is created and maintained by the global singleton class 'Improv'.

See also:

Improv

---

Constructor & Destructor Documentation

improvConfig::improvConfig (    )

Constructor.

improvConfig::~improvConfig (    )

Destructor. Deletes the instance of the class.

---

Member Function Documentation

void improvConfig::addPluginPath (  char *    pluginPath )

Set the plugin path. Parameters: pluginPath  desired plugin path

void improvConfig::clear (  void    )

Clear (or reset) all configuration details.

void improvConfig::clearLayout (  void    )

Clear (or reset) only the configuration details to do with layout.

void improvConfig::clearPluginPaths (  void    )

Removes all plugin paths from the configuration.

imageSeqType improvConfig::getCameraType (  void    )

Get the type of camera. Returns: enum of imageSeqType

int improvConfig::getNumPluginPaths (  void    )

Return the number of plugin paths. Returns: The number of plugin paths.

int improvConfig::getNumSources (  void    )

Get the number of windows. Returns: number of windows

int improvConfig::getNumWindows (  void    )

Get the number of windows. Returns: number of windows

char * improvConfig::getPluginPath (  int    num )

Get a plugin path. Parameters: num  The plugin path to return. Returns: The plugin path.

char * improvConfig::getSequencePath (  void    )

Get the sequence path. Returns: sequence path

char * improvConfig::getUseSequence (  void    )

Get the sequence that was started with.

improvConfig::widgetConfig * improvConfig::getWidgetConfig (  int    posn )

Return the widget configuration for a given position. Parameters: posn  The position of the widget. Returns: The widget configuration See also: widgetConfig

int improvConfig::getWindowHeight (  void    )

Get the window height. Returns: window height

int improvConfig::getWindowWidth (  void    )

Get the window width. Returns: window width

bool improvConfig::isModified (  void    )

Return whether the config has been modified or not. Returns: True if the configuration has been modified since initialisation of the application, false otherwise.

bool improvConfig::load (  char *    filename )

Loads config from a file. Returns: true if successfully saved, false if it failed.

bool improvConfig::load (  void    )

Loads config from the default file (~/CONFIG_FILENAME). Returns: true if successfully saved, false if it failed.

void improvConfig::load (  int    argc, char **    argv )

Load configuration values for the command line arguments. Parameters: argc  The number of command line arguments. argv  The command line arguments.

void improvConfig::loadDefaults (  void    )

Load default configuration values.

bool improvConfig::save (  void    )

Saves config to the default file (~/CONFIG_FILENAME). Returns: true if successfully saved, false if it failed.

bool improvConfig::saveAs (  char *    filename )

Saves config to a file. Returns: true if successfully saved, false if it failed.

void improvConfig::setCameraType (  imageSeqType    camera )

Set the type of camera.

void improvConfig::setModified (  bool    on )

Set whether the configuration has been modified or not. Parameters: on  bool value.

void improvConfig::setNumSources (  int    number )

Set the number of image windows. Parameters: number  number of windows

void improvConfig::setNumWindows (  int    number )

Set the number of image windows. Parameters: number  number of windows

void improvConfig::setSequencePath (  char *    sequencePath )

Set the sequence path. Parameters: sequencePath  desired sequence path

void improvConfig::setUseSequence (  char *    name )

Set the sequence to start with.

void improvConfig::setWindowHeight (  int    height )

Set the window height. Parameters: height  desired window height

void improvConfig::setWindowWidth (  int    width )

Set the window width. Parameters: width  desired window width

---

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

• improvConfig.h
• improvConfig.cpp

---