OpenWalnut
1.2.5
|
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 #include "WExportDataHandler.h" 00034 00035 /** 00036 * Base class for all recorded data and results with events 00037 * and sensor positions. 00038 * \ingroup dataHandler 00039 */ 00040 class OWDATAHANDLER_EXPORT WRecording : public WDataSet // NOLINT 00041 { 00042 public: 00043 00044 /** 00045 * Empty standard constructor for recordings 00046 */ 00047 explicit WRecording(); 00048 00049 /** 00050 * Gets the name of this prototype. 00051 * 00052 * \return the name. 00053 */ 00054 virtual const std::string getName() const; 00055 00056 /** 00057 * Gets the description for this prototype. 00058 * 00059 * \return the description 00060 */ 00061 virtual const std::string getDescription() const; 00062 00063 /** 00064 * Returns a prototype instantiated with the true type of the deriving class. 00065 * 00066 * \return the prototype. 00067 */ 00068 static boost::shared_ptr< WPrototyped > getPrototype(); 00069 00070 /** 00071 * Maximum number of channels for a certain modality. 00072 */ 00073 static const unsigned int MAX_RECORDING_CHANNELS = 1024; 00074 00075 /** 00076 * Maximum number of samples of a recording. 00077 * (2^32)-1 this is often equal to UINT_MAX 00078 */ 00079 static const unsigned int MAX_RECORDING_SAMPLES = 4294967295U; 00080 00081 /** 00082 * Maximum number of segments of a recording. 00083 */ 00084 static const unsigned int MAX_RECORDING_SEGMENTS = 128; 00085 00086 /** 00087 * Maximum samplimg frequency of a recording. 00088 */ 00089 static const unsigned int MAX_RECORDING_SAMPLING_FREQUENCY = 20000; 00090 00091 protected: 00092 00093 /** 00094 * The prototype as singleton. 00095 */ 00096 static boost::shared_ptr< WPrototyped > m_prototype; 00097 00098 private: 00099 }; 00100 00101 #endif // WRECORDING_H