src/libastrodb/library.h

   1 /*
   2  *  This library is free software; you can redistribute it and/or
   3  *  modify it under the terms of the GNU Lesser General Public
   4  *  License as published by the Free Software Foundation; either
   5  *  version 2 of the License, or (at your option) any later version.
   6  *
   7  *  This library is distributed in the hope that it will be useful,
   8  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
   9  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  10  *  Lesser General Public License for more details.
  11  *
  12  *  You should have received a copy of the GNU General Public License
  13  *  along with this program; if not, write to the Free Software
  14  *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  15  *
  16  *  Copyright (C) 2005 Liam Girdwood
  17  */
  18
  19 #ifndef __LNC_LIBARY_H
  20 #define __LNC_LIBARY_H
  21
  22 #include <libastrodb/astrodb.h>
  23
  24
  25 /*! \defgroup library Library
  26  *
  27  * An object representing a local catalog repository.
  28  *
  29  * A local library is a mirror of a remote CDS mirror in
  30  * structure. Catalogs can then be downloaded in part or in whole
  31  * on a need by need basis to populate the library.
  32  *
  33  * CDS directory structure mirrored:-
  34  *
  35  *  - I/number                  Astrometric Catalogues
  36  *  - II/number                 Photometric Catalogues (except Radio)
  37  *  - III/number                Spectroscopic Catalogues
  38  *  - IV/number                 Cross-Identifications
  39  *  - V/number                  Combined Data
  40  *  - VI/number                 Miscellaneous Catalogues
  41  *  - VII/number                Non-stellar Objects
  42  *  - VIII/number               Radio Catalogues
  43  *  - IX/number                 High Energy Catalogues
  44  */
  45
  46 /*! \typedef struct astrodb_library
  47  * \brief Local CDS catalog repository
  48  * \ingroup library
  49  *
  50  * The library container.
  51  */
  52 struct astrodb_library {
  53         char* local;    /*!< local repository and cache */
  54         char* remote;   /*!< remote repository */
  55         unsigned int err; /*!< last error */
  56 };
  57
  58 #endif