sem.h File Reference

---

Detailed Description

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

Author:

Glenn D. MacGougan (GDM)

Date:

2006-11-10

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:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  
• The name(s) of the contributor(s) may not be used to endorse or promote products derived from this software without specific prior written permission.
  

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 sem.h.

#include "basictypes.h"

Go to the source code of this file.

Data Structures
struct	SEM_structAlmanac
	A limited set of satellite orbit parameters that is used to calculate GPS satellite positions and velocities. In the ephemeris structure below, the parameters for computing satellite clock corrections are also included. More...
Functions
BOOL	SEM_ReadAlmanacDataFromFile (const char *semFilePath, SEM_structAlmanac *alm, unsigned char max_to_read, unsigned char *number_read)
BOOL	SEM_WriteAlmanacDataToFile (const char *semFilePath, SEM_structAlmanac *alm, unsigned char number_to_write)
BOOL	SEM_WriteSingleAlmanacElementToBuffer (SEM_structAlmanac alm, char *buffer, unsigned short bufferSize)

---

Function Documentation

BOOL SEM_ReadAlmanacDataFromFile	(	const char *	semFilePath,
		SEM_structAlmanac *	alm,
		unsigned char	max_to_read,
		unsigned char *	number_read
	)

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

Author:

Glenn D. MacGougan (GDM)

Date:

2006-11-10

Since:

2005-08-14

Returns:

TRUE(1) if successful, FALSE(0) otherwise

Parameters:

semFilePath	path to the input SEM ASCII file
alm	pointer to an array of SEM almanac structs
max_to_read	length of the array
number_read	number of almanac items read

Definition at line 47 of file sem.c.

BOOL SEM_WriteAlmanacDataToFile	(	const char *	semFilePath,
		SEM_structAlmanac *	alm,
		unsigned char	number_to_write
	)

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

Author:

Glenn D. MacGougan (GDM)

Date:

2006-11-10

Since:

2005-08-15

Returns:

TRUE(1) if successful, FALSE(0) otherwise

Parameters:

semFilePath	path to the output SEM ASCII file
alm	pointer to an array of SEM almanac structs
number_to_write	length of the array

Definition at line 156 of file sem.c.

BOOL SEM_WriteSingleAlmanacElementToBuffer	(	SEM_structAlmanac	alm,
		char *	buffer,
		unsigned short	bufferSize
	)

Print a SEM format almanac struct to buffer supplied.

Author:

Glenn D. MacGougan (GDM)

Date:

2006-11-10

Since:

2005-08-15

Returns:

TRUE(1) if successful, FALSE(0) otherwise

Parameters:

alm	SEM almanac struct
buffer	buffer to write the SEM struct information
bufferSize	size of the buffer, must be greater than 1024 bytes

Definition at line 192 of file sem.c.