yuma.c File Reference


Detailed Description

GNSS core 'c' function library: YUMA format almanacs.

Author:
Glenn D. MacGougan (GDM)
Date:
2007-11-29
Since:
2005-08-14
"LICENSE INFORMATION"
Copyright (c) 2007, refer to 'author' doxygen tags
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided the following conditions are met:

THIS SOFTWARE IS PROVIDED BY THE 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 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.

Definition in file yuma.c.

#include <stdio.h>
#include <string.h>
#include "yuma.h"

Go to the source code of this file.

Functions

BOOL YUMA_ReadAlmanacDataFromFile (const char *yumaFilePath, YUMA_structAlmanac *alm, unsigned char max_to_read, unsigned char *number_read)
 Load an array of YUMA format almanac structs from the ASCII file path specified.
BOOL YUMA_WriteAlmanacDataToFile (const char *yumaFilePath, YUMA_structAlmanac *alm, unsigned char number_to_write)
 Write an array of YUMA format almanac structs to the ASCII file path specified.
BOOL YUMA_WriteSingleAlmanacElementToBuffer (YUMA_structAlmanac alm, char *buffer, unsigned short bufferSize)
 Print a YUMA format almanac struct to buffer supplied.


Function Documentation

BOOL YUMA_ReadAlmanacDataFromFile ( const char *  yumaFilePath,
YUMA_structAlmanac alm,
unsigned char  max_to_read,
unsigned char *  number_read 
)

Load an array of YUMA format almanac structs from the ASCII file path specified.

Author:
Glenn D. MacGougan (GDM)
Date:
2005-08-14
Since:
2005-08-14
Returns:
TRUE(1) if successful, FALSE(0) otherwise
Parameters:
yumaFilePath  path to the input YUMA ASCII file
alm  pointer to an array of YUMA almanac structs
max_to_read  length of the array
number_read  number of almanac items read

Definition at line 45 of file yuma.c.

BOOL YUMA_WriteAlmanacDataToFile ( const char *  yumaFilePath,
YUMA_structAlmanac alm,
unsigned char  number_to_write 
)

Write an array of YUMA format almanac structs to the ASCII file path specified.

Author:
Glenn D. MacGougan (GDM)
Date:
2005-08-14
Since:
2005-08-14
Returns:
TRUE(1) if successful, FALSE(0) otherwise
Parameters:
yumaFilePath  path to the output YUMA ASCII file
alm  pointer to an array of YUMA almanac structs
number_to_write  length of the array

Definition at line 171 of file yuma.c.

BOOL YUMA_WriteSingleAlmanacElementToBuffer ( YUMA_structAlmanac  alm,
char *  buffer,
unsigned short  bufferSize 
)

Print a YUMA format almanac struct to buffer supplied.

Author:
Glenn D. MacGougan (GDM)
Date:
2005-08-15
Since:
2005-08-15
Returns:
TRUE(1) if successful, FALSE(0) otherwise
Parameters:
alm  YUMA almanac struct
buffer  buffer to write the YUMA struct information
bufferSize  size of the buffer, must be greater than 1024 bytes

Definition at line 203 of file yuma.c.