MNE-CPP  beta 1.0
Public Types | Public Member Functions | List of all members
ECGSimulatorPlugin::ECGSimChannel Class Reference

The ECGChannel class provides a ECG channel. More...

#include <ecgsimchannel.h>

Public Types

typedef QSharedPointer< ECGSimChannelSPtr
 
typedef QSharedPointer< const ECGSimChannelConstSPtr
 

Public Member Functions

 ECGSimChannel (QString ResourceDataPath, QString ChannelFile, bool enabled=true, bool visible=true)
 
virtual ~ECGSimChannel ()
 
void setResourceDataPath (QString &path)
 
const QString & getResourceDataPath ()
 
void setChannelFile (QString file)
 
const QString & getChannelFile ()
 
const QVector< double > & getSamples ()
 
void setEnabled (bool enabled)
 
bool isEnabled ()
 
void setVisible (bool visible)
 
bool isVisible ()
 
double getMinimum ()
 
double getMaximum ()
 
void initChannel ()
 
void clear ()
 

Detailed Description

The ECGChannel class provides a ECG channel.

DECLARE CLASS ECGChannel

Definition at line 84 of file ecgsimchannel.h.

Member Typedef Documentation

Const shared pointer type for ECGSimChannel.

Definition at line 88 of file ecgsimchannel.h.

Shared pointer type for ECGSimChannel.

Definition at line 87 of file ecgsimchannel.h.

Constructor & Destructor Documentation

ECGSimChannel::ECGSimChannel ( QString  ResourceDataPath,
QString  ChannelFile,
bool  enabled = true,
bool  visible = true 
)

Constructs a ECGSimChannel.

Parameters
[in]ResourceDataPatha string which holds the resource directory where the files are stored which could be used to simulate a channel.
[in]ChannelFilea string to a specific file which should be used initially.
[in]enabledwhether the channel should be initial enabled.
[in]visiblewhether the channel should be initial visible.

Definition at line 67 of file ecgsimchannel.cpp.

ECGSimChannel::~ECGSimChannel ( )
virtual

Destroys the ECGSimChannel.

Definition at line 79 of file ecgsimchannel.cpp.

Member Function Documentation

void ECGSimChannel::clear ( )

Clears the simulation channel.

Definition at line 122 of file ecgsimchannel.cpp.

const QString & ECGSimulatorPlugin::ECGSimChannel::getChannelFile ( )
inline

Returns the file which should be used to simulate the channel.

Returns
a string which specifies the file which should be used to simulate the channel.

Definition at line 252 of file ecgsimchannel.h.

double ECGSimulatorPlugin::ECGSimChannel::getMaximum ( )
inline

Returns the maximum of all simulation sample values.

Returns
the maximal value of all sample values.

Definition at line 308 of file ecgsimchannel.h.

double ECGSimulatorPlugin::ECGSimChannel::getMinimum ( )
inline

Returns the minimum of all simulation sample values.

Returns
the minimal value of all sample values.

Definition at line 300 of file ecgsimchannel.h.

const QString & ECGSimulatorPlugin::ECGSimChannel::getResourceDataPath ( )
inline

Returns the resource directory where the simulation files are stored.

Returns
a string which holds the path to the folder where the files are stored which could be used to simulate a channel.

Definition at line 236 of file ecgsimchannel.h.

const QVector< double > & ECGSimulatorPlugin::ECGSimChannel::getSamples ( )
inline

Returns the samples for simulation.

Returns
a vector which holds all samples of out of the simulation file.

Definition at line 260 of file ecgsimchannel.h.

void ECGSimChannel::initChannel ( )

Initializes the simulation channel.

Definition at line 86 of file ecgsimchannel.cpp.

bool ECGSimulatorPlugin::ECGSimChannel::isEnabled ( )
inline

Returns whether channel is enabled.

Returns
true when the channel is enabled, false otherwise.

Definition at line 276 of file ecgsimchannel.h.

bool ECGSimulatorPlugin::ECGSimChannel::isVisible ( )
inline

Returns whether channel is visible.

Returns
true when the channel is visible, false otherwise.

Definition at line 292 of file ecgsimchannel.h.

void ECGSimulatorPlugin::ECGSimChannel::setChannelFile ( QString  file)
inline

Sets the file which should be used to simulate the channel.

Parameters
[in]filea string which specifies the file which should be used to simulate the channel.

Definition at line 244 of file ecgsimchannel.h.

void ECGSimulatorPlugin::ECGSimChannel::setEnabled ( bool  enabled)
inline

Sets whether channel is enabled.

Parameters
[in]enabledthe parameter which enables the channel.

Definition at line 268 of file ecgsimchannel.h.

void ECGSimulatorPlugin::ECGSimChannel::setResourceDataPath ( QString &  path)
inline

Sets the resource directory where the simulation files are stored.

Parameters
[in]patha string which holds the path to the folder where the files are stored which could be used to simulate a channel.

Definition at line 228 of file ecgsimchannel.h.

void ECGSimulatorPlugin::ECGSimChannel::setVisible ( bool  visible)
inline

Sets whether channel is visible.

Parameters
[in]visiblethe parameter which declares the channel visible.

Definition at line 284 of file ecgsimchannel.h.


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