LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Friends | List of all members
lsst::afw::table::SimpleTable Class Reference

Table class that must contain a unique ID field and a celestial coordinate field. More...

#include <Simple.h>

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

Public Types

using Record = SimpleRecord
 
using ColumnView = ColumnViewT< SimpleRecord >
 
using Catalog = SortedCatalogT< Record >
 
using ConstCatalog = SortedCatalogT< const Record >
 

Public Member Functions

std::shared_ptr< IdFactorygetIdFactory ()
 Return the object that generates IDs for the table (may be null). More...
 
std::shared_ptr< IdFactory const > getIdFactory () const
 Return the object that generates IDs for the table (may be null). More...
 
void setIdFactory (std::shared_ptr< IdFactory > f)
 Switch to a new IdFactory – object that generates IDs for the table (may be null). More...
 
std::shared_ptr< SimpleTableclone () const
 Return a polymorphic deep copy of the table. More...
 
std::shared_ptr< SimpleRecordmakeRecord ()
 Default-construct an associated record. More...
 
std::shared_ptr< SimpleRecordcopyRecord (BaseRecord const &other)
 Deep-copy a record, requiring that it have the same schema as this table. More...
 
std::shared_ptr< SimpleRecordcopyRecord (BaseRecord const &other, SchemaMapper const &mapper)
 Deep-copy a record, requiring that it have the same schema as this table. More...
 
SimpleTableoperator= (SimpleTable const &)=delete
 
SimpleTableoperator= (SimpleTable &&)=delete
 
 ~SimpleTable () override
 
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...
 
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...
 
shared_from_this (T... args)
 

Static Public Member Functions

static std::shared_ptr< SimpleTablemake (Schema const &schema, std::shared_ptr< IdFactory > const &idFactory)
 Construct a new table. More...
 
static std::shared_ptr< SimpleTablemake (Schema const &schema)
 Construct a new table. More...
 
static Schema makeMinimalSchema ()
 Return a minimal schema for Simple tables and records. More...
 
static bool checkSchema (Schema const &other)
 Return true if the given schema is a valid SimpleTable schema. More...
 
static Key< RecordIdgetIdKey ()
 Get keys for standard fields shared by all references. More...
 
static CoordKey getCoordKey ()
 Key for the celestial coordinates. More...
 

Static Public Attributes

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

Protected Member Functions

 SimpleTable (Schema const &schema, std::shared_ptr< IdFactory > const &idFactory)
 
 SimpleTable (SimpleTable const &other)
 
 SimpleTable (SimpleTable &&other)
 
std::shared_ptr< BaseTable_clone () const override
 Clone implementation with noncovariant return types. More...
 
std::shared_ptr< BaseRecord_makeRecord () override
 Default-construct an associated record (protected implementation). More...
 
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)
 

Friends

class io::FitsWriter
 

Detailed Description

Table class that must contain a unique ID field and a celestial coordinate field.

SimpleTable / SimpleRecord are intended to be the base class for records representing astronomical objects. In additional to the minimal schema and the convenience accessors it allows, a SimpleTable may hold an IdFactory object that is used to assign unique IDs to new records.

Definition at line 102 of file Simple.h.

Member Typedef Documentation

◆ Catalog

Definition at line 106 of file Simple.h.

◆ ColumnView

Definition at line 105 of file Simple.h.

◆ ConstCatalog

Definition at line 107 of file Simple.h.

◆ Record

Definition at line 104 of file Simple.h.

Constructor & Destructor Documentation

◆ ~SimpleTable()

lsst::afw::table::SimpleTable::~SimpleTable ( )
overridedefault

◆ SimpleTable() [1/3]

lsst::afw::table::SimpleTable::SimpleTable ( Schema const &  schema,
std::shared_ptr< IdFactory > const &  idFactory 
)
protected

Definition at line 84 of file Simple.cc.

85  : BaseTable(schema), _idFactory(idFactory) {}
table::Schema schema
Definition: python.h:134
BaseTable(Schema const &schema)
Construct from a schema.
Definition: BaseTable.cc:152

◆ SimpleTable() [2/3]

lsst::afw::table::SimpleTable::SimpleTable ( SimpleTable const &  other)
explicitprotected

Definition at line 87 of file Simple.cc.

88  : BaseTable(other), _idFactory(other._idFactory ? other._idFactory->clone() : other._idFactory) {}

◆ SimpleTable() [3/3]

lsst::afw::table::SimpleTable::SimpleTable ( SimpleTable &&  other)
explicitprotected

Definition at line 90 of file Simple.cc.

90 : SimpleTable(other) {}
SimpleTable(Schema const &schema, std::shared_ptr< IdFactory > const &idFactory)
Definition: Simple.cc:84

Member Function Documentation

◆ _clone()

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

Clone implementation with noncovariant return types.

Reimplemented from lsst::afw::table::BaseTable.

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

Definition at line 108 of file Simple.cc.

108  {
109  return std::shared_ptr<SimpleTable>(new SimpleTable(*this));
110 }

◆ _makeRecord()

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

Default-construct an associated record (protected implementation).

Reimplemented from lsst::afw::table::BaseTable.

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

Definition at line 112 of file Simple.cc.

112  {
113  auto record = constructRecord<SimpleRecord>();
114  if (getIdFactory()) record->setId((*getIdFactory())());
115  return record;
116 }
std::shared_ptr< IdFactory > getIdFactory()
Return the object that generates IDs for the table (may be null).
Definition: Simple.h:155

◆ checkSchema()

static bool lsst::afw::table::SimpleTable::checkSchema ( Schema const &  other)
inlinestatic

Return true if the given schema is a valid SimpleTable schema.

This will always be true if the given schema was originally constructed using makeMinimalSchema(), and will rarely be true otherwise.

Definition at line 152 of file Simple.h.

152 { return other.contains(getMinimalSchema().schema); }

◆ clone()

std::shared_ptr<SimpleTable> lsst::afw::table::SimpleTable::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 176 of file Simple.h.

176 { return std::static_pointer_cast<SimpleTable>(_clone()); }
std::shared_ptr< BaseTable > _clone() const override
Clone implementation with noncovariant return types.
Definition: Simple.cc:108

◆ constructRecord()

template<typename RecordT , typename ... Args>
std::shared_ptr< RecordT > lsst::afw::table::BaseTable::constructRecord ( Args &&...  args)
protectedinherited

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<SimpleRecord> lsst::afw::table::SimpleTable::copyRecord ( BaseRecord const &  other)
inline

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 184 of file Simple.h.

184  {
185  return std::static_pointer_cast<SimpleRecord>(BaseTable::copyRecord(other));
186  }
std::shared_ptr< BaseRecord > copyRecord(BaseRecord const &input)
Deep-copy a record, requiring that it have the same schema as this table.
Definition: BaseTable.cc:128

◆ copyRecord() [2/2]

std::shared_ptr<SimpleRecord> lsst::afw::table::SimpleTable::copyRecord ( BaseRecord const &  other,
SchemaMapper const &  mapper 
)
inline

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 189 of file Simple.h.

189  {
190  return std::static_pointer_cast<SimpleRecord>(BaseTable::copyRecord(other, mapper));
191  }
SchemaMapper * mapper
Definition: SchemaMapper.cc:71

◆ getBufferSize()

std::size_t lsst::afw::table::BaseTable::getBufferSize ( ) const
inherited

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.

112  {
113  if (_manager) {
114  return Block::getBufferSize(_schema.getRecordSize(), _manager);
115  } else {
116  return 0;
117  }
118 }
std::size_t getRecordSize() const
Return the raw size of a record in bytes.
Definition: Schema.h:149

◆ getCoordKey()

static CoordKey lsst::afw::table::SimpleTable::getCoordKey ( )
inlinestatic

Key for the celestial coordinates.

Definition at line 172 of file Simple.h.

172 { return getMinimalSchema().coord; }

◆ getIdFactory() [1/2]

std::shared_ptr<IdFactory> lsst::afw::table::SimpleTable::getIdFactory ( )
inline

Return the object that generates IDs for the table (may be null).

Definition at line 155 of file Simple.h.

155 { return _idFactory; }

◆ getIdFactory() [2/2]

std::shared_ptr<IdFactory const> lsst::afw::table::SimpleTable::getIdFactory ( ) const
inline

Return the object that generates IDs for the table (may be null).

Definition at line 158 of file Simple.h.

158 { return _idFactory; }

◆ getIdKey()

static Key<RecordId> lsst::afw::table::SimpleTable::getIdKey ( )
inlinestatic

Get keys for standard fields shared by all references.

These keys are used to implement getters and setters on SimpleRecord. Key for the unique ID.

Definition at line 170 of file Simple.h.

170 { return getMinimalSchema().id; }

◆ getMetadata()

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

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
inlineinherited

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

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

Definition at line 208 of file BaseTable.h.

208 {}

◆ make() [1/2]

static std::shared_ptr<SimpleTable> lsst::afw::table::SimpleTable::make ( Schema const &  schema)
inlinestatic

Construct a new table.

Parameters
[in]schemaSchema that defines the fields, offsets, and record size for the table.

This overload sets the ID factory to IdFactory::makeSimple().

Definition at line 129 of file Simple.h.

129  {
130  return make(schema, IdFactory::makeSimple());
131  }
static std::shared_ptr< IdFactory > makeSimple()
Return a simple IdFactory that simply counts from 1.
Definition: IdFactory.cc:70
static std::shared_ptr< SimpleTable > make(Schema const &schema, std::shared_ptr< IdFactory > const &idFactory)
Construct a new table.
Definition: Simple.cc:75

◆ make() [2/2]

std::shared_ptr< SimpleTable > lsst::afw::table::SimpleTable::make ( Schema const &  schema,
std::shared_ptr< IdFactory > const &  idFactory 
)
static

Construct a new table.

Parameters
[in]schemaSchema that defines the fields, offsets, and record size for the table.
[in]idFactoryFactory class to generate record IDs when they are not explicitly given. If null, record IDs will default to zero.

Note that not passing an IdFactory at all will call the other override of make(), which will set the ID factory to IdFactory::makeSimple().

Definition at line 75 of file Simple.cc.

76  {
77  if (!checkSchema(schema)) {
79  "Schema for Simple must contain at least the keys defined by makeMinimalSchema().");
80  }
81  return std::shared_ptr<SimpleTable>(new SimpleTable(schema, idFactory));
82 }
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
static bool checkSchema(Schema const &other)
Return true if the given schema is a valid SimpleTable schema.
Definition: Simple.h:152
Reports invalid arguments.
Definition: Runtime.h:66

◆ makeMinimalSchema()

static Schema lsst::afw::table::SimpleTable::makeMinimalSchema ( )
inlinestatic

Return a minimal schema for Simple tables and records.

The returned schema can and generally should be modified further, but many operations on SimpleRecords will assume that at least the fields provided by this routine are present.

Definition at line 140 of file Simple.h.

140  {
141  Schema r = getMinimalSchema().schema;
142  r.disconnectAliases();
143  return r;
144  }

◆ makeRecord()

std::shared_ptr<SimpleRecord> lsst::afw::table::SimpleTable::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 179 of file Simple.h.

179  {
180  return std::static_pointer_cast<SimpleRecord>(_makeRecord());
181  }
std::shared_ptr< BaseRecord > _makeRecord() override
Default-construct an associated record (protected implementation).
Definition: Simple.cc:112

◆ operator=() [1/2]

SimpleTable& lsst::afw::table::SimpleTable::operator= ( SimpleTable &&  )
delete

◆ operator=() [2/2]

SimpleTable& lsst::afw::table::SimpleTable::operator= ( SimpleTable const &  )
delete

◆ popMetadata()

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

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

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

◆ setIdFactory()

void lsst::afw::table::SimpleTable::setIdFactory ( std::shared_ptr< IdFactory f)
inline

Switch to a new IdFactory – object that generates IDs for the table (may be null).

Definition at line 161 of file Simple.h.

161 { _idFactory = f; }

◆ setMetadata()

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

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

◆ io::FitsWriter

friend class io::FitsWriter
friend

Definition at line 220 of file Simple.h.

Member Data Documentation

◆ nRecordsPerBlock

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

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: