lsst::afw::table::io::ArchiveIndexSchema Struct Reference

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

#include <ArchiveIndexSchema.h>

Inheritance diagram for lsst::afw::table::io::ArchiveIndexSchema:

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::string >	name
Key< std::string >	module

Static Public Attributes
static int const	MAX_NAME_LENGTH = 64
static int const	MAX_MODULE_LENGTH = 64

Private Member Functions
	ArchiveIndexSchema ()

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 36 of file ArchiveIndexSchema.h.

Constructor & Destructor Documentation

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

private

Member Function Documentation

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

static

Return the singleton instance.

Member Data Documentation

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

Definition at line 39 of file ArchiveIndexSchema.h.

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

Definition at line 40 of file ArchiveIndexSchema.h.

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

Definition at line 38 of file ArchiveIndexSchema.h.

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

static

Definition at line 47 of file ArchiveIndexSchema.h.

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

static

Definition at line 46 of file ArchiveIndexSchema.h.

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

Definition at line 44 of file ArchiveIndexSchema.h.

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

Definition at line 43 of file ArchiveIndexSchema.h.

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

Definition at line 42 of file ArchiveIndexSchema.h.

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

Definition at line 41 of file ArchiveIndexSchema.h.

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

Definition at line 37 of file ArchiveIndexSchema.h.

---

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

• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/table/io/ArchiveIndexSchema.h