OpenWalnut  1.4.0
Public Member Functions | Static Public Member Functions | Static Public Attributes | Static Protected Attributes | List of all members
WRecording Class Reference

Base class for all recorded data and results with events and sensor positions. More...

#include <WRecording.h>

+ Inheritance diagram for WRecording:

Public Member Functions

 WRecording ()
 Empty standard constructor for recordings.
virtual const std::string getName () const
 Gets the name of this prototype.
virtual const std::string getDescription () const
 Gets the description for this prototype.
- Public Member Functions inherited from WDataSet
 WDataSet ()
 This constructor should be used if a dataSet does not stem from a file.
virtual ~WDataSet ()
 Since WDataSet is a base class and thus should be polymorphic we add virtual destructor.
void setFilename (const std::string filename)
 Set the name of the file that this data set stems from.
std::string getFilename () const
 Get the name of the file that this data set stems from.
OW_API_DEPRECATED void setFileName (const std::string filename)
 Set the name of the file that this data set stems from.
OW_API_DEPRECATED std::string getFileName () const
 Get the name of the file that this data set stems from.
virtual bool isTexture () const
 Determines whether this dataset can be used as a texture.
virtual boost::shared_ptr
< WDataSetVector
isVectorDataSet ()
 Checks if this dataset is a vector dataset.
virtual osg::ref_ptr
< WDataTexture3D
getTexture () const
 Returns the texture- representation of the dataset.
boost::shared_ptr< WPropertiesgetProperties () const
 Return a pointer to the properties object of the dataset.
boost::shared_ptr< WPropertiesgetInformationProperties () const
 Return a pointer to the information properties object of the dataset.
- Public Member Functions inherited from WTransferable
 WTransferable ()
 Default constructor.
virtual ~WTransferable ()
 Destructor.
- Public Member Functions inherited from WPrototyped
 WPrototyped ()
 Default constructor.
virtual ~WPrototyped ()
 Destructor.
template<typename T >
bool isA ()
 Checks whether the actual prototype has the specified runtime type.

Static Public Member Functions

static boost::shared_ptr
< WPrototyped
getPrototype ()
 Returns a prototype instantiated with the true type of the deriving class.

Static Public Attributes

static const unsigned int MAX_RECORDING_CHANNELS = 1024
 Maximum number of channels for a certain modality.
static const unsigned int MAX_RECORDING_SAMPLES = 4294967295U
 Maximum number of samples of a recording.
static const unsigned int MAX_RECORDING_SEGMENTS = 128
 Maximum number of segments of a recording.
static const unsigned int MAX_RECORDING_SAMPLING_FREQUENCY = 20000
 Maximum samplimg frequency of a recording.

Static Protected Attributes

static boost::shared_ptr
< WPrototyped
m_prototype = boost::shared_ptr< WPrototyped >()
 The prototype as singleton.
- Static Protected Attributes inherited from WDataSet
static boost::shared_ptr
< WPrototyped
m_prototype = boost::shared_ptr< WPrototyped >()
 The prototype as singleton.

Additional Inherited Members

- Public Types inherited from WDataSet
typedef boost::shared_ptr
< WDataSet
SPtr
 Shared pointer abbreviation to a instance of this class.
typedef boost::shared_ptr
< const WDataSet
ConstSPtr
 Shared pointer abbreviation to a const instance of this class.
- Protected Attributes inherited from WDataSet
boost::shared_ptr< WPropertiesm_properties
 The property object for the dataset.
boost::shared_ptr< WPropertiesm_infoProperties
 The property object for the dataset containing only props whose purpose is "PV_PURPOSE_INFORMNATION".

Detailed Description

Base class for all recorded data and results with events and sensor positions.

Definition at line 40 of file WRecording.h.

Constructor & Destructor Documentation

WRecording::WRecording ( )
explicit

Empty standard constructor for recordings.

Definition at line 34 of file WRecording.cpp.

Referenced by getPrototype().

Member Function Documentation

const std::string WRecording::getDescription ( ) const
virtual

Gets the description for this prototype.

Returns
the description

Reimplemented from WDataSet.

Reimplemented in WEEG, and WEEG2.

Definition at line 44 of file WRecording.cpp.

const std::string WRecording::getName ( ) const
virtual

Gets the name of this prototype.

Returns
the name.

Reimplemented from WDataSet.

Reimplemented in WEEG, and WEEG2.

Definition at line 39 of file WRecording.cpp.

boost::shared_ptr< WPrototyped > WRecording::getPrototype ( )
static

Returns a prototype instantiated with the true type of the deriving class.

Returns
the prototype.

Reimplemented from WDataSet.

Reimplemented in WEEG, and WEEG2.

Definition at line 49 of file WRecording.cpp.

References m_prototype, and WRecording().

Member Data Documentation

boost::shared_ptr< WPrototyped > WRecording::m_prototype = boost::shared_ptr< WPrototyped >()
staticprotected

The prototype as singleton.

Definition at line 94 of file WRecording.h.

Referenced by getPrototype().

const unsigned int WRecording::MAX_RECORDING_CHANNELS = 1024
static

Maximum number of channels for a certain modality.

Definition at line 72 of file WRecording.h.

Referenced by WEEG::WEEG(), and WEEG2::WEEG2().

const unsigned int WRecording::MAX_RECORDING_SAMPLES = 4294967295U
static

Maximum number of samples of a recording.

(2^32)-1 this is often equal to UINT_MAX

Definition at line 78 of file WRecording.h.

Referenced by WEEG::WEEG(), and WEEG2Segment::WEEG2Segment().

const unsigned int WRecording::MAX_RECORDING_SAMPLING_FREQUENCY = 20000
static

Maximum samplimg frequency of a recording.

Definition at line 88 of file WRecording.h.

Referenced by WEEG2::WEEG2().

const unsigned int WRecording::MAX_RECORDING_SEGMENTS = 128
static

Maximum number of segments of a recording.

Definition at line 83 of file WRecording.h.

Referenced by WEEG::WEEG(), and WEEG2::WEEG2().


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