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>

Public Member Functions
	ArchiveIndexSchema (const ArchiveIndexSchema &)=delete
ArchiveIndexSchema &	operator= (const ArchiveIndexSchema &)=delete
	ArchiveIndexSchema (ArchiveIndexSchema &&)=delete
ArchiveIndexSchema &	operator= (ArchiveIndexSchema &&)=delete

Static Public Member Functions
static ArchiveIndexSchema const &	get ()
	Return the singleton instance.

Public Attributes
Schema	schema
Key< int >	id
Key< int >	catArchive
Key< int >	catPersistable
Key< int >	row0
Key< int >	nRows
Key< std::string >	name

Static Public Attributes
static Key< std::string > 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.

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 & )

delete

ArchiveIndexSchema() [2/2]

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

delete

Member Function Documentation

get()

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

static

Return the singleton instance.

Definition at line 14 of file ArchiveIndexSchema.cc.

                                                  {
    static ArchiveIndexSchema instance;
    return instance;
}

operator=() [1/2]

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

delete

operator=() [2/2]

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

delete

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.

MAX_MODULE_LENGTH

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

static

Definition at line 46 of file ArchiveIndexSchema.h.

MAX_NAME_LENGTH

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

static

Definition at line 45 of file ArchiveIndexSchema.h.

name

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

Definition at line 42 of file ArchiveIndexSchema.h.

NO_CATALOGS_SAVED

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

staticconstexpr

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:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/include/lsst/afw/table/io/ArchiveIndexSchema.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/src/table/io/ArchiveIndexSchema.cc