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


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/PacpusTools
Files:
5 edited

Legend:

Unmodified
Added
Removed

  • 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,
Note: See TracChangeset for help on using the changeset viewer.