Skip to content

wojciech-graj/libSATCAT

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

libSATCAT

C Parser for the SATCAT Format.

ANSI C compliant and linkable with C++.

Build

The demo program test/test.c can be compiled as follows:

cd test
gcc ../src/satcat.c ../src/satcat_code.c test.c -lm -ansi -I../src -o bin
./bin

Yielding the following output:

Parsed and Validated 52802 satellites in 0.066405s.
Found 51898 valid satellites and 904 invalid satellites.

First satellite:
Name: SL-1 R/B
Catalog Number: 1
Status: Decayed
Source: Commonwealth of Independent States (former USSR)
Launch Site: Tyuratam Missile and Space Center, Kazakhstan

Usage

By default, strings within struct SatCat are NOT NULL-terminated, and are right-padded with spaces. To enable NULL-terminated strings, define SC_CSTRING.

The SATCAT library consists of the following files:

satcat.c + satcat.h

Parses and validates SATCAT strings.

  • sc_parse: Parses a SATCAT-formatted string into a struct SatCat
  • sc_validate: Validates if string is SATCAT-formatted

satcat_code.c + satcat_code.h [Optional]

Provides description strings for SATCAT Operational Status, Source, and Launch Site Codes.

  • SC_STR5_TO_CODE macro: converts a 5-character code (either char source[5] or char launch_site[5] in struct SatCat) into a numeric contant of type sc_code_t, equal to one of SCSRC_* or SCSITE_*
  • sc_source_str & sc_launch_site_str: takes a sc_code_t code and return a verbose description of the satellite's source or launch site.
  • sc_status_str: takes an Operational Status Code (char opstat in struct SatCat, or SCSTAT_*), and returns a description of the satellite's status.

These files can be regenerated using util/gen_code.py if the SATCAT Operational Status, Source, and Launch Site Codes are expanded.

License

Copyright (c) 2022-2024 Wojciech Graj

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.