data.hpp

Go to the documentation of this file.

// INDENTING (emacs/vi): -*- mode:c++; tab-width:2; c-basic-offset:2; intent-tabs-mode:nil; -*- ex: set tabstop=2 expandtab:

/*
 * Simple Geolocalization and Course Transmission Protocol (SGCTP)
 * Copyright (C) 2014 Cedric Dufour <http://cedric.dufour.name>
 *
 * The Simple Geolocalization and Course Transmission Protocol (SGCTP) is
 * free software:
 * you can redistribute it and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation, Version 3.
 *
 * The Simple Geolocalization and Course Transmission Protocol (SGCTP) is
 * distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE.
 *
 * See the GNU General Public License for more details.
 */

#ifndef SGCTP_CDATA_HPP
#define SGCTP_CDATA_HPP

// C
#include <math.h>
#include <stdint.h>
#include <string.h>

// C++
#include <string>
using namespace std;

// SGCTP namespace
namespace SGCTP
{


  class CData
  {
    friend class CPayload;

    //----------------------------------------------------------------------
    // CONSTANTS / STATIC
    //----------------------------------------------------------------------

  public:
    enum ESourceType {
      SOURCE_UNDEFINED = 0,   
      SOURCE_GPS = 1,         
      SOURCE_AIS = 2,         
      SOURCE_ADSB = 3,        
      SOURCE_FLARM = 4        
    };

  private:
    static const uint32_t UNDEFINED_UINT32 = 0x80000000;
    static const uint32_t OVERFLOW_UINT32 = 0x7FFFFFFF;

  public:
    static const double UNDEFINED_VALUE;
    static const double OVERFLOW_VALUE;
    static const uint8_t MAX_ID_LENGTH = 127;
    static const uint8_t MAX_ID_SIZE = 128;
    static const uint16_t MAX_DATA_SIZE = 32767;
    inline static bool isDefined( double _fdValue )
    {
      return !__isnanl( _fdValue );
    };
    inline static bool isValid( double _fdValue ) {
      return !__isinfl( _fdValue );
    };

    static string stringSourceType( int _iSourceType );
    static double epoch();

    static double toEpoch( double _fdTime,
                           double _fdEpochReference = 0 );

    static void toIso8601( char *_pcIso8601,
                           double _fdEpoch );

    static double fromIso8601( const char *_pcIso8601 );


    //----------------------------------------------------------------------
    // FIELDS
    //----------------------------------------------------------------------

  private:
    char pcID[MAX_ID_SIZE];
    unsigned char *pucData;
    uint16_t ui16tDataSize;
    uint32_t ui32tTime;
    uint32_t ui32tLatitude;
    uint32_t ui32tLongitude;
    uint32_t ui32tElevation;
    uint32_t ui32tBearing;
    uint32_t ui32tGndSpeed;
    uint32_t ui32tVrtSpeed;
    uint32_t ui32tBearingDt;
    uint32_t ui32tGndSpeedDt;
    uint32_t ui32tVrtSpeedDt;
    uint32_t ui32tHeading;
    uint32_t ui32tAppSpeed;
    uint32_t ui32tSourceType;
    uint32_t ui32tLatitudeError;
    uint32_t ui32tLongitudeError;
    uint32_t ui32tElevationError;
    uint32_t ui32tBearingError;
    uint32_t ui32tGndSpeedError;
    uint32_t ui32tVrtSpeedError;
    uint32_t ui32tBearingDtError;
    uint32_t ui32tGndSpeedDtError;
    uint32_t ui32tVrtSpeedDtError;
    uint32_t ui32tHeadingError;
    uint32_t ui32tAppSpeedError;


    //----------------------------------------------------------------------
    // CONSTRUCTORS / DESTRUCTOR
    //----------------------------------------------------------------------

  public:
    CData()
      : pucData( NULL )
    {
      reset();
    }
    ~CData();


    //----------------------------------------------------------------------
    // METHODS
    //----------------------------------------------------------------------

    //
    // SETTERS
    //

  public:

    void reset( bool _bDataFree = true );
    void setID( const char *_pcID );
    uint16_t setData( const unsigned char *_pucData,
                      uint16_t _ui16tDataSize );

    void setTime( double _fdEpoch );
    void setLatitude( double _fdLatitude );
    void setLongitude( double _fdLongitude );
    void setElevation( double _fdElevation );
    void setBearing( double _fdBearing );
    void setGndSpeed( double _fdGndSpeed );
    void setVrtSpeed( double _fdVrtSpeed );
    void setBearingDt( double _fdBearingDt );
    void setGndSpeedDt( double _fdGndSpeedDt );
    void setVrtSpeedDt( double _fdVrtSpeedDt );
    void setHeading( double _fdHeading );
    void setAppSpeed( double _fdApparentSpeed );
    void setSourceType( ESourceType _eSourceType )
    { ui32tSourceType =
        ( _eSourceType != SOURCE_UNDEFINED )
        ? _eSourceType
        : UNDEFINED_UINT32;
    };
    void setLatitudeError( double _fdLatitudeError );
    void setLongitudeError( double _fdLongitudeError );
    void setElevationError( double _fdElevationError );
    void setBearingError( double _fdBearingError );
    void setGndSpeedError( double _fdGndSpeedError );
    void setVrtSpeedError( double _fdVrtSpeedError );
    void setBearingDtError( double _fdBearingDtError );
    void setGndSpeedDtError( double _fdGndSpeedDtError );
    void setVrtSpeedDtError( double _fdVrtSpeedDtError );
    void setHeadingError( double _fdHeadingError );
    void setAppSpeedError( double _fdApparentSpeedError );


    //
    // GETTERS
    //

  public:
    const char* getID() const
    {
      return pcID;
    };
    void getData( unsigned char *_pucData,
                  uint16_t *_pui16tDataSize ) const;
    const unsigned char* getData() const
    {
      return pucData;
    };
    const uint16_t getDataSize() const
    {
      return ui16tDataSize;
    };
    double getTime() const;
    double getLatitude() const;
    double getLongitude() const;
    double getElevation() const;
    double getBearing() const;
    double getGndSpeed() const;
    double getVrtSpeed() const;
    double getBearingDt() const;
    double getGndSpeedDt() const;
    double getVrtSpeedDt() const;
    double getHeading() const;
    double getAppSpeed() const;
    ESourceType getSourceType() const
    {
      return (ESourceType)(ui32tSourceType & 0xFF);
    };
    double getLatitudeError() const;
    double getLongitudeError() const;
    double getElevationError() const;
    double getBearingError() const;
    double getGndSpeedError() const;
    double getVrtSpeedError() const;
    double getBearingDtError() const;
    double getGndSpeedDtError() const;
    double getVrtSpeedDtError() const;
    double getHeadingError() const;
    double getAppSpeedError() const;


    //
    // OTHERS
    //

  private:
    uint16_t allocData( uint16_t _ui16tDataSize );

  public:
    void freeData();
    void copy( const CData &_roData );

    bool sync( const CData &_roData );

  };

}

#endif // SGCTP_CDATA_HPP