Base class for all tables. More...

#include <BaseTable.h>

Inheritance diagram for lsst::afw::table::BaseTable:

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

Detailed Description

Base class for all tables.

Tables have two largely distinct purposes:

They serve as factories for records, allocating their field data in blocks.
They carry additional information (such as the schema) that should be shared by multiple records.

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

using lsst::afw::table::BaseTable::Catalog = CatalogT<Record>

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

Definition at line 70 of file BaseTable.h.

◆ ColumnView

using lsst::afw::table::BaseTable::ColumnView = BaseColumnView

The associated ColumnView class.

Definition at line 67 of file BaseTable.h.

◆ ConstCatalog

using lsst::afw::table::BaseTable::ConstCatalog = CatalogT<const Record>

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

Definition at line 73 of file BaseTable.h.

◆ Record

using lsst::afw::table::BaseTable::Record = BaseRecord

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

165{ _schema.getAliasMap()->getTable().reset(); }

lsst::afw::table::Schema::getAliasMap

std::shared_ptr< AliasMap > getAliasMap() const

Return the map of aliases.

Definition Schema.h:279

◆ BaseTable() [1/3]

lsst::afw::table::BaseTable::BaseTable	(	Schema const &	schema,
		std::shared_ptr< daf::base::PropertyList >	metadata = nullptr )

explicitprotected

Construct from a schema.

Definition at line 152 of file BaseTable.cc.

        : _schema(schema), _metadata(metadata) {
    Block::padSchema(_schema);
    _schema.disconnectAliases();
    _schema.getAliasMap()->getTable().reset();
}

◆ BaseTable() [2/3]

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

protected

Definition at line 159 of file BaseTable.cc.

                                           : _schema(other._schema), _metadata(other._metadata) {
    _schema.disconnectAliases();
    _schema.getAliasMap()->getTable().reset();
    if (_metadata) _metadata = std::static_pointer_cast<daf::base::PropertyList>(_metadata->deepCopy());
}

◆ BaseTable() [3/3]

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

protecteddelete

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::detection::PeakTable, lsst::afw::table::ExposureTable, lsst::afw::table::SimpleTable, and lsst::afw::table::SourceTable.

Definition at line 144 of file BaseTable.cc.

                                                 {
    std::shared_ptr<BaseTable> table(new BaseTable(*this));
    table->getSchema().getAliasMap()->setTable(table);
    return table;
}

◆ _makeRecord()

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

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.

150{ return constructRecord<BaseRecord>(); }

◆ 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(); }

lsst::afw::table::BaseTable::_clone

virtual std::shared_ptr< BaseTable > _clone() const

Clone implementation with noncovariant return types.

Definition BaseTable.cc:144

◆ 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.

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

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

                                                                       {
    std::shared_ptr<BaseRecord> output = makeRecord();
    output->assign(input);
    return output;
}

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

                                                                                                   {
    std::shared_ptr<BaseRecord> output = makeRecord();
    output->assign(input, mapper);
    return output;
}

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

                                         {
    if (_manager) {
        return Block::getBufferSize(_schema.getRecordSize(), _manager);
    } else {
        return 0;
    }
}

◆ 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 207 of file BaseTable.h.

207{}

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

                                                             {
    std::shared_ptr<BaseTable> table(new BaseTable(schema));
    table->getSchema().getAliasMap()->setTable(table);
    return table;
}

◆ makeFitsWriter()

std::shared_ptr< io::FitsWriter > lsst::afw::table::BaseTable::makeFitsWriter	(	fits::Fits *	fitsfile,
		int	flags ) const

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.

                                                                                         {
    return std::make_shared<io::FitsWriter>(fitsfile, flags);
}

◆ makeMinimalSchema()

Schema lsst::afw::table::BaseTable::makeMinimalSchema ( )

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.

126{ return Schema(); }

◆ 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(); }

lsst::afw::table::BaseTable::_makeRecord

virtual std::shared_ptr< BaseRecord > _makeRecord()

Default-construct an associated record (protected implementation).

Definition BaseTable.cc:150

◆ 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.

                                                     {
        std::shared_ptr<daf::base::PropertyList> tmp;
        _metadata.swap(tmp);
        return tmp;
    }

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

110{ 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 Symbol Documentation

◆ AliasMap

friend class AliasMap

friend

Definition at line 224 of file BaseTable.h.

◆ BaseRecord

friend class BaseRecord

friend

Definition at line 222 of file BaseTable.h.

◆ io::FitsWriter

friend class io::FitsWriter

friend

Definition at line 223 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:

/j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/g9726552aa6+10f999ec6a/include/lsst/afw/table/BaseTable.h
/j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/g9726552aa6+10f999ec6a/include/lsst/afw/table/BaseRecord.h
/j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/g9726552aa6+10f999ec6a/src/table/BaseTable.cc

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ Catalog

◆ ColumnView

◆ ConstCatalog

◆ Record

Constructor & Destructor Documentation

◆ ~BaseTable()

◆ BaseTable() [1/3]

◆ BaseTable() [2/3]

◆ BaseTable() [3/3]

Member Function Documentation

◆ _clone()

◆ _makeRecord()

◆ clone()

◆ constructRecord()

◆ copyRecord() [1/2]

◆ copyRecord() [2/2]

◆ getBufferSize()

◆ getMetadata()

◆ getSchema()

◆ handleAliasChange()

◆ make()

◆ makeFitsWriter()

◆ makeMinimalSchema()

◆ makeRecord()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ popMetadata()

◆ preallocate()

◆ setMetadata()

Friends And Related Symbol Documentation

◆ AliasMap

◆ BaseRecord

◆ io::FitsWriter

Member Data Documentation

◆ nRecordsPerBlock