Changeset 67 in pacpusframework for trunk/include/Pacpus/DbitePlayer


Ignore:
Timestamp:
Jan 9, 2013, 7:17:44 PM (12 years ago)
Author:
Marek Kurdej
Message:

Documentation: file info.
Fixed: problem with includes in PacpusPluginInterface.h.

Location:
trunk/include/Pacpus/DbitePlayer
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/include/Pacpus/DbitePlayer/DbtPlyEngine.h

    r66 r67  
    1616#define DEF_PACPUS_DBTPLYENGINE_H
    1717
    18 #include <QSemaphore>
    19 
    2018#include <Pacpus/kernel/ComponentBase.h>
    2119#include <Pacpus/kernel/ComponentFactory.h>
     
    2422#include <Pacpus/DbitePlayer/DbtPlyUserInterface.h>
    2523
     24#include <QSemaphore>
     25#include <QThread>
     26
    2627namespace pacpus {
    2728
     
    2930class DbtPlyEngineState;
    3031
     32/// @todo Documentation
    3133enum PlayMode
    3234{
    33     PlayModeLastData = 1,   // replay_mode="1"
    34     PlayModeAllData = 2     // replay_mode="2"
     35    PlayModeLastData = 1,   ///< replay_mode="1"
     36    PlayModeAllData = 2     ///< replay_mode="2"
    3537};
    3638
     
    6163    }
    6264
    63     /// @returns true if the player is playing
     65    /// @returns @b true if the player is playing, @b false otherwise
    6466    bool isPlaying();
    6567    /// Accessor to playmode
     
    6971    }
    7072
     73    /// @todo Documentation
    7174    const DbtPlyEngineState * getState();
     75    /// @todo Documentation
    7276    void setState(DbtPlyEngineState * newState);
    7377
  • trunk/include/Pacpus/DbitePlayer/DbtPlyFileManager.h

    r66 r67  
    2323#define DEF_PACPUS_DBTPLYFILEMANAGER_H
    2424
    25 #include <QThread>
    26 
    2725#include <Pacpus/DbitePlayer/DbitePlayerConfig.h>
    2826#include <Pacpus/DbitePlayer/DbtPlyEngine.h>
     
    3028#include <Pacpus/kernel/ComponentBase.h>
    3129#include <Pacpus/kernel/DbiteFile.h>
     30
     31#include <QThread>
    3232
    3333class QSemaphore;
     
    6666    /// virtual method: call when new DBT data are replayed
    6767    virtual void processData(road_time_t time, road_timerange_t timeRange, void * data) = 0;
     68    /// @todo Documentation
    6869    virtual void displayUI();
    6970
     
    9899    /// the absolute path of the DBT file
    99100    QString dbtProperty_;
     101    /// @todo Documentation
    100102    QStringList mDbtFilenameList;
    101103
     
    109111    struct dbtStruct
    110112    {
     113        /// Data buffer
    111114        char * buffer;
     115        /// Acquisition time
    112116        road_time_t t;
     117        /// Acquisition timerange
    113118        road_timerange_t tr;
    114119    };
     
    117122    struct dbtStructFile
    118123    {
    119         // the DBT file descriptor
     124        /// the DBT file descriptor
    120125        pacpus::DbiteFile * pfile;
    121         // the buffer where the data are stored after the reading and the associated time, timerange and file descriptor
     126        /// the buffer where the data are stored after the reading and the associated time, timerange and file descriptor
    122127        dbtStruct cur;
    123         // the previous DBT data, these ones that must be processed
     128        /// the previous DBT data, these ones that must be processed
    124129        dbtStruct toProcess;
    125130    };
    126131
     132    /// @todo Documentation
    127133    QList<dbtStructFile> dbt_;
     134    /// @todo Documentation
    128135    int dbtIndex_;
    129136
Note: See TracChangeset for help on using the changeset viewer.