OpenWalnut
1.4.0
|
00001 //--------------------------------------------------------------------------- 00002 // 00003 // Project: OpenWalnut ( http://www.openwalnut.org ) 00004 // 00005 // Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS 00006 // For more information see http://www.openwalnut.org/copying 00007 // 00008 // This file is part of OpenWalnut. 00009 // 00010 // OpenWalnut is free software: you can redistribute it and/or modify 00011 // it under the terms of the GNU Lesser General Public License as published by 00012 // the Free Software Foundation, either version 3 of the License, or 00013 // (at your option) any later version. 00014 // 00015 // OpenWalnut is distributed in the hope that it will be useful, 00016 // but WITHOUT ANY WARRANTY; without even the implied warranty of 00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00018 // GNU Lesser General Public License for more details. 00019 // 00020 // You should have received a copy of the GNU Lesser General Public License 00021 // along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>. 00022 // 00023 //--------------------------------------------------------------------------- 00024 00025 #ifndef WRECORDING_H 00026 #define WRECORDING_H 00027 00028 #include <string> 00029 00030 #include "../common/WPrototyped.h" 00031 00032 #include "WDataSet.h" 00033 00034 00035 /** 00036 * Base class for all recorded data and results with events 00037 * and sensor positions. 00038 * \ingroup dataHandler 00039 */ 00040 class WRecording : public WDataSet // NOLINT 00041 { 00042 public: 00043 /** 00044 * Empty standard constructor for recordings 00045 */ 00046 explicit WRecording(); 00047 00048 /** 00049 * Gets the name of this prototype. 00050 * 00051 * \return the name. 00052 */ 00053 virtual const std::string getName() const; 00054 00055 /** 00056 * Gets the description for this prototype. 00057 * 00058 * \return the description 00059 */ 00060 virtual const std::string getDescription() const; 00061 00062 /** 00063 * Returns a prototype instantiated with the true type of the deriving class. 00064 * 00065 * \return the prototype. 00066 */ 00067 static boost::shared_ptr< WPrototyped > getPrototype(); 00068 00069 /** 00070 * Maximum number of channels for a certain modality. 00071 */ 00072 static const unsigned int MAX_RECORDING_CHANNELS = 1024; 00073 00074 /** 00075 * Maximum number of samples of a recording. 00076 * (2^32)-1 this is often equal to UINT_MAX 00077 */ 00078 static const unsigned int MAX_RECORDING_SAMPLES = 4294967295U; 00079 00080 /** 00081 * Maximum number of segments of a recording. 00082 */ 00083 static const unsigned int MAX_RECORDING_SEGMENTS = 128; 00084 00085 /** 00086 * Maximum samplimg frequency of a recording. 00087 */ 00088 static const unsigned int MAX_RECORDING_SAMPLING_FREQUENCY = 20000; 00089 00090 protected: 00091 /** 00092 * The prototype as singleton. 00093 */ 00094 static boost::shared_ptr< WPrototyped > m_prototype; 00095 00096 private: 00097 }; 00098 00099 #endif // WRECORDING_H