LSST Applications g063fba187b+fee0456c91,g0f08755f38+ea96e5a5a3,g1653933729+a8ce1bb630,g168dd56ebc+a8ce1bb630,g1a2382251a+90257ff92a,g20f6ffc8e0+ea96e5a5a3,g217e2c1bcf+937a289c59,g28da252d5a+daa7da44eb,g2bbee38e9b+253935c60e,g2bc492864f+253935c60e,g3156d2b45e+6e55a43351,g32e5bea42b+31359a2a7a,g347aa1857d+253935c60e,g35bb328faa+a8ce1bb630,g3a166c0a6a+253935c60e,g3b1af351f3+a8ce1bb630,g3e281a1b8c+c5dd892a6c,g414038480c+416496e02f,g41af890bb2+afe91b1188,g599934f4f4+0db33f7991,g7af13505b9+e36de7bce6,g80478fca09+da231ba887,g82479be7b0+a4516e59e3,g858d7b2824+ea96e5a5a3,g89c8672015+f4add4ffd5,g9125e01d80+a8ce1bb630,ga5288a1d22+bc6ab8dfbd,gb58c049af0+d64f4d3760,gc28159a63d+253935c60e,gcab2d0539d+3f2b72788c,gcf0d15dbbd+4ea9c45075,gda6a2b7d83+4ea9c45075,gdaeeff99f8+1711a396fd,ge79ae78c31+253935c60e,gef2f8181fd+3031e3cf99,gf0baf85859+c1f95f4921,gfa517265be+ea96e5a5a3,gfa999e8aa5+17cd334064,w.2024.50
LSST Data Management Base Package
|
Base class for all tables. More...
#include <BaseTable.h>
Public Types | |
using | Record = BaseRecord |
The associated record class. | |
using | ColumnView = BaseColumnView |
The associated ColumnView class. | |
using | Catalog = CatalogT<Record> |
Template of CatalogT used to hold records of the associated type. | |
using | ConstCatalog = CatalogT<const Record> |
Template of CatalogT used to hold const records of the associated type. | |
Public Member Functions | |
std::shared_ptr< daf::base::PropertyList > | getMetadata () const |
Return the flexible metadata associated with the table. May be null. | |
void | setMetadata (std::shared_ptr< daf::base::PropertyList > const &metadata) |
Set the flexible metadata associated with the table. May be null. | |
std::shared_ptr< daf::base::PropertyList > | popMetadata () |
Return the metadata and set the internal metadata to a null pointer. | |
std::shared_ptr< BaseTable > | clone () const |
Return a polymorphic deep copy of the table. | |
std::shared_ptr< BaseRecord > | makeRecord () |
Default-construct an associated record. | |
std::shared_ptr< BaseRecord > | copyRecord (BaseRecord const &input) |
Deep-copy a record, requiring that it have the same schema as this table. | |
std::shared_ptr< BaseRecord > | copyRecord (BaseRecord const &input, SchemaMapper const &mapper) |
Deep-copy a record, using a mapper to relate two schemas. | |
Schema | getSchema () const |
Return the table's schema. | |
void | preallocate (std::size_t nRecords) |
Allocate contiguous space for new records in advance. | |
std::size_t | getBufferSize () const |
Return the number of additional records space has been already been allocated for. | |
BaseTable & | operator= (BaseTable const &other)=delete |
BaseTable & | operator= (BaseTable &&other)=delete |
virtual | ~BaseTable () |
T | shared_from_this (T... args) |
Static Public Member Functions | |
static std::shared_ptr< BaseTable > | make (Schema const &schema) |
Construct a new table. | |
static Schema | makeMinimalSchema () |
Return a minimal schema for Base tables and records. | |
Static Public Attributes | |
static int | nRecordsPerBlock = 100 |
Number of records in each memory block. | |
Protected Member Functions | |
template<typename RecordT , typename... Args> | |
std::shared_ptr< RecordT > | constructRecord (Args &&... args) |
Helper function that must be used by all _makeRecord overrides to actually construct records. | |
virtual void | handleAliasChange (std::string const &alias) |
virtual std::shared_ptr< BaseTable > | _clone () const |
Clone implementation with noncovariant return types. | |
virtual std::shared_ptr< BaseRecord > | _makeRecord () |
Default-construct an associated record (protected implementation). | |
BaseTable (Schema const &schema, std::shared_ptr< daf::base::PropertyList > metadata=nullptr) | |
Construct from a schema. | |
BaseTable (BaseTable const &other) | |
BaseTable (BaseTable &&other)=delete | |
Private Member Functions | |
virtual std::shared_ptr< io::FitsWriter > | makeFitsWriter (fits::Fits *fitsfile, int flags) const |
Friends | |
class | BaseRecord |
class | io::FitsWriter |
class | AliasMap |
Base class for all tables.
Tables have two largely distinct purposes:
It's mostly a matter of convenience that we use the same class to serve both needs.
Tables do not actually maintain a list of all the records they have allocated - but those records hold a pointer back to the table. This allows the work of holding and iterating over records to be delegated to templated container classes (such as CatalogT) while allowing tables to be polymorphic, non-template classes. In some sense, then, it may make more sense to think of a table as a combination factory and "container header".
Tables are always created in shared_ptrs (a requirement of enable_shared_from_this). BaseTable provides a make static member function to create a new table, and most derived table classes should do the same.
Each table class should be associated with a particular record class (1-to-1). Each table instance may be associated with many record instances.
Definition at line 61 of file BaseTable.h.
Template of CatalogT used to hold records of the associated type.
Definition at line 70 of file BaseTable.h.
The associated ColumnView class.
Definition at line 67 of file BaseTable.h.
Template of CatalogT used to hold const records of the associated type.
Definition at line 73 of file BaseTable.h.
The associated record class.
Definition at line 64 of file BaseTable.h.
|
virtual |
Definition at line 165 of file BaseTable.cc.
|
explicitprotected |
Construct from a schema.
Definition at line 152 of file BaseTable.cc.
Definition at line 159 of file BaseTable.cc.
|
protecteddelete |
|
protectedvirtual |
Clone implementation with noncovariant return types.
Reimplemented in lsst::afw::detection::PeakTable, lsst::afw::table::ExposureTable, lsst::afw::table::SimpleTable, and lsst::afw::table::SourceTable.
Definition at line 144 of file BaseTable.cc.
|
protectedvirtual |
Default-construct an associated record (protected implementation).
Reimplemented in lsst::afw::detection::PeakTable, lsst::afw::table::ExposureTable, lsst::afw::table::SimpleTable, and lsst::afw::table::SourceTable.
Definition at line 150 of file BaseTable.cc.
|
inline |
Return a polymorphic deep copy of the table.
Derived classes should reimplement by static-casting the output of _clone to a pointer-to-derived to simulate covariant return types.
Cloning a table does not clone its associated records; the new table produced by clone() does not have any associated records.
Definition at line 100 of file BaseTable.h.
|
protected |
Helper function that must be used by all _makeRecord overrides to actually construct records.
Use of this function is enforced by the fact that Record::ConstructionToken can only be created by BaseTable, and is only ever constructed inside this method.
This function expects Record subclasses to have a constructor signature of the form
Record(ConstructionToken const &, detail::RecordData &&, Args && ...);
Definition at line 227 of file BaseRecord.h.
std::shared_ptr< BaseRecord > lsst::afw::table::BaseTable::copyRecord | ( | BaseRecord const & | input | ) |
Deep-copy a record, requiring that it have the same schema as this table.
Regardless of the type or associated table of the input record, the type of the output record will be the type associated with this table and the record instance will be associated with this table.
Allowing derived-class records to be constructed from base-class records could be considered a form of type-slicing, but because we already demand that all records be constructable from nothing but a table, this isn't anything new.
Derived classes should reimplement by static-casting the output of BaseTable::copyRecord to the appropriate BaseRecord subclass.
This is implemented using makeRecord and calling record.assign on the results; override those to change the behavior.
Definition at line 128 of file BaseTable.cc.
std::shared_ptr< BaseRecord > lsst::afw::table::BaseTable::copyRecord | ( | BaseRecord const & | input, |
SchemaMapper const & | mapper ) |
Deep-copy a record, using a mapper to relate two schemas.
Regardless of the type or associated table of the input record, the type of the output record will be the type associated with this table and the record instance will be associated with this table.
Allowing derived-class records to be constructed from base-class records could be considered a form of type-slicing, but because we already demand that all records be constructable from nothing but a table, this isn't anything new.
Derived classes should reimplement by static-casting the output of BaseTable::copyRecord to the appropriate BaseRecord subclass.
This is implemented using makeRecord and calling record.assign on the results; override those to change the behavior.
Definition at line 134 of file BaseTable.cc.
std::size_t lsst::afw::table::BaseTable::getBufferSize | ( | ) | const |
Return the number of additional records space has been already been allocated for.
Unlike std::vector::capacity, this does not factor in existing records in any way.
Definition at line 112 of file BaseTable.cc.
|
inline |
Return the flexible metadata associated with the table. May be null.
Definition at line 79 of file BaseTable.h.
|
inline |
|
inlineprotectedvirtual |
|
static |
Construct a new table.
Because BaseTable is an abstract class, this actually returns a hidden trivial subclass (which is associated with a hidden trivial subclass of BaseRecord).
Hiding concrete table and record classes in anonymous namespaces is not required, but it makes it easier to ensure instances are always created within shared_ptrs, and it eliminates some multilateral friending that would otherwise be necessary. In some cases it may also serve as a form of pimpl, keeping class implementation details out of header files.
Definition at line 120 of file BaseTable.cc.
|
privatevirtual |
Reimplemented in lsst::afw::detection::PeakTable, lsst::afw::table::ExposureTable, lsst::afw::table::SimpleTable, and lsst::afw::table::SourceTable.
Definition at line 140 of file BaseTable.cc.
|
static |
Return a minimal schema for Base tables and records.
The returned empty schema can and generally should be modified further.
Definition at line 126 of file BaseTable.cc.
|
inline |
Default-construct an associated record.
Derived classes should reimplement by static-casting the output of _makeRecord to the appropriate BaseRecord subclass to simulate covariant return types.
Definition at line 108 of file BaseTable.h.
|
inline |
Return the metadata and set the internal metadata to a null pointer.
Definition at line 85 of file BaseTable.h.
void lsst::afw::table::BaseTable::preallocate | ( | std::size_t | nRecords | ) |
Allocate contiguous space for new records in advance.
If a contiguous memory block for at least n additional records has already been allocated, this is a no-op. If not, a new block will be allocated, and any remaining space on the old block will go to waste; this ensures the new records will be allocated contiguously. Note that "wasted" memory is not leaked; it will be deallocated along with any records created from that block when those records go out of scope.
Note that unlike std::vector::reserve, this does not factor in existing records in any way; nRecords refers to a number of new records to reserve space for.
Definition at line 110 of file BaseTable.cc.
|
inline |
Set the flexible metadata associated with the table. May be null.
Definition at line 82 of file BaseTable.h.
Definition at line 224 of file BaseTable.h.
|
friend |
Definition at line 222 of file BaseTable.h.
|
friend |
Definition at line 223 of file BaseTable.h.
|
static |
Number of records in each memory block.
Definition at line 76 of file BaseTable.h.