LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst::afw::table::io::ArchiveIndexSchema Struct Referencefinal

Schema for the index catalog that specifies where objects are stored in the data catalogs. More...

#include <ArchiveIndexSchema.h>

Public Member Functions

 ArchiveIndexSchema (const ArchiveIndexSchema &)=delete
ArchiveIndexSchemaoperator= (const ArchiveIndexSchema &)=delete
 ArchiveIndexSchema (ArchiveIndexSchema &&)=delete
ArchiveIndexSchemaoperator= (ArchiveIndexSchema &&)=delete

Static Public Member Functions

static ArchiveIndexSchema const & get ()
 Return the singleton instance. More...

Public Attributes

Schema schema
Key< int > id
Key< int > catArchive
Key< int > catPersistable
Key< int > row0
Key< int > nRows
Key< std::stringname
Key< std::stringmodule

Static Public Attributes

static int const MAX_NAME_LENGTH = 64
static int const MAX_MODULE_LENGTH = 64
static constexpr int const NO_CATALOGS_SAVED = -1
 Special value used for catArchive, catPersistable, and row0 when an object with no state is saved. More...

Detailed Description

Schema for the index catalog that specifies where objects are stored in the data catalogs.

Each row in the index catalog corresponds to a combination of an object and a data catalog, and contains the range of rows used by that object in the catalog (in the 'row0' and 'nrows' fields). The 'cat.archive' field indicates which catalog in the archive the index entry refers to (where 0 is the index itself, and 1 is the first data catalog), and 'cat.persistable' refers to which catalog the index entry refers to from the perspective of the saved object.

An object may thus have more than one row in the index, but the 'id' and 'name' fields must be the same for all index entires that correspond to a single object. These contain, respectively, the unique ID returned by OutputArchive::put and the name returned by Persistable::getPersistenceName() and used by InputArchive to look up a PersistableFactory in the registry.

Definition at line 35 of file ArchiveIndexSchema.h.

Constructor & Destructor Documentation

◆ ArchiveIndexSchema() [1/2]

lsst::afw::table::io::ArchiveIndexSchema::ArchiveIndexSchema ( const ArchiveIndexSchema )

◆ ArchiveIndexSchema() [2/2]

lsst::afw::table::io::ArchiveIndexSchema::ArchiveIndexSchema ( ArchiveIndexSchema &&  )

Member Function Documentation

◆ get()

ArchiveIndexSchema const & lsst::afw::table::io::ArchiveIndexSchema::get ( )

Return the singleton instance.

Definition at line 14 of file

14  {
15  static ArchiveIndexSchema instance;
16  return instance;
17 }
ArchiveIndexSchema(const ArchiveIndexSchema &)=delete

◆ operator=() [1/2]

ArchiveIndexSchema& lsst::afw::table::io::ArchiveIndexSchema::operator= ( ArchiveIndexSchema &&  )

◆ operator=() [2/2]

ArchiveIndexSchema& lsst::afw::table::io::ArchiveIndexSchema::operator= ( const ArchiveIndexSchema )

Member Data Documentation

◆ catArchive

Key<int> lsst::afw::table::io::ArchiveIndexSchema::catArchive

Definition at line 38 of file ArchiveIndexSchema.h.

◆ catPersistable

Key<int> lsst::afw::table::io::ArchiveIndexSchema::catPersistable

Definition at line 39 of file ArchiveIndexSchema.h.

◆ id

Key<int> lsst::afw::table::io::ArchiveIndexSchema::id

Definition at line 37 of file ArchiveIndexSchema.h.


int const lsst::afw::table::io::ArchiveIndexSchema::MAX_MODULE_LENGTH = 64

Definition at line 46 of file ArchiveIndexSchema.h.


int const lsst::afw::table::io::ArchiveIndexSchema::MAX_NAME_LENGTH = 64

Definition at line 45 of file ArchiveIndexSchema.h.

◆ module

Key<std::string> lsst::afw::table::io::ArchiveIndexSchema::module

Definition at line 43 of file ArchiveIndexSchema.h.

◆ name

Key<std::string> lsst::afw::table::io::ArchiveIndexSchema::name

Definition at line 42 of file ArchiveIndexSchema.h.


constexpr int const lsst::afw::table::io::ArchiveIndexSchema::NO_CATALOGS_SAVED = -1

Special value used for catArchive, catPersistable, and row0 when an object with no state is saved.

Definition at line 52 of file ArchiveIndexSchema.h.

◆ nRows

Key<int> lsst::afw::table::io::ArchiveIndexSchema::nRows

Definition at line 41 of file ArchiveIndexSchema.h.

◆ row0

Key<int> lsst::afw::table::io::ArchiveIndexSchema::row0

Definition at line 40 of file ArchiveIndexSchema.h.

◆ schema

Schema lsst::afw::table::io::ArchiveIndexSchema::schema

Definition at line 36 of file ArchiveIndexSchema.h.

The documentation for this struct was generated from the following files: