WPagerEEG Class Reference

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

#include <WPagerEEG.h>

Collaboration diagram for WPagerEEG:

Public Member Functions
virtual	~WPagerEEG ()
	Virtual destructor. More...
std::string	getFilename () const
	Get the name of the loaded file. More...
OW_API_DEPRECATED std::string	getFileName () const
	Get the name of the loaded file. More...
virtual std::size_t	getNumberOfSegments () const =0
	Get the number of segments this EEG consists of. More...
virtual std::size_t	getNumberOfChannels () const =0
	Get the number of channels this EEG has. More...
virtual std::size_t	getNumberOfSamples (std::size_t segmentID) const =0
	Get the number of samples of a given segment. More...
virtual std::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. More...
virtual double	getSamplingRate () const =0
	Get the sampling rate used by the recording. More...
virtual std::string	getChannelUnit (std::size_t channelID) const =0
	Get the unit used by the recording of a given channel. More...
virtual std::string	getChannelLabel (std::size_t channelID) const =0
	Get the label of a given channel. More...

Protected Member Functions
	WPagerEEG (std::string filename)
	Constructor. More...

Private Attributes
std::string	m_filename
	name of the loaded file More...

Detailed Description

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

Definition at line 40 of file WPagerEEG.h.

Constructor & Destructor Documentation

~WPagerEEG()

WPagerEEG::~WPagerEEG ( )

virtual

Virtual destructor.

Definition at line 32 of file WPagerEEG.cpp.

WPagerEEG()

WPagerEEG::WPagerEEG ( std::string  filename )

explicitprotected

Constructor.

Parameters

filename

path and filename to the file to load

Definition at line 46 of file WPagerEEG.cpp.

References m_filename.

Member Function Documentation

getChannelLabel()

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

getChannelUnit()

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

getFilename()

std::string WPagerEEG::getFilename

(

)

const

Get the name of the loaded file.

Returns

name of file

Definition at line 41 of file WPagerEEG.cpp.

References m_filename.

Referenced by getFileName().

Here is the caller graph for this function:

getFileName()

std::string WPagerEEG::getFileName

(

)

const

Get the name of the loaded file.

Returns

name of file

Deprecated:

use getFilename instead

Definition at line 36 of file WPagerEEG.cpp.

References getFilename().

Here is the call graph for this function:

getNumberOfChannels()

virtual std::size_t WPagerEEG::getNumberOfChannels ( ) const

pure virtual

Get the number of channels this EEG has.

Returns

number of channels

getNumberOfSamples()

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

getNumberOfSegments()

virtual std::size_t WPagerEEG::getNumberOfSegments ( ) const

pure virtual

Get the number of segments this EEG consists of.

Returns

number of segments

getSamplingRate()

virtual double WPagerEEG::getSamplingRate ( ) const

pure virtual

Get the sampling rate used by the recording.

Returns

sampling rate

getValues()

virtual std::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

m_filename

std::string WPagerEEG::m_filename

private

name of the loaded file

Definition at line 126 of file WPagerEEG.h.

Referenced by getFilename(), and WPagerEEG().

---

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

• WPagerEEG.h
• WPagerEEG.cpp