Changeset 61 in pacpusframework for trunk/include/Pacpus


Ignore:
Timestamp:
Jan 9, 2013, 1:40:39 PM (12 years ago)
Author:
Marek Kurdej
Message:

Added: some documentation and doc todo comments.

Location:
trunk/include/Pacpus
Files:
6 edited

Legend:

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

    r31 r61  
    7171    void reset();
    7272
     73    /// @todo Documentation
    7374    void speedUp();
     75    /// @todo Documentation
    7476    void speedDown();
     77    /// @todo Documentation
    7578    void setLastTNow(road_time_t newTNow)
    7679    {
     
    7982
    8083protected:
    81     // The 3 virtual methods relative to the ComponentBase inheritance
     84    /// @todo Documentation
    8285    virtual void startActivity();
     86    /// @todo Documentation
    8387    virtual void stopActivity();
     88    /// @todo Documentation
    8489    virtual COMPONENT_CONFIGURATION configureComponent(XmlComponentConfig config);
    8590
     
    122127
    123128Q_SIGNALS:
     129    /// @todo Documentation
    124130    void play(road_time_t timeToPlay, road_time_t actualTime, bool direction);
     131    /// @todo Documentation
    125132    void stopfile();
     133    /// @todo Documentation
    126134    void displayStateSig(DbtPlyEngineState * state, float speed);
     135    /// @todo Documentation
    127136    void timeMinMax(road_time_t tMin, road_time_t tMax);
     137    /// @todo Documentation
    128138    void curReplayTime(road_time_t time);
    129139
    130140public Q_SLOTS:
     141    /// @todo Documentation
    131142    void engReceiver();
     143    /// @todo Documentation
    132144    void changeDirection(bool reverse);
     145    /// @todo Documentation
    133146    void tMinMax(road_time_t tMin, road_time_t tMax);
    134147
     148    /// @todo Documentation
    135149    void playEvent();
     150    /// @todo Documentation
    136151    void pauseEvent();
     152    /// @todo Documentation
    137153    void stopEvent();
     154    /// @todo Documentation
    138155    void speedUpEvent();
     156    /// @todo Documentation
    139157    void speedDownEvent();
    140158};
  • trunk/include/Pacpus/DbitePlayer/DbtPlyFileManager.h

    r31 r61  
    4141
    4242public:
    43     // constructor
     43    /// constructor
    4444    DbtPlyFileManager(QString name);
    45     // destructor
     45    /// destructor
    4646    virtual ~DbtPlyFileManager();
    4747
    48     // the player replays only the last data that has not been yet replayed
     48    /// the player replays only the last data that has not been yet replayed
     49    /// @todo Rename
    4950    void playMode1 (road_time_t tDbt, bool reverse);
    50     // the player replays all the data that have not been yet replayed
     51    /// the player replays all the data that have not been yet replayed
     52    /// @todo Rename
    5153    void playMode2 (road_time_t tDbt, bool reverse);
    5254
    53     // virtual method: call when new DBT data are replayed
     55    /// virtual method: call when new DBT data are replayed
    5456    virtual void processData(road_time_t time, road_timerange_t timeRange, void * data) = 0;
    5557    virtual void displayUI();
    5658
    57     // 3 Virtual methods relative to the ComponentBase inheritance
     59    /// 3 Virtual methods relative to the ComponentBase inheritance
    5860    virtual COMPONENT_CONFIGURATION configureComponent(XmlComponentConfig config);
     61    /// @todo Documentation
    5962    virtual void startActivity();
     63    /// @todo Documentation
    6064    virtual void stopActivity();
    6165
    62     // The loop of the thread
     66    /// The loop of the thread
    6367    virtual void run();
    6468
    6569public Q_SLOTS:
    66     // slot activated by the engine when it computes new DBT time
     70    /// slot activated by the engine when it computes new DBT time
    6771    void  playData(road_time_t tDbt,road_time_t tNow, bool reverse);
    6872
    69     // put the file descriptor to the beginning of the file
     73    /// put the file descriptor to the beginning of the file
    7074    void beginfile();
    7175
    7276Q_SIGNALS:
    73     // signal sent to the engine to provide to it the tmin and tmax of the file
     77    /// signal sent to the engine to provide to it the tmin and tmax of the file
    7478    void tMinMaxIs(road_time_t tmin, road_time_t tmax);
    7579
     
    7882    int mVerbose;
    7983
    80     // a pointer on the player engine
     84    /// a pointer on the player engine
    8185    DbtPlyEngine * mEngine;
    8286
    83     // the absolute path of the DBT file
     87    /// the absolute path of the DBT file
    8488    QString dbtProperty_;
    8589    QStringList mDbtFilenameList;
    8690
    87     // The directory where the DBT file is located
     91    /// The directory where the DBT file is located
    8892    QString mDbtDataPath;
    8993
    90     // Display or not the graphical interface
     94    /// Display or not the graphical interface
    9195    bool mShowGui;
    9296
     97    /// @todo Documentation
    9398    struct dbtStruct
    9499    {
     
    98103    };
    99104
     105    /// @todo Documentation
    100106    struct dbtStructFile
    101107    {
     
    112118
    113119private:
     120    /// @todo Documentation
    114121    bool processDbtFileHdfile(dbtStructFile & dbtFile, pacpus::DbiteFile::ReadDirection direction);
    115122
     
    118125    bool reverse_;
    119126
    120     // the estimated DBT time sent by the engine and computed relatively to the state of the player
     127    /// the estimated DBT time sent by the engine and computed relatively to the state of the player
    121128    road_time_t timeToRead_;
    122129
    123     // The mode of replay
    124     // see playModeN method
     130    /// The mode of replay
     131    /// @see playMode1, playMode2 methods
    125132    int mode_;
    126133
    127     // The minimum and maximum time of the data contained in the file
     134    /// The minimum and maximum time of the data contained in the file
    128135    road_time_t tMin_, tMax_;
    129136
    130     // the synchronization semaphore with the engine
     137    /// the synchronization semaphore with the engine
    131138    QSemaphore * sync_;
    132139
    133     // For statistics purpose - delta time between the instant when the tDbt is computed and the instant when it is
    134     // taken into account by the file manager
     140    /// For statistics purpose - delta time between the instant when the tDbt is computed and the instant when it is
     141    /// taken into account by the file manager
    135142    int deltaTDbtTab_[1000];
    136143    int deltaTDbtTabLoop_;
  • trunk/include/Pacpus/DbitePlayer/DbtPlyTrigger.h

    r31 r61  
    3535
    3636public:
     37    /// @todo Documentation
    3738    DbtPlyTrigger(QString name);
     39    /// @todo Documentation
    3840    virtual ~DbtPlyTrigger();
    3941
     42    /// @todo Documentation
    4043    virtual ComponentBase::COMPONENT_CONFIGURATION configureComponent(XmlComponentConfig config);
    4144
     45    /// @todo Documentation
    4246    virtual void run();
    4347
    4448Q_SIGNALS:
     49    /// @todo Documentation
    4550    void triggerSig();
    4651
    4752protected:
     53    /// @todo Documentation
    4854    virtual void startActivity();
     55    /// @todo Documentation
    4956    virtual void stopActivity();
    5057
  • trunk/include/Pacpus/kernel/ComponentBase.h

    r42 r61  
    9090     */
    9191    virtual COMPONENT_CONFIGURATION configureComponent(XmlComponentConfig config) = 0;
    92 
    93     // The XML node that is got in the configureComponent method
     92   
     93protected:
     94    /// The XML node that is got in the configureComponent method
    9495    XmlComponentConfig param;
    9596
    96     // the name of the component. It is this one in the XML config file
     97    /// the name of the component. It is this one in the XML config file
    9798    QString componentName;
    9899
    99     // is the component is recording data?
     100    /// is the component is recording data?
    100101    bool recording;
    101102
    102     // provided for compatibility with old DBITE framework
     103    /// provided for compatibility with old DBITE framework
    103104    bool THREAD_ALIVE;
    104105
    105     // is the component active?
     106    /// is the component active?
    106107    bool mIsActive;
    107108
    108     // a pointer to the manager of components
     109    /// a pointer to the manager of components
    109110    ComponentManager * mgr;
    110111
    111112private:
    112     // called by the ComponentManager to start the component
     113    /// called by the ComponentManager to start the component
    113114    int startComponent();
    114115
    115     // called by the ComponentManager to stop the component
     116    /// called by the ComponentManager to stop the component
    116117    int stopComponent();
    117118
    118     // store the state of the component
     119    /// store the state of the component
    119120    COMPONENT_STATE componentState_;
    120121
    121     // is the component configured (ie configureComponent method was called)
     122    /// is the component configured (ie configureComponent method was called)
    122123    COMPONENT_CONFIGURATION configuration_;
    123124};
  • trunk/include/Pacpus/kernel/DbiteFile.h

    r59 r61  
    2323namespace pacpus {
    2424
     25/// @todo Documentation
    2526struct FILELIB_API VariableDataSizeTag {};
    2627FILELIB_API extern VariableDataSizeTag VariableDataSize;
    2728
     29/// @todo Documentation
    2830struct FILELIB_API ReadModeTag {};
    2931FILELIB_API extern ReadModeTag ReadMode;
    3032
     33/// @todo Documentation
    3134struct FILELIB_API WriteModeTag {};
    3235FILELIB_API extern WriteModeTag WriteMode;
    3336
     37/// @todo Documentation
    3438struct FILELIB_API DiagnoseModeTag {};
    3539FILELIB_API extern DiagnoseModeTag DiagnoseMode;
    3640
     41/// @todo Documentation
    3742class FILELIB_API DbiteFile
    3843{
  • trunk/include/Pacpus/kernel/hdfile_header_t.h

    r32 r61  
    1919
    2020#pragma pack(push,4)
     21/// @todo Documentation
    2122struct hdfile_header_t
    2223{
     24    /// @todo Documentation
    2325    typedef  int8_t SignatureT;
     26    /// @todo Documentation
    2427    typedef int32_t DataTypeT;
     28    /// @todo Documentation
    2529    typedef int32_t VersionT;
     30    /// @todo Documentation
    2631    typedef int32_t DataSizeT;
     32    /// @todo Documentation
    2733    typedef int32_t DataOffsetT;
    28     // FIXME: file size should be 64-bit long to support large (>2GB) files
     34    /// @todo Documentation
     35    /// @todo FIXME: file size should be 64-bit long to support large (>2GB) files
    2936    typedef int32_t FileSizeT;
     37    /// @todo Documentation
    3038    typedef int32_t RecordCountT;
    3139
     40    /// @todo Documentation
    3241    static const DataSizeT kVariableRecordSize = -1;
    3342
     43    /// @todo Documentation
    3444    SignatureT      Signature[HEADER_SIGNATURE_LENGTH];
    35     DataTypeT       Type;           /* IMAGE, CAN, UNKNOWN, etc. */
     45    /// Record data type
     46    /// Should default to @link FILE_DBT_UNKNOWN
     47    /// @see DbiteFileTypes.h for more
     48    DataTypeT       Type;
     49    /// File format version
    3650    VersionT        VersionNumber;
    37     DataOffsetT     DataOffset;     /* starting of the data */
    38     DataSizeT       DataSize;       /* number of byte for data */
    39     FileSizeT       FileSize;       /* current size of the file */
    40     road_time_t     TimeMin, TimeMax;
    41     RecordCountT    NbRecords;      /* number of records */
     51    /// Offset indicating the start of the data [bytes]
     52    DataOffsetT     DataOffset;
     53    /// Current size of the data, without header [bytes]
     54    DataSizeT       DataSize;
     55    /// Current size of the file [bytes]
     56    FileSizeT       FileSize;
     57    /// @todo Documentation
     58    road_time_t     TimeMin;
     59    /// @todo Documentation
     60    road_time_t     TimeMax;
     61    /// Number of records already in the file
     62    RecordCountT    NbRecords;
    4263};
    4364#pragma pack(pop)
Note: See TracChangeset for help on using the changeset viewer.