OpenWalnut
1.4.0
Main Page
Related Pages
Modules
Namespaces
Classes
Files
File List
src
core
dataHandler
WRecording.h
1
//---------------------------------------------------------------------------
2
//
3
// Project: OpenWalnut ( http://www.openwalnut.org )
4
//
5
// Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
6
// For more information see http://www.openwalnut.org/copying
7
//
8
// This file is part of OpenWalnut.
9
//
10
// OpenWalnut is free software: you can redistribute it and/or modify
11
// it under the terms of the GNU Lesser General Public License as published by
12
// the Free Software Foundation, either version 3 of the License, or
13
// (at your option) any later version.
14
//
15
// OpenWalnut is distributed in the hope that it will be useful,
16
// but WITHOUT ANY WARRANTY; without even the implied warranty of
17
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18
// GNU Lesser General Public License for more details.
19
//
20
// You should have received a copy of the GNU Lesser General Public License
21
// along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
22
//
23
//---------------------------------------------------------------------------
24
25
#ifndef WRECORDING_H
26
#define WRECORDING_H
27
28
#include <string>
29
30
#include "../common/WPrototyped.h"
31
32
#include "WDataSet.h"
33
34
35
/**
36
* Base class for all recorded data and results with events
37
* and sensor positions.
38
* \ingroup dataHandler
39
*/
40
class
WRecording
:
public
WDataSet
// NOLINT
41
{
42
public
:
43
/**
44
* Empty standard constructor for recordings
45
*/
46
explicit
WRecording
();
47
48
/**
49
* Gets the name of this prototype.
50
*
51
* \return the name.
52
*/
53
virtual
const
std::string
getName
()
const
;
54
55
/**
56
* Gets the description for this prototype.
57
*
58
* \return the description
59
*/
60
virtual
const
std::string
getDescription
()
const
;
61
62
/**
63
* Returns a prototype instantiated with the true type of the deriving class.
64
*
65
* \return the prototype.
66
*/
67
static
boost::shared_ptr< WPrototyped >
getPrototype
();
68
69
/**
70
* Maximum number of channels for a certain modality.
71
*/
72
static
const
unsigned
int
MAX_RECORDING_CHANNELS
= 1024;
73
74
/**
75
* Maximum number of samples of a recording.
76
* (2^32)-1 this is often equal to UINT_MAX
77
*/
78
static
const
unsigned
int
MAX_RECORDING_SAMPLES
= 4294967295U;
79
80
/**
81
* Maximum number of segments of a recording.
82
*/
83
static
const
unsigned
int
MAX_RECORDING_SEGMENTS
= 128;
84
85
/**
86
* Maximum samplimg frequency of a recording.
87
*/
88
static
const
unsigned
int
MAX_RECORDING_SAMPLING_FREQUENCY
= 20000;
89
90
protected
:
91
/**
92
* The prototype as singleton.
93
*/
94
static
boost::shared_ptr< WPrototyped >
m_prototype
;
95
96
private
:
97
};
98
99
#endif // WRECORDING_H
Generated by
1.8.4