OpenWalnut  1.3.1
Public Member Functions | Private Attributes | List of all members
WEEGChannelInfo Class Reference

Class which contains information about one channel of an EEG recording, read from a WPagerEEG. More...

#include <WEEGChannelInfo.h>

Public Member Functions

 WEEGChannelInfo (std::size_t channelID, boost::shared_ptr< WPagerEEG > pager, boost::shared_ptr< WEEGPositionsLibrary > positionsLibrary)
 Constructor.
std::string getUnit () const
 Get the unit used by the recording of the channel.
std::string getLabel () const
 Get the label of the channel.
WPosition getPosition () const throw ( WDHException )
 Get the position of the electrode.

Private Attributes

std::string m_unit
 unit used by the recording of the channel
std::string m_label
 label of the channel
bool m_hasPosition
 whether there is a valid position for this electrode
WPosition m_position
 position of the electrode

Detailed Description

Class which contains information about one channel of an EEG recording, read from a WPagerEEG.

Definition at line 46 of file WEEGChannelInfo.h.

Constructor & Destructor Documentation

WEEGChannelInfo::WEEGChannelInfo ( std::size_t  channelID,
boost::shared_ptr< WPagerEEG pager,
boost::shared_ptr< WEEGPositionsLibrary positionsLibrary 
)

Constructor.

Parameters
channelIDnumber of this channel
pagerpager class which contains the data, read from a file on demand
positionsLibraryclass which contains the positions of the electrodes

Definition at line 40 of file WEEGChannelInfo.cpp.

References m_hasPosition, m_label, m_position, and m_unit.

Member Function Documentation

std::string WEEGChannelInfo::getLabel ( ) const

Get the label of the channel.

Returns
label as string

Definition at line 80 of file WEEGChannelInfo.cpp.

References m_label.

WPosition WEEGChannelInfo::getPosition ( ) const throw ( WDHException )

Get the position of the electrode.

Returns
position

Definition at line 85 of file WEEGChannelInfo.cpp.

References m_hasPosition, and m_position.

std::string WEEGChannelInfo::getUnit ( ) const

Get the unit used by the recording of the channel.

Returns
unit as string

Definition at line 75 of file WEEGChannelInfo.cpp.

References m_unit.

Member Data Documentation

bool WEEGChannelInfo::m_hasPosition
private

whether there is a valid position for this electrode

Definition at line 87 of file WEEGChannelInfo.h.

Referenced by getPosition(), and WEEGChannelInfo().

std::string WEEGChannelInfo::m_label
private

label of the channel

Definition at line 86 of file WEEGChannelInfo.h.

Referenced by getLabel(), and WEEGChannelInfo().

WPosition WEEGChannelInfo::m_position
private

position of the electrode

Definition at line 88 of file WEEGChannelInfo.h.

Referenced by getPosition(), and WEEGChannelInfo().

std::string WEEGChannelInfo::m_unit
private

unit used by the recording of the channel

Definition at line 85 of file WEEGChannelInfo.h.

Referenced by getUnit(), and WEEGChannelInfo().


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