DisplayInformation Class Reference

Class storing the session information to be read from or write to a session file. More...

#include <sessionInformation.h>

List of all members.

Public Types
enum	spikeDisplayType {   RASTER = 0, WAVEFORMS = 1, LINES = 2, RASTER = 0,   WAVEFORMS = 1, LINES = 2 }
	Type of spike display.
enum	mode { SINGLE = 0, MULTIPLE = 1, SINGLE = 0, MULTIPLE = 1 }
	Presentation mode.
enum	spikeDisplayType {   RASTER = 0, WAVEFORMS = 1, LINES = 2, RASTER = 0,   WAVEFORMS = 1, LINES = 2 }
	Type of spike display.
enum	mode { SINGLE = 0, MULTIPLE = 1, SINGLE = 0, MULTIPLE = 1 }
	Presentation mode.
Public Member Functions
	DisplayInformation ()
	Constructor, sets defaults: mode of presentation is set to single, the presentation of the labels is set to hide, the grey-scale is set to unused, the start time is set to 0, the duration is set to 50 ms.
void	addSpikeDisplayType (spikeDisplayType type)
	Adds a type of spike display (see DisplayInformation::displayType).
void	setMode (mode modeOfPresentation)
	Sets the mode of presentation (see DisplayInformation::mode).
void	setRasterHeight (int height)
	Sets the height of the rasters.
void	setGreyScale (int value)
	Sets the grey-scale value.
void	setSelectedClusters (QString clusterFile, QValueList< int > clusterIds)
	Sets the selected clusters by cluster file.
void	setSelectedEvents (QString eventFile, QValueList< int > eventIds)
	Sets the selected events by event file.
void	setSkippedClusters (QString clusterFile, QValueList< int > clusterIds)
	Sets the skipped clusters by cluster file.
void	setSkippedEvents (QString eventFile, QValueList< int > eventIds)
	Sets the skipped events by event file.
void	setSelectedSpikeFiles (QValueList< QString > files)
	Sets the list of the spike files shown in the display (without cluster file associated).
void	setPositions (QValueList< TracePosition > positions)
	Sets the list of TracePosition.
void	setChannelIds (QValueList< int > ids)
	Sets the list of channel ids shown in the display.
void	setSelectedChannelIds (QValueList< int > ids)
	Sets the list channel ids selected in the display.
void	setStartTime (long start)
	Sets the starting time in miliseconds.
void	setTimeWindow (long duration)
	Sets the time window in miliseconds.
void	setTabLabel (QString newLabel)
	Sets the label for the display when in tab page mode.
void	setLabelStatus (int value)
	Sets if the labels next to the traces have to be displayed.
void	setPositionView (int present)
	Sets if a PositionView is displayed.
void	setEventsInPositionView (int shown)
	Sets if events are displayed in the PositionView.
QValueList< spikeDisplayType >	getSpikeDisplayTypes () const
	Gets the list of type of spike display used (see DisplayInformation::displayType).
mode	getMode () const
	Gets the mode of presentation (see DisplayInformation::mode).
int	getRasterHeight () const
	Gets the height of the rasters.
int	getGreyScale () const
	Gets the grey-scale value.
QMap< QString, QValueList< int > >	getSelectedClusters () const
	Gets the selected clusters by cluster file.
QMap< QString, QValueList< int > >	getSelectedEvents () const
	Gets the selected events by event file.
QMap< QString, QValueList< int > >	getSkippedClusters () const
	Gets the skipped clusters by cluster file.
QMap< QString, QValueList< int > >	getSkippedEvents () const
	Gets the skipped events by event file.
QValueList< QString >	getSelectedSpikeFiles () const
	Gets the list of the spike files shown in the display (without cluster file associated).
QValueList< TracePosition >	getPositions () const
	Gets the list of TracePosition.
QValueList< int >	getChannelIds () const
	Gets the list of channel ids shown in the display.
QValueList< int >	getSelectedChannelIds () const
	Gets the list channel ids selected in the display.
QString	getTabLabel () const
	Gets the label for the display when in tab page mode.
int	getLabelStatus () const
	Gets if the information as if the labels next to the traces have to be displayed.
long	getStartTime () const
	Gets the starting time in miliseconds.
long	getTimeWindow () const
	Gets the time window in miliseconds.
int	isAPositionView () const
	Returns if a PositionView is displayed in the view.
int	isEventsDisplayedInPositionView () const
	Returns if events are displayed in the PositionView.
	DisplayInformation ()
	Constructor, sets defaults: mode of presentation is set to single, the presentation of the labels is set to hide, the grey-scale is set to unused, the start time is set to 0, the duration is set to 50 ms.
void	addSpikeDisplayType (spikeDisplayType type)
	Adds a type of spike display (see DisplayInformation::displayType).
void	setMode (mode modeOfPresentation)
	Sets the mode of presentation (see DisplayInformation::mode).
void	setRasterHeight (int height)
	Sets the height of the rasters.
void	setGreyScale (int value)
	Sets the grey-scale value.
void	setSelectedClusters (QString clusterFile, QValueList< int > clusterIds)
	Sets the selected clusters by cluster file.
void	setSelectedEvents (QString eventFile, QValueList< int > eventIds)
	Sets the selected events by event file.
void	setSkippedClusters (QString clusterFile, QValueList< int > clusterIds)
	Sets the skipped clusters by cluster file.
void	setSkippedEvents (QString eventFile, QValueList< int > eventIds)
	Sets the skipped events by event file.
void	setSelectedSpikeFiles (QValueList< QString > files)
	Sets the list of the spike files shown in the display (without cluster file associated).
void	setPositions (QValueList< TracePosition > positions)
	Sets the list of TracePosition.
void	setChannelIds (QValueList< int > ids)
	Sets the list of channel ids shown in the display.
void	setSelectedChannelIds (QValueList< int > ids)
	Sets the list channel ids selected in the display.
void	setStartTime (long start)
	Sets the starting time in miliseconds.
void	setTimeWindow (long duration)
	Sets the time window in miliseconds.
void	setTabLabel (QString newLabel)
	Sets the label for the display when in tab page mode.
void	setLabelStatus (int value)
	Sets if the labels next to the traces have to be displayed.
void	setPositionView (int present)
	Sets if a PositionView is displayed.
void	setEventsInPositionView (int shown)
	Sets if events are displayed in the PositionView.
QValueList< spikeDisplayType >	getSpikeDisplayTypes () const
	Gets the list of type of spike display used (see DisplayInformation::displayType).
mode	getMode () const
	Gets the mode of presentation (see DisplayInformation::mode).
int	getRasterHeight () const
	Gets the height of the rasters.
int	getGreyScale () const
	Gets the grey-scale value.
QMap< QString, QValueList< int > >	getSelectedClusters () const
	Gets the selected clusters by cluster file.
QMap< QString, QValueList< int > >	getSelectedEvents () const
	Gets the selected events by event file.
QMap< QString, QValueList< int > >	getSkippedClusters () const
	Gets the skipped clusters by cluster file.
QMap< QString, QValueList< int > >	getSkippedEvents () const
	Gets the skipped events by event file.
QValueList< QString >	getSelectedSpikeFiles () const
	Gets the list of the spike files shown in the display (without cluster file associated).
QValueList< TracePosition >	getPositions () const
	Gets the list of TracePosition.
QValueList< int >	getChannelIds () const
	Gets the list of channel ids shown in the display.
QValueList< int >	getSelectedChannelIds () const
	Gets the list channel ids selected in the display.
QString	getTabLabel () const
	Gets the label for the display when in tab page mode.
int	getLabelStatus () const
	Gets if the information as if the labels next to the traces have to be displayed.
long	getStartTime () const
	Gets the starting time in miliseconds.
long	getTimeWindow () const
	Gets the time window in miliseconds.
int	isAPositionView () const
	Returns if a PositionView is displayed in the view.
int	isEventsDisplayedInPositionView () const
	Returns if events are displayed in the PositionView.

---

Detailed Description

Class storing the session information to be read from or write to a session file.

Author:

Lynn Hazan

---

Constructor & Destructor Documentation

DisplayInformation::DisplayInformation

(

)

[inline]

Constructor, sets defaults:

• mode of presentation is set to single,
• the presentation of the labels is set to hide,
• the grey-scale is set to unused,
• the start time is set to 0,
• the duration is set to 50 ms.

• the rasterHeight is set to -1 meaning no value defined.

DisplayInformation::DisplayInformation

(

)

[inline]

Constructor, sets defaults:

• mode of presentation is set to single,
• the presentation of the labels is set to hide,
• the grey-scale is set to unused,
• the start time is set to 0,
• the duration is set to 50 ms.

• the rasterHeight is set to -1 meaning no value defined.

---

Member Function Documentation

void DisplayInformation::addSpikeDisplayType

(

spikeDisplayType

type

)

[inline]

Adds a type of spike display (see DisplayInformation::displayType).

Parameters:

type

type of spike displays.

void DisplayInformation::setMode

(

mode

modeOfPresentation

)

[inline]

Sets the mode of presentation (see DisplayInformation::mode).

Parameters:

modeOfPresentation

mode of presentation.

void DisplayInformation::setRasterHeight

(

int

height

)

[inline]

Sets the height of the rasters.

Parameters:

height

height of the rasters.

void DisplayInformation::setGreyScale

(

int

value

)

[inline]

Sets the grey-scale value.

Parameters:

value

1 if the grey-scale is used to the view 0, otherwise.

void DisplayInformation::setSelectedClusters	(	QString	clusterFile,
		QValueList< int >	clusterIds
	)			[inline]

Sets the selected clusters by cluster file.

Parameters:

	clusterFile	cluster file url.
	clusterIds	list of selected cluster ids.

void DisplayInformation::setSelectedEvents	(	QString	eventFile,
		QValueList< int >	eventIds
	)			[inline]

Sets the selected events by event file.

Parameters:

	eventFile	event file url.
	eventIds	list of selected eventIds.

void DisplayInformation::setSkippedClusters	(	QString	clusterFile,
		QValueList< int >	clusterIds
	)			[inline]

Sets the skipped clusters by cluster file.

Parameters:

	clusterFile	cluster file url.
	clusterIds	list of cluster ids to skip while browsing.

void DisplayInformation::setSkippedEvents	(	QString	eventFile,
		QValueList< int >	eventIds
	)			[inline]

Sets the skipped events by event file.

Parameters:

	eventFile	event file url.
	eventIds	list of eventIds to skip while browsing.

void DisplayInformation::setSelectedSpikeFiles

(

QValueList< QString >

files

)

[inline]

Sets the list of the spike files shown in the display (without cluster file associated).

Parameters:

files

list of the spike files.

void DisplayInformation::setPositions

(

QValueList< TracePosition >

positions

)

[inline]

Sets the list of TracePosition.

Parameters:

positions

list of TracePosition.

void DisplayInformation::setChannelIds

(

QValueList< int >

ids

)

[inline]

Sets the list of channel ids shown in the display.

Parameters:

ids

list of channel ids.

void DisplayInformation::setSelectedChannelIds

(

QValueList< int >

ids

)

[inline]

Sets the list channel ids selected in the display.

Parameters:

ids

list of channel ids.

void DisplayInformation::setStartTime

(

long

start

)

[inline]

Sets the starting time in miliseconds.

Parameters:

start

starting time.

void DisplayInformation::setTimeWindow

(

long

duration

)

[inline]

Sets the time window in miliseconds.

Parameters:

duration

time window.

void DisplayInformation::setTabLabel

(

QString

newLabel

)

[inline]

Sets the label for the display when in tab page mode.

Parameters:

newLabel

the new label for the display.

void DisplayInformation::setLabelStatus

(

int

value

)

[inline]

Sets if the labels next to the traces have to be displayed.

Parameters:

value

1 if the labels are displayed in the view, 0 otherwise.

void DisplayInformation::setPositionView

(

int

present

)

[inline]

Sets if a PositionView is displayed.

Parameters:

present

1 if a PositionView is displayed in the view, 0 otherwise.

void DisplayInformation::setEventsInPositionView

(

int

shown

)

[inline]

Sets if events are displayed in the PositionView.

Parameters:

shown

1 if events are displayed in the PositionView, 0 otherwise.

QValueList<spikeDisplayType> DisplayInformation::getSpikeDisplayTypes

(

)

const [inline]

Gets the list of type of spike display used (see DisplayInformation::displayType).

Returns:

list of types of spike display.

mode DisplayInformation::getMode

(

)

const [inline]

Gets the mode of presentation (see DisplayInformation::mode).

Returns:

mode of presentation.

int DisplayInformation::getRasterHeight

(

)

const [inline]

Gets the height of the rasters.

Returns:

height of the rasters.

int DisplayInformation::getGreyScale

(

)

const [inline]

Gets the grey-scale value.

Returns:

grey-scale value, 1 if the grey-scale is used to the view 0 otherwise.

QMap<QString, QValueList<int> > DisplayInformation::getSelectedClusters

(

)

const [inline]

Gets the selected clusters by cluster file.

Returns:

map of the cluster file url with the list of selected clusterIds.

QMap<QString, QValueList<int> > DisplayInformation::getSelectedEvents

(

)

const [inline]

Gets the selected events by event file.

Returns:

map of the event file url with the list of selected eventIds.

QMap<QString, QValueList<int> > DisplayInformation::getSkippedClusters

(

)

const [inline]

Gets the skipped clusters by cluster file.

Returns:

map of the cluster file url with the list of clusterIds to skip while browsing.

QMap<QString, QValueList<int> > DisplayInformation::getSkippedEvents

(

)

const [inline]

Gets the skipped events by event file.

Returns:

map of the event file url with the list of eventIds to skip while browsing.

QValueList<QString> DisplayInformation::getSelectedSpikeFiles

(

)

const [inline]

Gets the list of the spike files shown in the display (without cluster file associated).

Returns:

list of the spike files.

QValueList<TracePosition> DisplayInformation::getPositions

(

)

const [inline]

Gets the list of TracePosition.

Returns:

list of TracePosition.

QValueList<int> DisplayInformation::getChannelIds

(

)

const [inline]

Gets the list of channel ids shown in the display.

Returns:

list of channel ids.

QValueList<int> DisplayInformation::getSelectedChannelIds

(

)

const [inline]

Gets the list channel ids selected in the display.

Returns:

list of channel ids.

QString DisplayInformation::getTabLabel

(

)

const [inline]

Gets the label for the display when in tab page mode.

Returns:

the new label for the display.

int DisplayInformation::getLabelStatus

(

)

const [inline]

Gets if the information as if the labels next to the traces have to be displayed.

Returns:

1 if the labels are displayed in the view, 0 otherwise.

long DisplayInformation::getStartTime

(

)

const [inline]

Gets the starting time in miliseconds.

Returns:

starting time.

long DisplayInformation::getTimeWindow

(

)

const [inline]

Gets the time window in miliseconds.

Returns:

duration time window.

int DisplayInformation::isAPositionView

(

)

const [inline]

Returns if a PositionView is displayed in the view.

Returns:

1 if a PositionView is displayed in the view, 0 otherwise.

int DisplayInformation::isEventsDisplayedInPositionView

(

)

const [inline]

Returns if events are displayed in the PositionView.

Returns:

1 if events are displayed in the PositionView, 0 otherwise.

void DisplayInformation::addSpikeDisplayType

(

spikeDisplayType

type

)

[inline]

Adds a type of spike display (see DisplayInformation::displayType).

Parameters:

type

type of spike displays.

void DisplayInformation::setMode

(

mode

modeOfPresentation

)

[inline]

Sets the mode of presentation (see DisplayInformation::mode).

Parameters:

modeOfPresentation

mode of presentation.

void DisplayInformation::setRasterHeight

(

int

height

)

[inline]

Sets the height of the rasters.

Parameters:

height

height of the rasters.

void DisplayInformation::setGreyScale

(

int

value

)

[inline]

Sets the grey-scale value.

Parameters:

value

1 if the grey-scale is used to the view 0, otherwise.

void DisplayInformation::setSelectedClusters	(	QString	clusterFile,
		QValueList< int >	clusterIds
	)			[inline]

Sets the selected clusters by cluster file.

Parameters:

	clusterFile	cluster file url.
	clusterIds	list of selected cluster ids.

void DisplayInformation::setSelectedEvents	(	QString	eventFile,
		QValueList< int >	eventIds
	)			[inline]

Sets the selected events by event file.

Parameters:

	eventFile	event file url.
	eventIds	list of selected eventIds.

void DisplayInformation::setSkippedClusters	(	QString	clusterFile,
		QValueList< int >	clusterIds
	)			[inline]

Sets the skipped clusters by cluster file.

Parameters:

	clusterFile	cluster file url.
	clusterIds	list of cluster ids to skip while browsing.

void DisplayInformation::setSkippedEvents	(	QString	eventFile,
		QValueList< int >	eventIds
	)			[inline]

Sets the skipped events by event file.

Parameters:

	eventFile	event file url.
	eventIds	list of eventIds to skip while browsing.

void DisplayInformation::setSelectedSpikeFiles

(

QValueList< QString >

files

)

[inline]

Sets the list of the spike files shown in the display (without cluster file associated).

Parameters:

files

list of the spike files.

void DisplayInformation::setPositions

(

QValueList< TracePosition >

positions

)

[inline]

Sets the list of TracePosition.

Parameters:

positions

list of TracePosition.

void DisplayInformation::setChannelIds

(

QValueList< int >

ids

)

[inline]

Sets the list of channel ids shown in the display.

Parameters:

ids

list of channel ids.

void DisplayInformation::setSelectedChannelIds

(

QValueList< int >

ids

)

[inline]

Sets the list channel ids selected in the display.

Parameters:

ids

list of channel ids.

void DisplayInformation::setStartTime

(

long

start

)

[inline]

Sets the starting time in miliseconds.

Parameters:

start

starting time.

void DisplayInformation::setTimeWindow

(

long

duration

)

[inline]

Sets the time window in miliseconds.

Parameters:

duration

time window.

void DisplayInformation::setTabLabel

(

QString

newLabel

)

[inline]

Sets the label for the display when in tab page mode.

Parameters:

newLabel

the new label for the display.

void DisplayInformation::setLabelStatus

(

int

value

)

[inline]

Sets if the labels next to the traces have to be displayed.

Parameters:

value

1 if the labels are displayed in the view, 0 otherwise.

void DisplayInformation::setPositionView

(

int

present

)

[inline]

Sets if a PositionView is displayed.

Parameters:

present

1 if a PositionView is displayed in the view, 0 otherwise.

void DisplayInformation::setEventsInPositionView

(

int

shown

)

[inline]

Sets if events are displayed in the PositionView.

Parameters:

shown

1 if events are displayed in the PositionView, 0 otherwise.

QValueList<spikeDisplayType> DisplayInformation::getSpikeDisplayTypes

(

)

const [inline]

Gets the list of type of spike display used (see DisplayInformation::displayType).

Returns:

list of types of spike display.

mode DisplayInformation::getMode

(

)

const [inline]

Gets the mode of presentation (see DisplayInformation::mode).

Returns:

mode of presentation.

int DisplayInformation::getRasterHeight

(

)

const [inline]

Gets the height of the rasters.

Returns:

height of the rasters.

int DisplayInformation::getGreyScale

(

)

const [inline]

Gets the grey-scale value.

Returns:

grey-scale value, 1 if the grey-scale is used to the view 0 otherwise.

QMap<QString, QValueList<int> > DisplayInformation::getSelectedClusters

(

)

const [inline]

Gets the selected clusters by cluster file.

Returns:

map of the cluster file url with the list of selected clusterIds.

QMap<QString, QValueList<int> > DisplayInformation::getSelectedEvents

(

)

const [inline]

Gets the selected events by event file.

Returns:

map of the event file url with the list of selected eventIds.

QMap<QString, QValueList<int> > DisplayInformation::getSkippedClusters

(

)

const [inline]

Gets the skipped clusters by cluster file.

Returns:

map of the cluster file url with the list of clusterIds to skip while browsing.

QMap<QString, QValueList<int> > DisplayInformation::getSkippedEvents

(

)

const [inline]

Gets the skipped events by event file.

Returns:

map of the event file url with the list of eventIds to skip while browsing.

QValueList<QString> DisplayInformation::getSelectedSpikeFiles

(

)

const [inline]

Gets the list of the spike files shown in the display (without cluster file associated).

Returns:

list of the spike files.

QValueList<TracePosition> DisplayInformation::getPositions

(

)

const [inline]

Gets the list of TracePosition.

Returns:

list of TracePosition.

QValueList<int> DisplayInformation::getChannelIds

(

)

const [inline]

Gets the list of channel ids shown in the display.

Returns:

list of channel ids.

QValueList<int> DisplayInformation::getSelectedChannelIds

(

)

const [inline]

Gets the list channel ids selected in the display.

Returns:

list of channel ids.

QString DisplayInformation::getTabLabel

(

)

const [inline]

Gets the label for the display when in tab page mode.

Returns:

the new label for the display.

int DisplayInformation::getLabelStatus

(

)

const [inline]

Gets if the information as if the labels next to the traces have to be displayed.

Returns:

1 if the labels are displayed in the view, 0 otherwise.

long DisplayInformation::getStartTime

(

)

const [inline]

Gets the starting time in miliseconds.

Returns:

starting time.

long DisplayInformation::getTimeWindow

(

)

const [inline]

Gets the time window in miliseconds.

Returns:

duration time window.

int DisplayInformation::isAPositionView

(

)

const [inline]

Returns if a PositionView is displayed in the view.

Returns:

1 if a PositionView is displayed in the view, 0 otherwise.

int DisplayInformation::isEventsDisplayedInPositionView

(

)

const [inline]

Returns if events are displayed in the PositionView.

Returns:

1 if events are displayed in the PositionView, 0 otherwise.

---

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

• debug/src/sessionInformation.h
• src/sessionInformation.h

---