OpenWalnut  1.2.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
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 #include "WExportDataHandler.h"
34 
35 /**
36  * Base class for all recorded data and results with events
37  * and sensor positions.
38  * \ingroup dataHandler
39  */
40 class OWDATAHANDLER_EXPORT WRecording : public WDataSet // NOLINT
41 {
42 public:
43 
44  /**
45  * Empty standard constructor for recordings
46  */
47  explicit WRecording();
48 
49  /**
50  * Gets the name of this prototype.
51  *
52  * \return the name.
53  */
54  virtual const std::string getName() const;
55 
56  /**
57  * Gets the description for this prototype.
58  *
59  * \return the description
60  */
61  virtual const std::string getDescription() const;
62 
63  /**
64  * Returns a prototype instantiated with the true type of the deriving class.
65  *
66  * \return the prototype.
67  */
68  static boost::shared_ptr< WPrototyped > getPrototype();
69 
70  /**
71  * Maximum number of channels for a certain modality.
72  */
73  static const unsigned int MAX_RECORDING_CHANNELS = 1024;
74 
75  /**
76  * Maximum number of samples of a recording.
77  * (2^32)-1 this is often equal to UINT_MAX
78  */
79  static const unsigned int MAX_RECORDING_SAMPLES = 4294967295U;
80 
81  /**
82  * Maximum number of segments of a recording.
83  */
84  static const unsigned int MAX_RECORDING_SEGMENTS = 128;
85 
86  /**
87  * Maximum samplimg frequency of a recording.
88  */
89  static const unsigned int MAX_RECORDING_SAMPLING_FREQUENCY = 20000;
90 
91 protected:
92 
93  /**
94  * The prototype as singleton.
95  */
96  static boost::shared_ptr< WPrototyped > m_prototype;
97 
98 private:
99 };
100 
101 #endif // WRECORDING_H