ChannelColors Class Reference

This class represents the list of the channels with their associated id, colors and colors status (i.e the color has been changed or no). More...

#include <channelcolors.h>

List of all members.

Public Member Functions
	ChannelColors (const ChannelColors &channelcolors)
void	removeAll ()
	Suppress all the elements of.
virtual QColor	color (int identifier)
	Returns the color for a channel with a given id (identifier).
virtual QColor	groupColor (int identifier)
	Returns the group color for a channel with a given id (identifier).
virtual QColor	spikeGroupColor (int identifier)
	Returns the spike group color for a channel with a given id (identifier).
virtual void	setColor (int identifier, QColor color)
	Sets the color for a channel with a given id to color.
virtual void	setGroupColor (int identifier, QColor color)
	Sets the group color for a channel with a given id to color.
virtual void	setSpikeGroupColor (int identifier, QColor color)
	Sets the spike group color for a channel with a given id to color.
virtual int	channelId (int index)
	Returns the channel id with a given position in the list (index).
virtual bool	contains (int channelId)
	Returns true if the channel Id exists false otherwise.
virtual uint	numberOfChannels () const
	Returns the number of channels.
virtual uint	append (int channelId, QColor color, QColor groupColor, QColor spikeGroupColor)
	Appends a channel to the list of channels.
virtual uint	append (int channelId, QColor color)
	This is an overloaded member function, provided for convenience.
virtual void	insert (int channelId, int index, QColor color, QColor groupColor, QColor spikeGroupColor)
	Inserts a channel at position index in the list of channels.
virtual bool	remove (int identifier)
	Removes a channel, with a given id (identifier),from the list of channels.
	ChannelColors (const ChannelColors &channelcolors)
void	removeAll ()
	Suppress all the elements of.
virtual QColor	color (int identifier)
	Returns the color for a channel with a given id (identifier).
virtual QColor	groupColor (int identifier)
	Returns the group color for a channel with a given id (identifier).
virtual QColor	spikeGroupColor (int identifier)
	Returns the spike group color for a channel with a given id (identifier).
virtual void	setColor (int identifier, QColor color)
	Sets the color for a channel with a given id to color.
virtual void	setGroupColor (int identifier, QColor color)
	Sets the group color for a channel with a given id to color.
virtual void	setSpikeGroupColor (int identifier, QColor color)
	Sets the spike group color for a channel with a given id to color.
virtual int	channelId (int index)
	Returns the channel id with a given position in the list (index).
virtual bool	contains (int channelId)
	Returns true if the channel Id exists false otherwise.
virtual uint	numberOfChannels () const
	Returns the number of channels.
virtual uint	append (int channelId, QColor color, QColor groupColor, QColor spikeGroupColor)
	Appends a channel to the list of channels.
virtual uint	append (int channelId, QColor color)
	This is an overloaded member function, provided for convenience.
virtual void	insert (int channelId, int index, QColor color, QColor groupColor, QColor spikeGroupColor)
	Inserts a channel at position index in the list of channels.
virtual bool	remove (int identifier)
	Removes a channel, with a given id (identifier),from the list of channels.
Classes
struct	ChannelColor
	Structure representing a color channel.

---

Detailed Description

This class represents the list of the channels with their associated id, colors and colors status (i.e the color has been changed or no).

The list index is zero based.

Author:

Lynn Hazan

---

Member Function Documentation

QColor ChannelColors::color

(

int

identifier

)

[virtual]

Returns the color for a channel with a given id (identifier).

Parameters:

identifier

channel id.

Returns:

the QColor for the given channel.

QColor ChannelColors::groupColor

(

int

identifier

)

[virtual]

Returns the group color for a channel with a given id (identifier).

Parameters:

identifier

channel id.

Returns:

the QColor for the group of the given channel.

QColor ChannelColors::spikeGroupColor

(

int

identifier

)

[virtual]

Returns the spike group color for a channel with a given id (identifier).

Parameters:

identifier

channel id.

Returns:

the QColor for the spike group of the given channel

void ChannelColors::setColor	(	int	identifier,
		QColor	color
	)			[virtual]

Sets the color for a channel with a given id to color.

Parameters:

	identifier	channel id.
	color	color to attribute to the channel.

void ChannelColors::setGroupColor	(	int	identifier,
		QColor	color
	)			[virtual]

Sets the group color for a channel with a given id to color.

Parameters:

	identifier	channel id.
	color	group color to attribute to the channel.

void ChannelColors::setSpikeGroupColor	(	int	identifier,
		QColor	color
	)			[virtual]

Sets the spike group color for a channel with a given id to color.

Parameters:

	identifier	channel id.
	color	spike group color to attribute to the channel.

int ChannelColors::channelId

(

int

index

)

[virtual]

Returns the channel id with a given position in the list (index).

Parameters:

index

the index in the list of channels

Returns:

the channel id

bool ChannelColors::contains

(

int

channelId

)

[virtual]

Returns true if the channel Id exists false otherwise.

Parameters:

channelId

the id of the channel to check for existence

Returns:

the boolean value for the existance of the channel

virtual uint ChannelColors::numberOfChannels

(

)

const [inline, virtual]

Returns the number of channels.

Returns:

the number of channels in the list

uint ChannelColors::append	(	int	channelId,
		QColor	color,
		QColor	groupColor,
		QColor	spikeGroupColor
	)			[virtual]

Appends a channel to the list of channels.

Parameters:

	channelId	the channel id.
	color	the color of the channel.
	groupColor	the group color of the channel.
	spikeGroupColor	the decteion group color of the channel.

Returns:

the index in the list.

uint ChannelColors::append	(	int	channelId,
		QColor	color
	)			[virtual]

This is an overloaded member function, provided for convenience.

It behaves essentially like the above function. Appends a channel to the list of channels with its groupColor and spikeGroupColor equal to its color.

Parameters:

	channelId	the channel id.
	color	the color of the channel.

Returns:

the index in the list.

void ChannelColors::insert	(	int	channelId,
		int	index,
		QColor	color,
		QColor	groupColor,
		QColor	spikeGroupColor
	)			[virtual]

Inserts a channel at position index in the list of channels.

Parameters:

	channelId	the channel id.
	index	index position where to insert the channel.
	color	the color of the channel.
	groupColor	the group color of the channel.
	spikeGroupColor	the decteion group color of the channel.

bool ChannelColors::remove

(

int

identifier

)

[virtual]

Removes a channel, with a given id (identifier),from the list of channels.

Parameters:

identifier

the channel id.

Returns:

true if successful,i.e. if identifier is in range, otherwise returns false.

virtual QColor ChannelColors::color

(

int

identifier

)

[virtual]

Returns the color for a channel with a given id (identifier).

Parameters:

identifier

channel id.

Returns:

the QColor for the given channel.

virtual QColor ChannelColors::groupColor

(

int

identifier

)

[virtual]

Returns the group color for a channel with a given id (identifier).

Parameters:

identifier

channel id.

Returns:

the QColor for the group of the given channel.

virtual QColor ChannelColors::spikeGroupColor

(

int

identifier

)

[virtual]

Returns the spike group color for a channel with a given id (identifier).

Parameters:

identifier

channel id.

Returns:

the QColor for the spike group of the given channel

virtual void ChannelColors::setColor	(	int	identifier,
		QColor	color
	)			[virtual]

Sets the color for a channel with a given id to color.

Parameters:

	identifier	channel id.
	color	color to attribute to the channel.

virtual void ChannelColors::setGroupColor	(	int	identifier,
		QColor	color
	)			[virtual]

Sets the group color for a channel with a given id to color.

Parameters:

	identifier	channel id.
	color	group color to attribute to the channel.

virtual void ChannelColors::setSpikeGroupColor	(	int	identifier,
		QColor	color
	)			[virtual]

Sets the spike group color for a channel with a given id to color.

Parameters:

	identifier	channel id.
	color	spike group color to attribute to the channel.

virtual int ChannelColors::channelId

(

int

index

)

[virtual]

Returns the channel id with a given position in the list (index).

Parameters:

index

the index in the list of channels

Returns:

the channel id

virtual bool ChannelColors::contains

(

int

channelId

)

[virtual]

Returns true if the channel Id exists false otherwise.

Parameters:

channelId

the id of the channel to check for existence

Returns:

the boolean value for the existance of the channel

virtual uint ChannelColors::numberOfChannels

(

)

const [inline, virtual]

Returns the number of channels.

Returns:

the number of channels in the list

virtual uint ChannelColors::append	(	int	channelId,
		QColor	color,
		QColor	groupColor,
		QColor	spikeGroupColor
	)			[virtual]

Appends a channel to the list of channels.

Parameters:

	channelId	the channel id.
	color	the color of the channel.
	groupColor	the group color of the channel.
	spikeGroupColor	the decteion group color of the channel.

Returns:

the index in the list.

virtual uint ChannelColors::append	(	int	channelId,
		QColor	color
	)			[virtual]

This is an overloaded member function, provided for convenience.

It behaves essentially like the above function. Appends a channel to the list of channels with its groupColor and spikeGroupColor equal to its color.

Parameters:

	channelId	the channel id.
	color	the color of the channel.

Returns:

the index in the list.

virtual void ChannelColors::insert	(	int	channelId,
		int	index,
		QColor	color,
		QColor	groupColor,
		QColor	spikeGroupColor
	)			[virtual]

Inserts a channel at position index in the list of channels.

Parameters:

	channelId	the channel id.
	index	index position where to insert the channel.
	color	the color of the channel.
	groupColor	the group color of the channel.
	spikeGroupColor	the decteion group color of the channel.

virtual bool ChannelColors::remove

(

int

identifier

)

[virtual]

Removes a channel, with a given id (identifier),from the list of channels.

Parameters:

identifier

the channel id.

Returns:

true if successful,i.e. if identifier is in range, otherwise returns false.

---

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

• debug/src/channelcolors.h
• src/channelcolors.h
• debug/src/channelcolors.cpp
• src/channelcolors.cpp

---