Changeset 67 in pacpusframework for trunk/include/Pacpus
- Timestamp:
- Jan 9, 2013, 7:17:44 PM (12 years ago)
- Location:
- trunk/include/Pacpus
- Files:
-
- 14 edited
-
DbitePlayer/DbtPlyEngine.h (modified) (5 diffs)
-
DbitePlayer/DbtPlyFileManager.h (modified) (6 diffs)
-
PacpusTools/AsyncWorkerBase.h (modified) (2 diffs)
-
PacpusTools/PosixShMem.h (modified) (1 diff)
-
PacpusTools/ShMem.h (modified) (2 diffs)
-
PacpusTools/Win32ShMem.h (modified) (1 diff)
-
PacpusTools/geodesie.h (modified) (4 diffs)
-
kernel/ComponentManager.h (modified) (2 diffs)
-
kernel/DbiteFile.h (modified) (1 diff)
-
kernel/DbiteFileTypes.h (modified) (2 diffs)
-
kernel/GenericObservable.h (modified) (2 diffs)
-
kernel/PacpusPluginInterface.h (modified) (1 diff)
-
kernel/cstdint.h (modified) (1 diff)
-
kernel/hdfile_header_t.h (modified) (2 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/include/Pacpus/DbitePlayer/DbtPlyEngine.h
r66 r67 16 16 #define DEF_PACPUS_DBTPLYENGINE_H 17 17 18 #include <QSemaphore>19 20 18 #include <Pacpus/kernel/ComponentBase.h> 21 19 #include <Pacpus/kernel/ComponentFactory.h> … … 24 22 #include <Pacpus/DbitePlayer/DbtPlyUserInterface.h> 25 23 24 #include <QSemaphore> 25 #include <QThread> 26 26 27 namespace pacpus { 27 28 … … 29 30 class DbtPlyEngineState; 30 31 32 /// @todo Documentation 31 33 enum PlayMode 32 34 { 33 PlayModeLastData = 1, // replay_mode="1"34 PlayModeAllData = 2 // replay_mode="2"35 PlayModeLastData = 1, ///< replay_mode="1" 36 PlayModeAllData = 2 ///< replay_mode="2" 35 37 }; 36 38 … … 61 63 } 62 64 63 /// @returns true if the player is playing65 /// @returns @b true if the player is playing, @b false otherwise 64 66 bool isPlaying(); 65 67 /// Accessor to playmode … … 69 71 } 70 72 73 /// @todo Documentation 71 74 const DbtPlyEngineState * getState(); 75 /// @todo Documentation 72 76 void setState(DbtPlyEngineState * newState); 73 77 -
trunk/include/Pacpus/DbitePlayer/DbtPlyFileManager.h
r66 r67 23 23 #define DEF_PACPUS_DBTPLYFILEMANAGER_H 24 24 25 #include <QThread>26 27 25 #include <Pacpus/DbitePlayer/DbitePlayerConfig.h> 28 26 #include <Pacpus/DbitePlayer/DbtPlyEngine.h> … … 30 28 #include <Pacpus/kernel/ComponentBase.h> 31 29 #include <Pacpus/kernel/DbiteFile.h> 30 31 #include <QThread> 32 32 33 33 class QSemaphore; … … 66 66 /// virtual method: call when new DBT data are replayed 67 67 virtual void processData(road_time_t time, road_timerange_t timeRange, void * data) = 0; 68 /// @todo Documentation 68 69 virtual void displayUI(); 69 70 … … 98 99 /// the absolute path of the DBT file 99 100 QString dbtProperty_; 101 /// @todo Documentation 100 102 QStringList mDbtFilenameList; 101 103 … … 109 111 struct dbtStruct 110 112 { 113 /// Data buffer 111 114 char * buffer; 115 /// Acquisition time 112 116 road_time_t t; 117 /// Acquisition timerange 113 118 road_timerange_t tr; 114 119 }; … … 117 122 struct dbtStructFile 118 123 { 119 // the DBT file descriptor124 /// the DBT file descriptor 120 125 pacpus::DbiteFile * pfile; 121 // the buffer where the data are stored after the reading and the associated time, timerange and file descriptor126 /// the buffer where the data are stored after the reading and the associated time, timerange and file descriptor 122 127 dbtStruct cur; 123 // the previous DBT data, these ones that must be processed128 /// the previous DBT data, these ones that must be processed 124 129 dbtStruct toProcess; 125 130 }; 126 131 132 /// @todo Documentation 127 133 QList<dbtStructFile> dbt_; 134 /// @todo Documentation 128 135 int dbtIndex_; 129 136 -
trunk/include/Pacpus/PacpusTools/AsyncWorkerBase.h
r66 r67 57 57 bool isActive() const { return active_; } 58 58 59 signals: 60 void finished(); 61 void stopped(); 59 Q_SIGNALS: 60 /// @todo Documentation 61 void finished(); 62 /// @todo Documentation 63 void stopped(); 62 64 63 65 protected: 66 /// @todo Documentation 64 67 virtual void setup(); 68 /// @todo Documentation 65 69 virtual void process(); 70 /// @todo Documentation 66 71 virtual void cleanup(); 67 72 … … 69 74 bool isStopping() const { return stopping_; } 70 75 71 private slots: 76 private Q_SLOTS: 77 /// @todo Documentation 72 78 void doSetup(); 79 /// @todo Documentation 73 80 void doFinish(); 74 81 -
trunk/include/Pacpus/PacpusTools/PosixShMem.h
r66 r67 19 19 #include <Pacpus/PacpusTools/ShMemBase.h> 20 20 21 /// @todo Documentation 21 22 class PosixShMem 22 23 : public ShMemBase 23 24 { 24 25 public: 26 /// @todo Documentation 25 27 PosixShMem(const char * name, int size); 28 /// @todo Documentation 26 29 virtual ~PosixShMem(); 27 30 31 /// @todo Documentation 28 32 virtual void *read(); 33 /// @todo Documentation 29 34 virtual void write(void *data, int size, unsigned long offset = 0); 35 /// @todo Documentation 30 36 virtual bool wait(unsigned long timeout = 0); 37 /// @todo Documentation 31 38 virtual void lockMemory(); 39 /// @todo Documentation 32 40 virtual void unlockMemory(); 33 41 -
trunk/include/Pacpus/PacpusTools/ShMem.h
r66 r67 28 28 { 29 29 public: 30 /// @brief Ctor of shared memory class. 31 /// 32 /// Creates a shared memory of size @b size and named @b name. 33 /// If a shared memory with the name @b name already exists, than 34 /// it will return object pointing to the same memory. 35 /// If this existing memory space has a size smaller than @b size, 36 /// a warning will be issued. 37 /// 38 /// @param name Name of the created shared memory space. 39 /// @param size Size of the created shared memory space in [bytes]. 30 40 ShMem(const char * name, int size) 31 41 : ShMemType(name, size) … … 33 43 } 34 44 45 /// @brief Dtor of shared memory class. 46 /// 47 /// Does nothing. 35 48 ~ShMem() 36 49 { -
trunk/include/Pacpus/PacpusTools/Win32ShMem.h
r66 r67 10 10 /// 11 11 /// Shared memory implementation for Windows. 12 /// @todo Derive from a common base class. Same for @link PosixShMem .12 /// @todo Derive from a common base class. Same for @link PosixShMem @endlink. 13 13 14 14 #ifndef DEF_PACPUS_WIN32SHMEM_H -
trunk/include/Pacpus/PacpusTools/geodesie.h
r66 r67 31 31 32 32 //////////////////////////////////////////////////////////////////////// 33 struct Matrice { 33 /// @todo Documentation 34 /// @todo Rewrite! 35 struct Matrice 36 { 34 37 Matrice(const Matrice & A); 35 38 Matrice(); 36 39 void Apply(double v0, double v1, double v2, double & Mv0, double & Mv1, double & Mv2); 40 37 41 double c0_l0;double c1_l0;double c2_l0; 38 42 double c0_l1;double c1_l1;double c2_l1; 39 43 double c0_l2;double c1_l2;double c2_l2; 40 }; // class44 }; 41 45 42 46 Matrice TransMat(const Matrice A); … … 46 50 47 51 //////////////////////////////////////////////////////////////////////// 48 class Raf98 { 49 private : 52 /// @todo Documentation 53 class Raf98 54 { 55 public: 56 /// Ctor of Raf98 class. 57 Raf98() {} 58 /// Dtor of Raf98 class. 59 ~Raf98(); 60 /// @todo Documentation 61 /// @param s filepath 62 bool Load(const std::string & s); 63 /// @todo Documentation 64 /// @param longitude [degrees] 65 /// @param latitude [degrees] 66 bool Interpol(double longitude/*deg*/, double latitude/*deg*/, double* Hwgs84) const; 67 68 private: 50 69 std::vector<double> m_dvalues; 51 70 double LitGrille(unsigned int c,unsigned int l) const; 52 public : 53 ~Raf98(); 54 Raf98() {} 55 bool Load(const std::string & s); 56 bool Interpol(double longitude/*deg*/, double latitude/*deg*/, double* Hwgs84) const; 57 }; // class 71 }; 72 58 73 //////////////////////////////////////////////////////////////////////// 59 74 … … 101 116 //////////////////////////////////////////////////////////////////////// 102 117 103 //ALGO0001 118 ///ALGO0001 119 /// @todo Rename 104 120 double LatitueIsometrique(double latitude,double e); 105 //ALGO0002 121 ///ALGO0002 122 /// @todo Rename 106 123 double LatitueIsometrique2Lat(double latitude_iso,double e,double epsilon); 107 124 108 // ALGO0003125 ///ALGO0003 109 126 void Geo2ProjLambert( 110 127 double lambda,double phi, … … 112 129 double lambdac,double xs,double ys, 113 130 double& X,double& Y); 114 // ALGO0004131 ///ALGO0004 115 132 void Proj2GeoLambert( 116 133 double X,double Y, -
trunk/include/Pacpus/kernel/ComponentManager.h
r66 r67 17 17 #define DEF_PACPUS_COMPONENTMANAGER_H 18 18 19 #include <cstddef>20 21 #include <QMap>22 #include <QList>23 #include <QPluginLoader>24 25 19 #include <Pacpus/kernel/pacpus.h> 26 20 #include <Pacpus/kernel/ComponentFactoryBase.h> 27 21 #include <Pacpus/kernel/PacpusPluginInterface.h> 28 22 #include <Pacpus/kernel/XmlConfigFile.h> 23 24 #include <cstddef> 25 #include <QList> 26 #include <QMap> 27 #include <QPluginLoader> 29 28 30 29 namespace pacpus { … … 57 56 static PACPUSLIB_API void destroy(); 58 57 58 /// Automatic deleter class. 59 59 struct destroyer { 60 /// Invokes ComponentManager::destroy() method if @b mgr pointer is not null. 60 61 void operator()(ComponentManager * mgr) const 61 62 { -
trunk/include/Pacpus/kernel/DbiteFile.h
r66 r67 136 136 /// @throws nothing 137 137 hdfile_header_t::FileSizeT getFileSize() const; 138 /// @returns the real size of the written file in [bytes] as obtaine from system. 138 139 int64_t getRealFileSize(); 139 140 /// @throws nothing -
trunk/include/Pacpus/kernel/DbiteFileTypes.h
r66 r67 15 15 #define DEF_PACPUS_DBITEFILETYPES_H 16 16 17 /// Basic file types 17 18 enum BasicType 18 19 { … … 21 22 , FILE_TEXT 22 23 , FILE_IMAGE3D 23 , FILE_DBT_UNKNOWN 24 , FILE_DBT_UNKNOWN ///< Unknown file type 24 25 , FILE_JPEG 25 26 , STREAM8POSITION = 100 -
trunk/include/Pacpus/kernel/GenericObservable.h
r66 r67 26 26 GenericObservable class template instances. 27 27 */ 28 class GenericObservableBase { 28 class GenericObservableBase 29 { 29 30 public: 31 /// @todo Documentation 30 32 virtual ~GenericObservableBase() {} 31 33 }; … … 39 41 */ 40 42 template <typename T> 41 class GenericObservable : GenericObservableBase { 43 class GenericObservable 44 : GenericObservableBase 45 { 42 46 public: 47 /// @todo Documentation 43 48 typedef GenericObserverInterface<T> ObserverType; 44 49 50 /// @todo Documentation 45 51 GenericObservable() {} 52 /// @todo Documentation 46 53 virtual ~GenericObservable() {} 47 54 -
trunk/include/Pacpus/kernel/PacpusPluginInterface.h
r66 r67 13 13 #ifndef DEF_PACPUS_PLUGININTERFACE_H 14 14 #define DEF_PACPUS_PLUGININTERFACE_H 15 16 #include <QObject> 15 17 16 18 /** PacpusPluginInterface -
trunk/include/Pacpus/kernel/cstdint.h
r66 r67 7 7 /// @version $Id$ 8 8 /// @copyright Copyright (c) UTC/CNRS Heudiasyc 2006 - 2013. All rights reserved. 9 /// @brief Portable version of <cstdint> C99 header.9 /// @brief Portable version of \<cstdint\> C99 header. 10 10 /// 11 /// Portable version of <cstdint> C99 header.11 /// Portable version of \<cstdint\> C99 header. 12 12 /// It is necessary due to the non-conformance of MSVC before version 2010 to the C99 standard. 13 13 -
trunk/include/Pacpus/kernel/hdfile_header_t.h
r66 r67 17 17 #include <Pacpus/kernel/road_time.h> 18 18 19 /// @todo Documentation 19 20 #define HEADER_SIGNATURE_LENGTH 4 20 #define VERSION_NUMBER 2 21 /// @todo Documentation 22 #define VERSION_NUMBER 2 21 23 22 24 #pragma pack(push,4) … … 45 47 /// @todo Documentation 46 48 SignatureT Signature[HEADER_SIGNATURE_LENGTH]; 47 /// Record data type 48 /// Should default to @linkFILE_DBT_UNKNOWN49 /// @see DbiteFileTypes.h for more 49 /// Record data type. 50 /// Should default to ::FILE_DBT_UNKNOWN 51 /// @see DbiteFileTypes.h for more information about available types. 50 52 DataTypeT Type; 51 53 /// File format version
Note:
See TracChangeset
for help on using the changeset viewer.
