WPagerEEG Class Reference

Abstract class to load an EEG file and keep it open to support paging. More...

#include <WPagerEEG.h>

List of all members.

Public Member Functions
virtual	~WPagerEEG ()
	Virtual destructor.
std::string	getFileName () const
	Get the name of the loaded file.
virtual std::size_t	getNumberOfSegments () const =0
	Get the number of segments this EEG consists of.
virtual std::size_t	getNumberOfChannels () const =0
	Get the number of channels this EEG has.
virtual std::size_t	getNumberOfSamples (std::size_t segmentID) const =0
	Get the number of samples of a given segment.
virtual boost::shared_ptr < WEEGValueMatrix >	getValues (std::size_t segmentID, std::size_t start, std::size_t length) const =0
	Get the values of all channels for a given sample range.
virtual double	getSamplingRate () const =0
	Get the sampling rate used by the recording.
virtual std::string	getChannelUnit (std::size_t channelID) const =0
	Get the unit used by the recording of a given channel.
virtual std::string	getChannelLabel (std::size_t channelID) const =0
	Get the label of a given channel.
Protected Member Functions
	WPagerEEG (std::string fileName)
	Constructor.
Protected Attributes
std::string	m_fileName
	name of the loaded file

---

Detailed Description

Abstract class to load an EEG file and keep it open to support paging.

Definition at line 42 of file WPagerEEG.h.

---

Constructor & Destructor Documentation

WPagerEEG::~WPagerEEG

(

)

[virtual]

Virtual destructor.

Definition at line 32 of file WPagerEEG.cpp.

WPagerEEG::WPagerEEG

(

std::string

fileName

)

[explicit, protected]

Constructor.

Parameters:

fileName

path and filename to the file to load

Definition at line 41 of file WPagerEEG.cpp.

References m_fileName.

---

Member Function Documentation

virtual std::string WPagerEEG::getChannelLabel

(

std::size_t

channelID

)

const [pure virtual]

Get the label of a given channel.

Parameters:

channelID

channel number

Returns:

label as string

virtual std::string WPagerEEG::getChannelUnit

(

std::size_t

channelID

)

const [pure virtual]

Get the unit used by the recording of a given channel.

Parameters:

channelID

channel number

Returns:

unit as string

std::string WPagerEEG::getFileName

(

)

const

Get the name of the loaded file.

Returns:

name of file

Definition at line 36 of file WPagerEEG.cpp.

References m_fileName.

virtual std::size_t WPagerEEG::getNumberOfChannels

(

)

const [pure virtual]

Get the number of channels this EEG has.

Returns:

number of channels

virtual std::size_t WPagerEEG::getNumberOfSamples

(

std::size_t

segmentID

)

const [pure virtual]

Get the number of samples of a given segment.

Parameters:

segmentID

segment number being inspected

Returns:

number of samples

virtual std::size_t WPagerEEG::getNumberOfSegments

(

)

const [pure virtual]

Get the number of segments this EEG consists of.

Returns:

number of segments

virtual double WPagerEEG::getSamplingRate

(

)

const [pure virtual]

Get the sampling rate used by the recording.

Returns:

sampling rate

virtual boost::shared_ptr< WEEGValueMatrix > WPagerEEG::getValues	(	std::size_t	segmentID,
		std::size_t	start,
		std::size_t	length
	)		const [pure virtual]

Get the values of all channels for a given sample range.

Parameters:

segmentID	segment number to read the values from
start	start sample of the sample range
length	length of the sample range

Returns:

matrix of values

---

Member Data Documentation

std::string WPagerEEG::m_fileName [protected]

name of the loaded file

Definition at line 120 of file WPagerEEG.h.

Referenced by getFileName(), and WPagerEEG().

---

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

• WPagerEEG.h
• WPagerEEG.cpp