Changeset 61 in pacpusframework for trunk/include/Pacpus/DbitePlayer/DbtPlyFileManager.h

Timestamp:

01/09/13 13:40:39 (11 years ago)

Author:

Marek Kurdej

Message:

Added: some documentation and doc todo comments.

File:

• trunk/include/Pacpus/DbitePlayer/DbtPlyFileManager.h (modified) (5 diffs)

trunk/include/Pacpus/DbitePlayer/DbtPlyFileManager.h

@@ -41 +41 @@
 
 public:
-    // constructor
+    /// constructor
     DbtPlyFileManager(QString name);
-    // destructor
+    /// destructor
     virtual ~DbtPlyFileManager();
 
-    // the player replays only the last data that has not been yet replayed
+    /// the player replays only the last data that has not been yet replayed
+    /// @todo Rename
     void playMode1 (road_time_t tDbt, bool reverse);
-    // the player replays all the data that have not been yet replayed
+    /// the player replays all the data that have not been yet replayed
+    /// @todo Rename
     void playMode2 (road_time_t tDbt, bool reverse);
 
-    // virtual method: call when new DBT data are replayed
+    /// virtual method: call when new DBT data are replayed
     virtual void processData(road_time_t time, road_timerange_t timeRange, void * data) = 0;
     virtual void displayUI();
 
-    // 3 Virtual methods relative to the ComponentBase inheritance
+    /// 3 Virtual methods relative to the ComponentBase inheritance
     virtual COMPONENT_CONFIGURATION configureComponent(XmlComponentConfig config);
+    /// @todo Documentation
     virtual void startActivity();
+    /// @todo Documentation
     virtual void stopActivity();
 
-    // The loop of the thread
+    /// The loop of the thread
     virtual void run();
 
 public Q_SLOTS:
-    // slot activated by the engine when it computes new DBT time
+    /// slot activated by the engine when it computes new DBT time
     void  playData(road_time_t tDbt,road_time_t tNow, bool reverse);
 
-    // put the file descriptor to the beginning of the file
+    /// put the file descriptor to the beginning of the file
     void beginfile();
 
 Q_SIGNALS:
-    // signal sent to the engine to provide to it the tmin and tmax of the file
+    /// signal sent to the engine to provide to it the tmin and tmax of the file
     void tMinMaxIs(road_time_t tmin, road_time_t tmax);
 
@@ -78 +82 @@
     int mVerbose;
 
-    // a pointer on the player engine
+    /// a pointer on the player engine
     DbtPlyEngine * mEngine;
 
-    // the absolute path of the DBT file
+    /// the absolute path of the DBT file
     QString dbtProperty_;
     QStringList mDbtFilenameList;
 
-    // The directory where the DBT file is located
+    /// The directory where the DBT file is located
     QString mDbtDataPath;
 
-    // Display or not the graphical interface
+    /// Display or not the graphical interface
     bool mShowGui;
 
+    /// @todo Documentation
     struct dbtStruct
     {
@@ -98 +103 @@
     };
 
+    /// @todo Documentation
     struct dbtStructFile
     {
@@ -112 +118 @@
 
 private:
+    /// @todo Documentation
     bool processDbtFileHdfile(dbtStructFile & dbtFile, pacpus::DbiteFile::ReadDirection direction);
 
@@ -118 +125 @@
     bool reverse_;
 
-    // the estimated DBT time sent by the engine and computed relatively to the state of the player
+    /// the estimated DBT time sent by the engine and computed relatively to the state of the player
     road_time_t timeToRead_;
 
-    // The mode of replay
-    // see playModeN method
+    /// The mode of replay
+    /// @see playMode1, playMode2 methods
     int mode_;
 
-    // The minimum and maximum time of the data contained in the file
+    /// The minimum and maximum time of the data contained in the file
     road_time_t tMin_, tMax_;
 
-    // the synchronization semaphore with the engine
+    /// the synchronization semaphore with the engine
     QSemaphore * sync_;
 
-    // For statistics purpose - delta time between the instant when the tDbt is computed and the instant when it is
-    // taken into account by the file manager
+    /// For statistics purpose - delta time between the instant when the tDbt is computed and the instant when it is
+    /// taken into account by the file manager
     int deltaTDbtTab_[1000];
     int deltaTDbtTabLoop_;