Configuration Class Reference

This is the one and only configuration object. More...

#include <configuration.h>

List of all members.

Public Member Functions

void read ()
 Reads the configuration data from the application config file.
void write () const
 Writes the configuration data to the application config file.
void setScreenGain (float gain)
 Sets the screen gain in milivolts by centimeters used to display the field potentiels.
void setVoltageRange (int value)
 Sets the voltage range of the acquisition system in milivolts.
void setAmplification (int value)
 Sets the amplification of the acquisition system.
void setBackgroundColor (QColor color)
 Sets the background color.
void setPaletteHeaders (bool show)
 Sets the display of the palette headers.
void setNbChannels (int nb)
 Sets the number of channels.
void setDatSamplingRate (double rate)
 Sets the sampling rate for the dat file.
void setEegSamplingRate (double rate)
 Sets the sampling rate for the eeg file.
void setOffset (int offset)
 Sets the initial offset for all the field potentials.
void setResolutionIndex (int index)
 Sets the resolution of the acquisition system.
void setEventPosition (int position)
 Sets the event position, in percentage from the begining of the window, where the events are display when browsing.
void setClusterPosition (int position)
 Sets the cluster position, in percentage from the begining of the window, where the clusters are display when browsing.
void setNbSamples (int nb)
 Sets the number of samples per spike waveform.
void setPeakIndex (int index)
 Sets the index of the peak sample in the spike waveform.
void setSamplingRate (double rate)
 Sets the video acquisition sampling rate.
void setWidth (int width)
 Sets the video image width.
void setHeight (int height)
 Sets the video image height.
void setBackgroundImage (QString image)
 Sets the background image for the position view.
void setRotation (int angle)
 Sets the video image rotation angle.
void setFlip (int index)
 Sets the video image flip orientation.
void setPositionsBackground (int drawPositions)
 All the positions contained in a position file can be used to create a background image for the PositionView.
void setTraceBackgroundImage (QString image)
 Sets the background image for the trace view.
float getScreenGain () const
 Returns the screen gain in milivolts by centimeters used to display the field potentiels.
int getVoltageRange () const
 Returns the voltage range of the acquisition system in volts.
int getAmplification () const
 Returns the amplification of the acquisition system.
QColor getBackgroundColor () const
 Returns the background color.
bool isPaletteHeadersDisplayed () const
 Returns true if the palette headers are displayed, false othewise.
int getNbChannels () const
 Returns the number of channels.
double getDatSamplingRate () const
 Returns sampling rate for the dat file.
double getEegSamplingRate () const
 Returns sampling rate for the eeg file.
int getOffset () const
 Returns the initial offset for all the field potentials.
int getResolution () const
 Returns the resolution of the acquisition system.
int getResolutionIndex () const
 Returns the index corresponding to there solution of the acquisition system.
QString getTraceBackgroundImage () const
 Returns the background image for the TraceView.
int getEventPosition () const
 Returns the event position, in percentage from the begining of the window, where the events are display when browsing.
int getClusterPosition () const
 Returns the cluster position, in percentage from the begining of the window, where the clusters are display when browsing.
int getNbSamples () const
 Returns the number of samples per spike waveform.
int getPeakIndex () const
 Returns the index of the peak sample in the spike waveform.
double getVideoSamplingRate () const
 Returns the video acquisition sampling rate.
int getWidth () const
 Returns the video image width.
int getHeight () const
 Returns the video image height.
QString getBackgroundImage () const
 Returns the background image.
int getRotation () const
 Returns the video image rotation angle.
int getFlip () const
 Returns the video image flip orientation.
bool getPositionsBackground () const
 All the positions contained in a position file can be used to create a background image for the PositionView.
float getScreenGainDefault () const
 Returns the default screen gain in milivolts by centimeters used to display the field potentiels.
int getVoltageRangeDefault () const
 Returns the default voltage range of the acquisition system in volts.
int getAmplificationDefault () const
 Returns the default amplification of the acquisition system.
QColor getBackgroundColorDefault () const
 Returns the default background color.
bool isPaletteHeadersDisplayedDefault () const
 Returns the default value for the display of the palette headers, true if the palette headers are displayed, false othewise.
int getNbChannelsDefault () const
 Returns the default number of channels.
double getDatSamplingRateDefault () const
 Returns the default sampling rate for the dat file.
double getEegSamplingRateDefault () const
 Returns the default sampling rate for the eeg file.
int getOffsetDefault () const
 Returns the default initial offset for all the field potentials.
int getResolutionIndexDefault () const
 Returns the index corresponding to the default resolution of the acquisition system.
int getEventPositionDefault () const
 Returns the default event position, in percentage from the begining of the window, where the events are display when browsing.
int getClusterPositionDefault () const
 Returns the default cluster position, in percentage from the begining of the window, where the clusters are display when browsing.
int getNbSamplesDefault () const
 Returns the default number of samples per spike waveform.
int getPeakIndexDefault () const
 Returns the default index of the peak sample in the spike waveform.
double getVideoSamplingRateDefault () const
 Returns the default video acquisition sampling rate.
int getWidthDefault () const
 Returns the default video image width.
int getHeightDefault () const
 Returns the default video image height.
QString getBackgroundImageDefault () const
 Returns the default background image.
int getRotationDefault () const
 Returns the default video image rotation angle.
int getFlipDefault () const
 Returns the default video image flip orientation.
bool getPositionsBackgroundDefault () const
 All the positions contained in a position file can be used to create a background image for the PositionView.
void read ()
 Reads the configuration data from the application config file.
void write () const
 Writes the configuration data to the application config file.
void setScreenGain (float gain)
 Sets the screen gain in milivolts by centimeters used to display the field potentiels.
void setVoltageRange (int value)
 Sets the voltage range of the acquisition system in milivolts.
void setAmplification (int value)
 Sets the amplification of the acquisition system.
void setBackgroundColor (QColor color)
 Sets the background color.
void setPaletteHeaders (bool show)
 Sets the display of the palette headers.
void setNbChannels (int nb)
 Sets the number of channels.
void setDatSamplingRate (double rate)
 Sets the sampling rate for the dat file.
void setEegSamplingRate (double rate)
 Sets the sampling rate for the eeg file.
void setOffset (int offset)
 Sets the initial offset for all the field potentials.
void setResolutionIndex (int index)
 Sets the resolution of the acquisition system.
void setEventPosition (int position)
 Sets the event position, in percentage from the begining of the window, where the events are display when browsing.
void setClusterPosition (int position)
 Sets the cluster position, in percentage from the begining of the window, where the clusters are display when browsing.
void setNbSamples (int nb)
 Sets the number of samples per spike waveform.
void setPeakIndex (int index)
 Sets the index of the peak sample in the spike waveform.
void setSamplingRate (double rate)
 Sets the video acquisition sampling rate.
void setWidth (int width)
 Sets the video image width.
void setHeight (int height)
 Sets the video image height.
void setBackgroundImage (QString image)
 Sets the background image for the position view.
void setRotation (int angle)
 Sets the video image rotation angle.
void setFlip (int index)
 Sets the video image flip orientation.
void setPositionsBackground (int drawPositions)
 All the positions contained in a position file can be used to create a background image for the PositionView.
void setTraceBackgroundImage (QString image)
 Sets the background image for the trace view.
float getScreenGain () const
 Returns the screen gain in milivolts by centimeters used to display the field potentiels.
int getVoltageRange () const
 Returns the voltage range of the acquisition system in volts.
int getAmplification () const
 Returns the amplification of the acquisition system.
QColor getBackgroundColor () const
 Returns the background color.
bool isPaletteHeadersDisplayed () const
 Returns true if the palette headers are displayed, false othewise.
int getNbChannels () const
 Returns the number of channels.
double getDatSamplingRate () const
 Returns sampling rate for the dat file.
double getEegSamplingRate () const
 Returns sampling rate for the eeg file.
int getOffset () const
 Returns the initial offset for all the field potentials.
int getResolution () const
 Returns the resolution of the acquisition system.
int getResolutionIndex () const
 Returns the index corresponding to there solution of the acquisition system.
QString getTraceBackgroundImage () const
 Returns the background image for the TraceView.
int getEventPosition () const
 Returns the event position, in percentage from the begining of the window, where the events are display when browsing.
int getClusterPosition () const
 Returns the cluster position, in percentage from the begining of the window, where the clusters are display when browsing.
int getNbSamples () const
 Returns the number of samples per spike waveform.
int getPeakIndex () const
 Returns the index of the peak sample in the spike waveform.
double getVideoSamplingRate () const
 Returns the video acquisition sampling rate.
int getWidth () const
 Returns the video image width.
int getHeight () const
 Returns the video image height.
QString getBackgroundImage () const
 Returns the background image.
int getRotation () const
 Returns the video image rotation angle.
int getFlip () const
 Returns the video image flip orientation.
bool getPositionsBackground () const
 All the positions contained in a position file can be used to create a background image for the PositionView.
float getScreenGainDefault () const
 Returns the default screen gain in milivolts by centimeters used to display the field potentiels.
int getVoltageRangeDefault () const
 Returns the default voltage range of the acquisition system in volts.
int getAmplificationDefault () const
 Returns the default amplification of the acquisition system.
QColor getBackgroundColorDefault () const
 Returns the default background color.
bool isPaletteHeadersDisplayedDefault () const
 Returns the default value for the display of the palette headers, true if the palette headers are displayed, false othewise.
int getNbChannelsDefault () const
 Returns the default number of channels.
double getDatSamplingRateDefault () const
 Returns the default sampling rate for the dat file.
double getEegSamplingRateDefault () const
 Returns the default sampling rate for the eeg file.
int getOffsetDefault () const
 Returns the default initial offset for all the field potentials.
int getResolutionIndexDefault () const
 Returns the index corresponding to the default resolution of the acquisition system.
int getEventPositionDefault () const
 Returns the default event position, in percentage from the begining of the window, where the events are display when browsing.
int getClusterPositionDefault () const
 Returns the default cluster position, in percentage from the begining of the window, where the clusters are display when browsing.
int getNbSamplesDefault () const
 Returns the default number of samples per spike waveform.
int getPeakIndexDefault () const
 Returns the default index of the peak sample in the spike waveform.
double getVideoSamplingRateDefault () const
 Returns the default video acquisition sampling rate.
int getWidthDefault () const
 Returns the default video image width.
int getHeightDefault () const
 Returns the default video image height.
QString getBackgroundImageDefault () const
 Returns the default background image.
int getRotationDefault () const
 Returns the default video image rotation angle.
int getFlipDefault () const
 Returns the default video image flip orientation.
bool getPositionsBackgroundDefault () const
 All the positions contained in a position file can be used to create a background image for the PositionView.

Friends

Configurationconfiguration ()
 Returns a reference to the application configuration object.
Configurationconfiguration ()
 Returns a reference to the application configuration object.


Detailed Description

This is the one and only configuration object.

The member functions read() and write() can be used to load and save the properties to the application configuration file.

Author:
Lynn Hazan


Member Function Documentation

void Configuration::read (  ) 

Reads the configuration data from the application config file.

If a property does not already exist in the config file it will be set to a default value.

void Configuration::setPositionsBackground ( int  drawPositions  )  [inline]

All the positions contained in a position file can be used to create a background image for the PositionView.

This function sets if such background has to be created.

int Configuration::getFlip (  )  const [inline]

Returns the video image flip orientation.

0 stands for none, 1 for vertical and 2 for horizontal.

bool Configuration::getPositionsBackground (  )  const [inline]

All the positions contained in a position file can be used to create a background image for the PositionView.

The value return by this function tells if such background has to be created.

Returns:
true if the all the positions contain in the position file have to be drawn on the background, false otherwise.

int Configuration::getFlipDefault (  )  const [inline]

Returns the default video image flip orientation.

0 stands for none, 1 for vertical and 2 for horizontal.

bool Configuration::getPositionsBackgroundDefault (  )  const [inline]

All the positions contained in a position file can be used to create a background image for the PositionView.

The value return by this function tells if the default is to create such background.

Returns:
true if the all the positions contain in the position file have to be drawn on the background, false otherwise.

void Configuration::read (  ) 

Reads the configuration data from the application config file.

If a property does not already exist in the config file it will be set to a default value.

void Configuration::setPositionsBackground ( int  drawPositions  )  [inline]

All the positions contained in a position file can be used to create a background image for the PositionView.

This function sets if such background has to be created.

int Configuration::getFlip (  )  const [inline]

Returns the video image flip orientation.

0 stands for none, 1 for vertical and 2 for horizontal.

bool Configuration::getPositionsBackground (  )  const [inline]

All the positions contained in a position file can be used to create a background image for the PositionView.

The value return by this function tells if such background has to be created.

Returns:
true if the all the positions contain in the position file have to be drawn on the background, false otherwise.

int Configuration::getFlipDefault (  )  const [inline]

Returns the default video image flip orientation.

0 stands for none, 1 for vertical and 2 for horizontal.

bool Configuration::getPositionsBackgroundDefault (  )  const [inline]

All the positions contained in a position file can be used to create a background image for the PositionView.

The value return by this function tells if the default is to create such background.

Returns:
true if the all the positions contain in the position file have to be drawn on the background, false otherwise.


The documentation for this class was generated from the following files:
Generated on Mon Sep 17 20:47:31 2007 for NeuroScope by  doxygen 1.5.1