nmeap.h

Go to the documentation of this file.

/*
Copyright (c) 2005, David M Howard (daveh at dmh2000.com)
All rights reserved.

This product is licensed for use and distribution under the BSD Open Source License.
see the file COPYING for more details.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, 
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 

*/

#ifndef __NMEAP_H__
#define __NMEAP_H__

#ifdef __cplusplus
extern "C" {
#endif

/* 
============================================
COMPILE TIME CONFIGURATION CONSTANTS
============================================
*/

/* these constants affect the size of the context object. tweak them as desired but know what you are doing */

#define NMEAP_MAX_SENTENCES            8

#define NMEAP_MAX_SENTENCE_NAME_LENGTH 5

#define NMEAP_MAX_SENTENCE_LENGTH      255

#define NMEAP_MAX_TOKENS               24

/* predefined message ID's */

/* GGA MESSAGE ID */
#define NMEAP_GPGGA 1
/* RMC MESSAGE ID */
#define NMEAP_GPRMC 2

#define NMEAP_USER  100

/* forward references */
struct nmeap_context;
struct nmeap_sentence;

/* 
============================================
CALLOUTS
============================================
*/

typedef void (*nmeap_callout_t)(struct nmeap_context *context,void *sentence_data,void *user_data);

typedef int (*nmeap_sentence_parser_t)(struct nmeap_context *context,struct nmeap_sentence *sentence);


/* ==== opaque types === */
#include "nmeap_def.h"


/* 
============================================
STANDARD SENTENCE DATA STRUCTURES
============================================
*/

struct nmeap_gga {
        double        latitude;   
        double        longitude;  
        double        altitude;   
        unsigned long time;       
        int           satellites; 
        int           quality;    
        double        hdop;       
        double        geoid;      
};
typedef struct nmeap_gga nmeap_gga_t;

struct nmeap_rmc {
        unsigned long time;      
        char          warn;      
        double        latitude;  
        double        longitude; 
        double        speed;     
        double        course;    
        unsigned long date;      
        double        magvar;    
};

typedef struct nmeap_rmc nmeap_rmc_t;

/* 
============================================
METHODS
============================================
*/

int nmeap_init(nmeap_context_t *context,void *user_data);

int nmeap_addParser(nmeap_context_t         *context,
                                         const char             *sentence_name,
                                         nmeap_sentence_parser_t sentence_parser,
                                         nmeap_callout_t         sentence_callout,
                                         void                   *sentence_data
                                         );

int nmeap_parseBuffer(nmeap_context_t *context,const char *buffer,int *length);

int nmeap_parse(nmeap_context_t *context,char ch);


int nmeap_gpgga(nmeap_context_t *context,nmeap_sentence_t *sentence);

int nmeap_gprmc(nmeap_context_t *context,nmeap_sentence_t *sentence);

double nmeap_latitude(const char *plat,const char *phem);


double nmeap_longitude(const char *plat,const char *phem);

#ifdef __cplusplus
} // extern C
#endif


#endif

---