LSSTApplications  19.0.0-11-g2ce9f25+4,20.0.0+1,20.0.0+10,20.0.0+11,20.0.0+13,20.0.0+2,20.0.0+3,20.0.0+4,20.0.0+6,20.0.0-1-g10df615+10,20.0.0-1-g253301a+5,20.0.0-1-g596936a+11,20.0.0-1-g8a53f90+1,20.0.0-1-gc96f8cb+12,20.0.0-1-gd1c87d7+1,20.0.0-17-g41c5faf,20.0.0-2-g04cfba9+4,20.0.0-2-gd11eeda,20.0.0-2-gec03fae+3,20.0.0-3-g082faa5+1,20.0.0-3-gbdbfa727+3,20.0.0-3-gc53c7b6,20.0.0-4-gde602ef96+4,20.0.0-4-ge48a6ca+6,20.0.0-4-ge987224+1,20.0.0-8-g7eef53f7+7,20.0.0-9-g8e1b333,w.2020.28
LSSTDataManagementBasePackage
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Friends | List of all members
lsst::afw::table::BaseTable Class Reference

Base class for all tables. More...

#include <BaseTable.h>

Inheritance diagram for lsst::afw::table::BaseTable:
std::enable_shared_from_this< BaseTable > lsst::afw::detection::PeakTable lsst::afw::table::ExposureTable lsst::afw::table::SimpleTable lsst::afw::table::SourceTable

Public Types

typedef BaseRecord Record
 The associated record class. More...
 
typedef BaseColumnView ColumnView
 The associated ColumnView class. More...
 
typedef CatalogT< RecordCatalog
 Template of CatalogT used to hold records of the associated type. More...
 
typedef CatalogT< Record const > ConstCatalog
 Template of CatalogT used to hold const records of the associated type. More...
 

Public Member Functions

std::shared_ptr< daf::base::PropertyListgetMetadata () const
 Return the flexible metadata associated with the table. May be null. More...
 
void setMetadata (std::shared_ptr< daf::base::PropertyList > const &metadata)
 Set the flexible metadata associated with the table. May be null. More...
 
std::shared_ptr< daf::base::PropertyListpopMetadata ()
 Return the metadata and set the internal metadata to a null pointer. More...
 
std::shared_ptr< BaseTableclone () const
 Return a polymorphic deep copy of the table. More...
 
std::shared_ptr< BaseRecordmakeRecord ()
 Default-construct an associated record. More...
 
std::shared_ptr< BaseRecordcopyRecord (BaseRecord const &input)
 Deep-copy a record, requiring that it have the same schema as this table. More...
 
std::shared_ptr< BaseRecordcopyRecord (BaseRecord const &input, SchemaMapper const &mapper)
 Deep-copy a record, using a mapper to relate two schemas. More...
 
Schema getSchema () const
 Return the table's schema. More...
 
void preallocate (std::size_t nRecords)
 Allocate contiguous space for new records in advance. More...
 
std::size_t getBufferSize () const
 Return the number of additional records space has been already been allocated for. More...
 
BaseTableoperator= (BaseTable const &other)=delete
 
BaseTableoperator= (BaseTable &&other)=delete
 
virtual ~BaseTable ()
 
shared_from_this (T... args)
 

Static Public Member Functions

static std::shared_ptr< BaseTablemake (Schema const &schema)
 Construct a new table. More...
 

Static Public Attributes

static int nRecordsPerBlock = 100
 Number of records in each memory block. More...
 

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. More...
 
virtual void handleAliasChange (std::string const &alias)
 
virtual std::shared_ptr< BaseTable_clone () const
 Clone implementation with noncovariant return types. More...
 
virtual std::shared_ptr< BaseRecord_makeRecord ()
 Default-construct an associated record (protected implementation). More...
 
 BaseTable (Schema const &schema)
 Construct from a schema. More...
 
 BaseTable (BaseTable const &other)
 Copy construct. More...
 
 BaseTable (BaseTable &&other)
 

Friends

class BaseRecord
 
class io::FitsWriter
 
class AliasMap
 

Detailed Description

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.

Member Typedef Documentation

◆ Catalog

Template of CatalogT used to hold records of the associated type.

Definition at line 70 of file BaseTable.h.

◆ ColumnView

The associated ColumnView class.

Definition at line 67 of file BaseTable.h.

◆ ConstCatalog

Template of CatalogT used to hold const records of the associated type.

Definition at line 73 of file BaseTable.h.

◆ Record

The associated record class.

Definition at line 64 of file BaseTable.h.

Constructor & Destructor Documentation

◆ ~BaseTable()

lsst::afw::table::BaseTable::~BaseTable ( )
virtual

Definition at line 155 of file BaseTable.cc.

155 { _schema.getAliasMap()->_table = 0; }

◆ BaseTable() [1/3]

lsst::afw::table::BaseTable::BaseTable ( Schema const &  schema)
explicitprotected

Construct from a schema.

Definition at line 149 of file BaseTable.cc.

149  : _schema(schema) {
150  Block::padSchema(_schema);
151  _schema.disconnectAliases();
152  _schema.getAliasMap()->_table = this;
153 }

◆ BaseTable() [2/3]

lsst::afw::table::BaseTable::BaseTable ( BaseTable const &  other)
inlineprotected

Copy construct.

Definition at line 213 of file BaseTable.h.

213  : _schema(other._schema), _metadata(other._metadata) {
214  if (_metadata) _metadata = std::static_pointer_cast<daf::base::PropertyList>(_metadata->deepCopy());
215  }

◆ BaseTable() [3/3]

lsst::afw::table::BaseTable::BaseTable ( BaseTable &&  other)
inlineprotected

Definition at line 217 of file BaseTable.h.

217 : BaseTable(other) {}

Member Function Documentation

◆ _clone()

std::shared_ptr< BaseTable > lsst::afw::table::BaseTable::_clone ( ) const
protectedvirtual

Clone implementation with noncovariant return types.

Reimplemented in lsst::afw::table::SourceTable, lsst::afw::table::ExposureTable, lsst::afw::table::SimpleTable, and lsst::afw::detection::PeakTable.

Definition at line 141 of file BaseTable.cc.

141  {
142  return std::shared_ptr<BaseTable>(new BaseTable(*this));
143 }

◆ _makeRecord()

std::shared_ptr< BaseRecord > lsst::afw::table::BaseTable::_makeRecord ( )
protectedvirtual

Default-construct an associated record (protected implementation).

Reimplemented in lsst::afw::table::SourceTable, lsst::afw::table::ExposureTable, lsst::afw::table::SimpleTable, and lsst::afw::detection::PeakTable.

Definition at line 145 of file BaseTable.cc.

145  {
146  return constructRecord<BaseRecord>();
147 }

◆ clone()

std::shared_ptr<BaseTable> lsst::afw::table::BaseTable::clone ( ) const
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.

100 { return _clone(); }

◆ constructRecord()

template<typename RecordT , typename ... Args>
std::shared_ptr< RecordT > lsst::afw::table::BaseTable::constructRecord ( Args &&...  args)
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.

227  {
228  return std::make_shared<RecordT>(BaseRecord::ConstructionToken(0), _makeNewRecordData(),
229  std::forward<Args>(args)...);
230 }

◆ copyRecord() [1/2]

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 125 of file BaseTable.cc.

125  {
127  output->assign(input);
128  return output;
129 }

◆ copyRecord() [2/2]

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 131 of file BaseTable.cc.

131  {
133  output->assign(input, mapper);
134  return output;
135 }

◆ getBufferSize()

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 113 of file BaseTable.cc.

113  {
114  if (_manager) {
115  return Block::getBufferSize(_schema.getRecordSize(), _manager);
116  } else {
117  return 0;
118  }
119 }

◆ getMetadata()

std::shared_ptr<daf::base::PropertyList> lsst::afw::table::BaseTable::getMetadata ( ) const
inline

Return the flexible metadata associated with the table. May be null.

Definition at line 79 of file BaseTable.h.

79 { return _metadata; }

◆ getSchema()

Schema lsst::afw::table::BaseTable::getSchema ( ) const
inline

Return the table's schema.

Definition at line 137 of file BaseTable.h.

137 { return _schema; }

◆ handleAliasChange()

virtual void lsst::afw::table::BaseTable::handleAliasChange ( std::string const &  alias)
inlineprotectedvirtual

Reimplemented in lsst::afw::table::SourceTable.

Definition at line 201 of file BaseTable.h.

201 {}

◆ make()

std::shared_ptr< BaseTable > lsst::afw::table::BaseTable::make ( Schema const &  schema)
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 121 of file BaseTable.cc.

121  {
123 }

◆ makeRecord()

std::shared_ptr<BaseRecord> lsst::afw::table::BaseTable::makeRecord ( )
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.

108 { return _makeRecord(); }

◆ operator=() [1/2]

BaseTable& lsst::afw::table::BaseTable::operator= ( BaseTable &&  other)
delete

◆ operator=() [2/2]

BaseTable& lsst::afw::table::BaseTable::operator= ( BaseTable const &  other)
delete

◆ popMetadata()

std::shared_ptr<daf::base::PropertyList> lsst::afw::table::BaseTable::popMetadata ( )
inline

Return the metadata and set the internal metadata to a null pointer.

Definition at line 85 of file BaseTable.h.

85  {
87  _metadata.swap(tmp);
88  return tmp;
89  }

◆ preallocate()

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 111 of file BaseTable.cc.

111 { Block::preallocate(_schema.getRecordSize(), n, _manager); }

◆ setMetadata()

void lsst::afw::table::BaseTable::setMetadata ( std::shared_ptr< daf::base::PropertyList > const &  metadata)
inline

Set the flexible metadata associated with the table. May be null.

Definition at line 82 of file BaseTable.h.

82 { _metadata = metadata; }

Friends And Related Function Documentation

◆ AliasMap

friend class AliasMap
friend

Definition at line 222 of file BaseTable.h.

◆ BaseRecord

friend class BaseRecord
friend

Definition at line 220 of file BaseTable.h.

◆ io::FitsWriter

friend class io::FitsWriter
friend

Definition at line 221 of file BaseTable.h.

Member Data Documentation

◆ nRecordsPerBlock

int lsst::afw::table::BaseTable::nRecordsPerBlock = 100
static

Number of records in each memory block.

Definition at line 76 of file BaseTable.h.


The documentation for this class was generated from the following files:
schema
table::Schema schema
Definition: Amplifier.cc:115
std::shared_ptr
STL class.
lsst::meas::algorithms.psfSelectionFromMatchList.args
list args
Definition: psfSelectionFromMatchList.py:27
lsst::afw::table::Schema::getRecordSize
int getRecordSize() const
Return the raw size of a record in bytes.
Definition: Schema.h:148
lsst::afw::table::BaseTable::_clone
virtual std::shared_ptr< BaseTable > _clone() const
Clone implementation with noncovariant return types.
Definition: BaseTable.cc:141
lsst::afw::table::BaseTable::makeRecord
std::shared_ptr< BaseRecord > makeRecord()
Default-construct an associated record.
Definition: BaseTable.h:108
other
ItemVariant const * other
Definition: Schema.cc:56
mapper
SchemaMapper * mapper
Definition: SchemaMapper.cc:78
lsst::afw::table::Schema::disconnectAliases
void disconnectAliases()
Sever the connection between this schema and any others with which it shares aliases.
Definition: Schema.cc:729
lsst::afw::table::BaseTable::BaseTable
BaseTable(Schema const &schema)
Construct from a schema.
Definition: BaseTable.cc:149
lsst::afw::table::BaseTable::_makeRecord
virtual std::shared_ptr< BaseRecord > _makeRecord()
Default-construct an associated record (protected implementation).
Definition: BaseTable.cc:145
lsst::afw::table::Schema::getAliasMap
std::shared_ptr< AliasMap > getAliasMap() const
Return the map of aliases.
Definition: Schema.h:269