Changeset 50 in flair-dev for trunk/include/FlairFilter


Ignore:
Timestamp:
May 31, 2017, 3:54:26 PM (4 years ago)
Author:
Sanahuja Guillaume
Message:

doc

Location:
trunk/include/FlairFilter
Files:
11 edited

Legend:

Unmodified
Added
Removed
  • trunk/include/FlairFilter/Ahrs.h

    r32 r50  
    1919namespace flair {
    2020  namespace core {
    21     class Euler;
    22     class Vector3D;
    23     class ImuData;
    24     class Quaternion;
    2521    class AhrsData;
    2622  }
     
    174170  /*!
    175171  * \brief Get ahrs datas
    176   *
     172  *
     173  * Can be used by dervied class to fill core::AhrsData
     174  *
    177175  * \param ahrsData ahrs datas
    178176  */
  • trunk/include/FlairFilter/AhrsComplementaryFilter.h

    r16 r50  
    6666            bool isInit;
    6767            core::Quaternion QHat;
    68             core::Vector3D BHat;
     68            core::Vector3Df BHat;
    6969            gui::DoubleSpinBox *ka[3];
    7070            gui::DoubleSpinBox *kb[3];
  • trunk/include/FlairFilter/ButterworthLowPass.h

    r13 r50  
    4848  * \param name name
    4949  * \param order order of the filter
     50  * \param nbRow number of rows of input/output
     51  * \param nbCol number of cols of input/output
    5052  */
    5153  ButterworthLowPass(const IODevice *parent,
    5254                     const gui::LayoutPosition *position, std::string name,
    53                      int order);
     55                     uint32_t order,uint32_t nbRow=1,uint32_t nbCol=1);
    5456
    5557  /*!
     
    6567  * \param name name
    6668  * \param order order of the filter
     69  * \param nbRow number of rows of input/output
     70  * \param nbCol number of cols of input/output
    6771  */
    6872  ButterworthLowPass(const gui::LayoutPosition *position, std::string name,
    69                      int order);
     73                     uint32_t order,uint32_t nbRow,uint32_t nbCol);
    7074
    7175  /*!
  • trunk/include/FlairFilter/EulerDerivative.h

    r13 r50  
    4545  * IODevice::ProcessUpdate is called. \n
    4646  * The optional init_value parameters allow to specify
    47   * the size of the input datas and its inital values.
     47  * the size of the input datas and output inital values.
    4848  * If unspecified, a 1*1 size is used, and values are
    4949  * initialized with 0.
     
    5252  * \param position position to display settings
    5353  * \param name name
    54   * \param init_value initial value
     54  * \param init_value initial value, it is safe to destroy it after calling this constructor
    5555  */
    5656  EulerDerivative(const core::IODevice *parent,
  • trunk/include/FlairFilter/Gx3_25_ahrs.h

    r13 r50  
    3030  * \brief Constructor
    3131  *
    32   * Construct an Ahrs for 3dmgx3-25
     32  * Construct an Ahrs for 3dmgx3-25. It will be child of the FrameworkManager.
    3333  *
    34   * \param parent parent
    3534  * \param name name
    3635  * \param serialport Imu SerialPort
     
    3837  * \param priority priority of the Gx3_25_imu Thread
    3938  */
    40   Gx3_25_ahrs(const core::FrameworkManager *parent, std::string name,
     39  Gx3_25_ahrs(std::string name,
    4140              core::SerialPort *serialport,
    4241              sensor::Gx3_25_imu::Command_t command, uint8_t priority);
     
    4746  */
    4847  ~Gx3_25_ahrs();
    49 
    50   /*!
    51   * \brief Start Gx3_25_imu Thread
    52   *
    53   */
    54   void Start(void);
    5548
    5649private:
  • trunk/include/FlairFilter/LowPassFilter.h

    r13 r50  
    5252  * \param position position to display settings
    5353  * \param name name
    54   * \param init_value initial value
     54  * \param init_value initial value, it is safe to destroy it after calling this constructor
    5555  */
    5656  LowPassFilter(const core::IODevice *parent,
  • trunk/include/FlairFilter/SimuAhrs.h

    r13 r50  
    3030  * \brief Constructor
    3131  *
    32   * Construct a simulation Ahrs.
     32  * Construct a simulation Ahrs. It will be child of the FrameworkManager.
    3333  *
    34   * \param parent parent
    3534  * \param name name
    36   * \param dev_id number id of the simulated Ahrs
     35  * \param modelId Model id
     36  * \param deviceId Ahrs id of the Model
    3737  * \param priority priority of the SimuImu Thread
    3838  */
    39   SimuAhrs(const core::FrameworkManager *parent, std::string name,
    40            uint32_t dev_id, uint8_t priority);
     39  SimuAhrs(std::string name,
     40           uint32_t modelId,uint32_t deviceId, uint8_t priority);
    4141
    4242  /*!
     
    4545  */
    4646  ~SimuAhrs();
    47 
    48   /*!
    49  * \brief Start SimuImu Thread
    50  *
    51  */
    52   void Start(void);
    5347
    5448private:
  • trunk/include/FlairFilter/TrajectoryGenerator1D.h

    r13 r50  
    7272  * \brief Start trajectory
    7373  *
    74   * \param start_pos start position
    75   * \param end_pos end position
     74  * \param startPosition start position
     75  * \param endPosition end position
     76  * \param startVelocity start velocity, should be actual velocity. This value will be saturated
     77  * max velocity defined in GCS.
    7678  */
    77   void StartTraj(float start_pos, float end_pos);
     79  void StartTraj(float startPosition, float endPosition,float startVelocity=0);
    7880
    7981  /*!
  • trunk/include/FlairFilter/TrajectoryGenerator2DCircle.h

    r13 r50  
    1515
    1616#include <IODevice.h>
     17#include <Vector2D.h>
    1718
    1819namespace flair {
    1920namespace core {
    2021class cvmatrix;
    21 class Vector2D;
    2222}
    2323namespace gui {
     
    7272  * \param nb_lap number of laps, -1 for infinite
    7373  */
    74   void StartTraj(const core::Vector2D &start_pos, float nb_lap = -1);
     74  void StartTraj(const core::Vector2Df &start_pos, float nb_lap = -1);
    7575
    7676  /*!
     
    9393  * \param value center position
    9494  */
    95   void SetCenter(const core::Vector2D &value);
     95  void SetCenter(const core::Vector2Df &value);
    9696
    9797  /*!
     
    100100  * \param value center speed
    101101  */
    102   void SetCenterSpeed(const core::Vector2D &value);
     102  void SetCenterSpeed(const core::Vector2Df &value);
    103103
    104104  /*!
     
    117117  * \param point returned position
    118118  */
    119   void GetPosition(core::Vector2D &point) const;
     119  void GetPosition(core::Vector2Df &point) const;
    120120
    121121  /*!
     
    124124  * \param point returned speed
    125125  */
    126   void GetSpeed(core::Vector2D &point) const;
     126  void GetSpeed(core::Vector2Df &point) const;
    127127
    128128  /*!
  • trunk/include/FlairFilter/UavMultiplex.h

    r13 r50  
    1919namespace flair {
    2020namespace core {
    21 class FrameworkManager;
    2221class io_data;
    2322}
     
    4140  * \brief Constructor
    4241  *
    43   * Construct a uav multiplexing
    44   *
    45   * \param parent parent
     42  * Construct a uav multiplexing. It will be child of the FrameworkManager.
     43  *
    4644  * \param name name
    4745  */
    48   UavMultiplex(const core::FrameworkManager *parent, std::string name);
     46  UavMultiplex(std::string name);
    4947
    5048  /*!
  • trunk/include/FlairFilter/X4X8Multiplex.h

    r13 r50  
    5959  * \brief Constructor
    6060  *
    61   * Construct a X4 and X8 multiplexing
     61  * Construct a X4 and X8 multiplexing. It will be child of the FrameworkManager.
    6262  *
    63   * \param parent parent
    6463  * \param name name
    6564  * \param type type
    6665  */
    67   X4X8Multiplex(const core::FrameworkManager *parent, std::string name,
    68                 UavType_t type);
     66  X4X8Multiplex(std::string name, UavType_t type);
    6967
    7068  /*!
Note: See TracChangeset for help on using the changeset viewer.