Changeset 67 in pacpusframework for trunk


Ignore:
Timestamp:
01/09/13 19:17:44 (11 years ago)
Author:
Marek Kurdej
Message:

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

Location:
trunk/include/Pacpus
Files:
14 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

  • trunk/include/Pacpus/PacpusTools/AsyncWorkerBase.h

    r66 r67  
    5757      bool isActive() const { return active_; }
    5858
    59     signals:
    60           void finished();
    61           void stopped();
     59    Q_SIGNALS:
     60       /// @todo Documentation
     61       void finished();
     62       /// @todo Documentation
     63       void stopped();
    6264
    6365    protected:
     66       /// @todo Documentation
    6467       virtual void setup();
     68       /// @todo Documentation
    6569       virtual void process();
     70       /// @todo Documentation
    6671       virtual void cleanup();
    6772
    … …  
    6974       bool isStopping() const { return stopping_; }
    7075
    71     private slots:
     76    private Q_SLOTS:
     77      /// @todo Documentation
    7278      void doSetup();
     79      /// @todo Documentation
    7380      void doFinish();
    7481

  • trunk/include/Pacpus/PacpusTools/PosixShMem.h

    r66 r67  
    1919#include <Pacpus/PacpusTools/ShMemBase.h>
    2020
     21/// @todo Documentation
    2122class PosixShMem
    2223        : public ShMemBase
    2324{
    2425public:
     26    /// @todo Documentation
    2527    PosixShMem(const char * name, int size);
     28    /// @todo Documentation
    2629    virtual ~PosixShMem();
    2730
     31    /// @todo Documentation
    2832    virtual void *read();
     33    /// @todo Documentation
    2934    virtual void write(void *data, int size, unsigned long offset = 0);
     35    /// @todo Documentation
    3036    virtual bool wait(unsigned long timeout = 0);
     37    /// @todo Documentation
    3138    virtual void lockMemory();
     39    /// @todo Documentation
    3240    virtual void unlockMemory();
    3341

  • trunk/include/Pacpus/PacpusTools/ShMem.h

    r66 r67  
    2828{
    2929public:
     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].
    3040    ShMem(const char * name, int size)
    3141        : ShMemType(name, size)
    … …  
    3343    }
    3444
     45    /// @brief Dtor of shared memory class.
     46    ///
     47    /// Does nothing.
    3548    ~ShMem()
    3649    {

  • trunk/include/Pacpus/PacpusTools/Win32ShMem.h

    r66 r67  
    1010///
    1111/// 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.
    1313
    1414#ifndef DEF_PACPUS_WIN32SHMEM_H

  • trunk/include/Pacpus/PacpusTools/geodesie.h

    r66 r67  
    3131
    3232////////////////////////////////////////////////////////////////////////
    33 struct Matrice {
     33/// @todo Documentation
     34/// @todo Rewrite!
     35struct Matrice
     36{
    3437    Matrice(const Matrice & A);
    3538    Matrice();
    3639    void Apply(double v0, double v1, double v2, double & Mv0, double & Mv1, double & Mv2);
     40
    3741    double c0_l0;double c1_l0;double c2_l0;
    3842    double c0_l1;double c1_l1;double c2_l1;
    3943    double c0_l2;double c1_l2;double c2_l2;
    40 }; // class
     44};
    4145
    4246Matrice TransMat(const Matrice A);
    … …  
    4650
    4751////////////////////////////////////////////////////////////////////////
    48 class Raf98 {
    49 private :
     52/// @todo Documentation
     53class Raf98
     54{
     55public:
     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   
     68private:
    5069    std::vector<double> m_dvalues;
    5170    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
    5873////////////////////////////////////////////////////////////////////////
    5974
    … …  
    101116////////////////////////////////////////////////////////////////////////
    102117
    103 //ALGO0001
     118///ALGO0001
     119/// @todo Rename
    104120double LatitueIsometrique(double latitude,double e);
    105 //ALGO0002
     121///ALGO0002
     122/// @todo Rename
    106123double LatitueIsometrique2Lat(double latitude_iso,double e,double epsilon);
    107124
    108 //ALGO0003
     125///ALGO0003
    109126void Geo2ProjLambert(
    110127    double lambda,double phi,
    … …  
    112129    double lambdac,double xs,double ys,
    113130    double& X,double& Y);
    114 //ALGO0004
     131///ALGO0004
    115132void Proj2GeoLambert(
    116133    double X,double Y,

  • trunk/include/Pacpus/kernel/ComponentManager.h

    r66 r67  
    1717#define DEF_PACPUS_COMPONENTMANAGER_H
    1818
    19 #include <cstddef>
    20 
    21 #include <QMap>
    22 #include <QList>
    23 #include <QPluginLoader>
    24 
    2519#include <Pacpus/kernel/pacpus.h>
    2620#include <Pacpus/kernel/ComponentFactoryBase.h>
    2721#include <Pacpus/kernel/PacpusPluginInterface.h>
    2822#include <Pacpus/kernel/XmlConfigFile.h>
     23
     24#include <cstddef>
     25#include <QList>
     26#include <QMap>
     27#include <QPluginLoader>
    2928
    3029namespace pacpus {
    … …  
    5756    static PACPUSLIB_API void destroy();
    5857
     58    /// Automatic deleter class.
    5959    struct destroyer {
     60        /// Invokes ComponentManager::destroy() method if @b mgr pointer is not null.
    6061        void operator()(ComponentManager * mgr) const
    6162        {

  • trunk/include/Pacpus/kernel/DbiteFile.h

    r66 r67  
    136136    /// @throws nothing
    137137    hdfile_header_t::FileSizeT getFileSize() const;
     138    /// @returns the real size of the written file in [bytes] as obtaine from system.
    138139    int64_t getRealFileSize();
    139140    /// @throws nothing

  • trunk/include/Pacpus/kernel/DbiteFileTypes.h

    r66 r67  
    1515#define DEF_PACPUS_DBITEFILETYPES_H
    1616
     17/// Basic file types
    1718enum BasicType
    1819{
    … …  
    2122    , FILE_TEXT
    2223    , FILE_IMAGE3D
    23     , FILE_DBT_UNKNOWN
     24    , FILE_DBT_UNKNOWN          ///< Unknown file type
    2425    , FILE_JPEG
    2526    , STREAM8POSITION = 100

  • trunk/include/Pacpus/kernel/GenericObservable.h

    r66 r67  
    2626    GenericObservable class template instances.
    2727*/
    28 class GenericObservableBase {
     28class GenericObservableBase
     29{
    2930public:
     31    /// @todo Documentation
    3032  virtual ~GenericObservableBase() {}
    3133};
    … …  
    3941*/
    4042template <typename T>
    41 class GenericObservable : GenericObservableBase {
     43class GenericObservable
     44    : GenericObservableBase
     45{
    4246public:
     47    /// @todo Documentation
    4348  typedef GenericObserverInterface<T> ObserverType;
    4449
     50    /// @todo Documentation
    4551  GenericObservable() {}
     52    /// @todo Documentation
    4653  virtual ~GenericObservable() {}
    4754

  • trunk/include/Pacpus/kernel/PacpusPluginInterface.h

    r66 r67  
    1313#ifndef DEF_PACPUS_PLUGININTERFACE_H
    1414#define DEF_PACPUS_PLUGININTERFACE_H
     15
     16#include <QObject>
    1517
    1618/** PacpusPluginInterface

  • trunk/include/Pacpus/kernel/cstdint.h

    r66 r67  
    77/// @version $Id$
    88/// @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.
    1010///
    11 /// Portable version of <cstdint> C99 header.
     11/// Portable version of \<cstdint\> C99 header.
    1212/// It is necessary due to the non-conformance of MSVC before version 2010 to the C99 standard.
    1313

  • trunk/include/Pacpus/kernel/hdfile_header_t.h

    r66 r67  
    1717#include <Pacpus/kernel/road_time.h>
    1818
     19/// @todo Documentation
    1920#define HEADER_SIGNATURE_LENGTH 4
    20 #define VERSION_NUMBER  2
     21/// @todo Documentation
     22#define VERSION_NUMBER 2
    2123
    2224#pragma pack(push,4)
    … …  
    4547    /// @todo Documentation
    4648    SignatureT      Signature[HEADER_SIGNATURE_LENGTH];
    47     /// Record data type
    48     /// Should default to @link FILE_DBT_UNKNOWN
    49     /// @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.
    5052    DataTypeT       Type;
    5153    /// File format version
Note: See TracChangeset for help on using the changeset viewer.