lsst::afw::table::BaseRecord Class Reference

Base class for all records. More...

#include <BaseRecord.h>

Inheritance diagram for lsst::afw::table::BaseRecord:

Classes
class	ConstructionToken

Public Types
using	Table = BaseTable
	The associated table class.
using	ColumnView = BaseColumnView
	The associated ColumnView class.
using	Catalog = CatalogT<BaseRecord>
	Template of CatalogT used to hold records of this type.
using	ConstCatalog = CatalogT<const BaseRecord>
	Template of CatalogT used to hold const records of this type.

Public Member Functions
	BaseRecord (ConstructionToken const &, detail::RecordData &&data)
	Construct a record with uninitialized data.
	BaseRecord (const BaseRecord &)=delete
BaseRecord &	operator= (const BaseRecord &)=delete
	BaseRecord (BaseRecord &&)=delete
BaseRecord &	operator= (BaseRecord &&)=delete
Schema	getSchema () const
	Return the Schema that holds this record's fields and keys.
std::shared_ptr< BaseTable const >	getTable () const
	Return the table this record is associated with.
template<typename T>
Field< T >::Element *	getElement (Key< T > const &key)
	Return a pointer to the underlying elements of a field (non-const).
template<typename T>
Field< T >::Element const *	getElement (Key< T > const &key) const
	Return a pointer to the underlying elements of a field (const).
template<typename T>
Field< T >::Reference	operator[] (Key< T > const &key)
	Return a reference (or reference-like type) to the field's value.
template<typename T>
Field< T >::ConstReference	operator[] (Key< T > const &key) const
	Return a const reference (or const-reference-like type) to the field's value.
template<typename T>
Field< T >::Value	get (Key< T > const &key) const
	Return the value of a field for the given key.
template<typename T, typename U>
void	set (Key< T > const &key, U const &value)
	Set value of a field for the given key.
template<typename T>
T	get (OutputFunctorKey< T > const &key) const
	Compute a calculated or aggregate field.
template<typename T, typename U>
void	set (InputFunctorKey< T > const &key, U const &value)
	Set a calculated or aggregate field.
template<typename Ref>
Ref	operator[] (ReferenceFunctorKey< Ref > const &key)
template<typename ConstRef>
ConstRef	operator[] (ConstReferenceFunctorKey< ConstRef > const &key) const
void	assign (BaseRecord const &other)
	Copy all field values from other to this, requiring that they have equal schemas.
void	assign (BaseRecord const &other, SchemaMapper const &mapper)
	Copy field values from other to this, using a mapper.
ndarray::Manager::Ptr	getManager () const
virtual	~BaseRecord ()

Protected Member Functions
virtual void	_assign (BaseRecord const &other)
	Called by assign() after transferring fields to allow subclass data members to be copied.
virtual void	_stream (std::ostream &os) const
	Called by operator<<.

Friends
class	BaseTable
class	BaseColumnView
std::ostream &	operator<< (std::ostream &os, BaseRecord const &record)
	Write the record's content out, one field on each line.

Detailed Description

Base class for all records.

BaseRecord is a polymorphic base class that provides the core record interface: access to fields and links back to the table it is associated with. Field access is provided by the templated get, set, and operator[] member functions. As templates they are nonvirtual and cannot be overridden by subclasses. The implementations for these accessors is in the FieldBase template specializations.

Each subclass of BaseRecord should be paired with a subclass of BaseTable. All record creation goes through a table, as the table allocates the memory used to store a record's fields and holds the Schema instance that defines those fields.

Records are noncopyable, and are hence usually passed by shared_ptr or [const-]reference.

Definition at line 31 of file BaseRecord.h.

Member Typedef Documentation

Catalog

using lsst::afw::table::BaseRecord::Catalog = CatalogT<BaseRecord>

Template of CatalogT used to hold records of this type.

Definition at line 74 of file BaseRecord.h.

ColumnView

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

The associated ColumnView class.

Definition at line 71 of file BaseRecord.h.

ConstCatalog

using lsst::afw::table::BaseRecord::ConstCatalog = CatalogT<const BaseRecord>

Template of CatalogT used to hold const records of this type.

Definition at line 77 of file BaseRecord.h.

Table

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

The associated table class.

Definition at line 68 of file BaseRecord.h.

Constructor & Destructor Documentation

BaseRecord() [1/3]

lsst::afw::table::BaseRecord::BaseRecord	(	ConstructionToken const &	,
		detail::RecordData &&	data )

Construct a record with uninitialized data.

Access to this constructor is restricted to BaseTable and BaseRecord subclasses via the ConstructionToken argument, which can only be constructed by BaseTable. This constructor is public so it can still be called by std::make_shared code with access to ConstructionToken.

Definition at line 143 of file BaseRecord.cc.

                                                                          :
    _data(std::move(data.data)),
    _table(std::move(data.table)),
    _manager(std::move(data.manager))
{
    RecordInitializer f = {reinterpret_cast<char *>(_data)};
    _table->getSchema().forEach(f);
}

BaseRecord() [2/3]

lsst::afw::table::BaseRecord::BaseRecord ( const BaseRecord & )

delete

BaseRecord() [3/3]

lsst::afw::table::BaseRecord::BaseRecord ( BaseRecord && )

delete

~BaseRecord()

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

inlinevirtual

Definition at line 202 of file BaseRecord.h.

{ _table->_destroy(*this); }

Member Function Documentation

_assign()

virtual void lsst::afw::table::BaseRecord::_assign ( BaseRecord const & other )

inlineprotectedvirtual

Called by assign() after transferring fields to allow subclass data members to be copied.

Reimplemented in lsst::afw::table::ExposureRecord, and lsst::afw::table::SourceRecord.

Definition at line 209 of file BaseRecord.h.

{}

_stream()

void lsst::afw::table::BaseRecord::_stream ( std::ostream & os ) const

protectedvirtual

Called by operator<<.

Overrides should call the base class implementation and append additional fields on new lines, with the syntax "%(name)s: %(value)s".

Definition at line 152 of file BaseRecord.cc.

                                             {
    getSchema().forEach([&os, this](auto const& item) {
        os << item.field.getName() << ": " << this->get(item.key) << std::endl;
    });
}

assign() [1/2]

void lsst::afw::table::BaseRecord::assign

(

BaseRecord const &

other

)

Copy all field values from other to this, requiring that they have equal schemas.

Definition at line 122 of file BaseRecord.cc.

                                               {
    if (this->getSchema() != other.getSchema()) {
        throw LSST_EXCEPT(lsst::pex::exceptions::LogicError, "Unequal schemas in record assignment.");
    }
    this->getSchema().forEach(CopyValue(&other, this));
    this->_assign(other);  // let derived classes assign their own stuff
}

assign() [2/2]

void lsst::afw::table::BaseRecord::assign	(	BaseRecord const &	other,
		SchemaMapper const &	mapper )

Copy field values from other to this, using a mapper.

Definition at line 130 of file BaseRecord.cc.

                                                                           {
    if (!other.getSchema().contains(mapper.getInputSchema())) {
        throw LSST_EXCEPT(lsst::pex::exceptions::LogicError,
                          "Unequal schemas between input record and mapper.");
    }
    if (!this->getSchema().contains(mapper.getOutputSchema())) {
        throw LSST_EXCEPT(lsst::pex::exceptions::LogicError,
                          "Unequal schemas between output record and mapper.");
    }
    mapper.forEach(CopyValue(&other, this));  // use the functor we defined above
    this->_assign(other);                     // let derived classes assign their own stuff
}

get() [1/2]

template<typename T>

Field< T >::Value lsst::afw::table::BaseRecord::get ( Key< T > const & key ) const

inline

Return the value of a field for the given key.

No checking is done to ensure the Key belongs to the correct schema.

Definition at line 151 of file BaseRecord.h.

                                                        {
        return key.getValue(getElement(key), _manager);
    }

get() [2/2]

template<typename T>

T lsst::afw::table::BaseRecord::get ( OutputFunctorKey< T > const & key ) const

inline

Compute a calculated or aggregate field.

Definition at line 172 of file BaseRecord.h.

                                                {
        return key.get(*this);
    }

getElement() [1/2]

template<typename T>

Field< T >::Element * lsst::afw::table::BaseRecord::getElement ( Key< T > const & key )

inline

Return a pointer to the underlying elements of a field (non-const).

This low-level access is intended mostly for use with serialization; users should generally prefer the safer get(), set() and operator[] member functions.

Definition at line 93 of file BaseRecord.h.

                                                            {
        if (!key.isValid()) {
            throw LSST_EXCEPT(
                    pex::exceptions::LogicError,
                    "Key is not valid (if this is a SourceRecord, make sure slot aliases have been set up).");
        }
        return reinterpret_cast<typename Field<T>::Element*>(reinterpret_cast<char*>(_data) +
                                                             key.getOffset());
    }

getElement() [2/2]

template<typename T>

Field< T >::Element const * lsst::afw::table::BaseRecord::getElement ( Key< T > const & key ) const

inline

Return a pointer to the underlying elements of a field (const).

This low-level access is intended mostly for use with serialization; users should generally prefer the safer get(), set() and operator[] member functions.

Definition at line 111 of file BaseRecord.h.

                                                                        {
        if (!key.isValid()) {
            throw LSST_EXCEPT(
                    pex::exceptions::LogicError,
                    "Key is not valid (if this is a SourceRecord, make sure slot aliases have been set up).");
        }
        return reinterpret_cast<typename Field<T>::Element const*>(reinterpret_cast<char const*>(_data) +
                                                                   key.getOffset());
    }

getManager()

ndarray::Manager::Ptr lsst::afw::table::BaseRecord::getManager ( ) const

inline

Definition at line 200 of file BaseRecord.h.

{ return _manager; }

getSchema()

Schema lsst::afw::table::BaseRecord::getSchema ( ) const

inline

Return the Schema that holds this record's fields and keys.

Definition at line 80 of file BaseRecord.h.

{ return _table->getSchema(); }

getTable()

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

inline

Return the table this record is associated with.

Definition at line 83 of file BaseRecord.h.

{ return _table; }

operator=() [1/2]

BaseRecord & lsst::afw::table::BaseRecord::operator= ( BaseRecord && )

delete

operator=() [2/2]

BaseRecord & lsst::afw::table::BaseRecord::operator= ( const BaseRecord & )

delete

operator[]() [1/4]

template<typename ConstRef>

ConstRef lsst::afw::table::BaseRecord::operator[] ( ConstReferenceFunctorKey< ConstRef > const & key ) const

inline

Definition at line 190 of file BaseRecord.h.

                                                                             {
        return key.getConstReference(*this);
    }

operator[]() [2/4]

template<typename T>

Field< T >::Reference lsst::afw::table::BaseRecord::operator[] ( Key< T > const & key )

inline

Return a reference (or reference-like type) to the field's value.

Some field types (Point, Moments, Flag, Covariance, and SpherePoint) do not support reference access.

No checking is done to ensure the Key belongs to the correct schema.

Definition at line 129 of file BaseRecord.h.

                                                             {
        return key.getReference(getElement(key), _manager);
    }

operator[]() [3/4]

template<typename T>

Field< T >::ConstReference lsst::afw::table::BaseRecord::operator[] ( Key< T > const & key ) const

inline

Return a const reference (or const-reference-like type) to the field's value.

Some field types (Point, Moments, Flag, Covariance, and SpherePoint) do not support reference access.

No checking is done to ensure the Key belongs to the correct schema.

Definition at line 141 of file BaseRecord.h.

                                                                        {
        return key.getConstReference(getElement(key), _manager);
    }

operator[]() [4/4]

template<typename Ref>

Ref lsst::afw::table::BaseRecord::operator[] ( ReferenceFunctorKey< Ref > const & key )

inline

Definition at line 185 of file BaseRecord.h.

                                                        {
        return key.getReference(*this);
    }

set() [1/2]

template<typename T, typename U>

void lsst::afw::table::BaseRecord::set ( InputFunctorKey< T > const & key, U const & value )

inline

Set a calculated or aggregate field.

Definition at line 180 of file BaseRecord.h.

                                                            {
        return key.set(*this, value);
    }

set() [2/2]

template<typename T, typename U>

void lsst::afw::table::BaseRecord::set ( Key< T > const & key, U const & value )

inline

Set value of a field for the given key.

This method has an additional template parameter because some fields accept and convert different types to the stored field type.

No checking is done to ensure the Key belongs to the correct schema.

Definition at line 164 of file BaseRecord.h.

                                                {
        key.setValue(getElement(key), _manager, value);
    }

Friends And Related Symbol Documentation

BaseColumnView

friend class BaseColumnView

friend

Definition at line 218 of file BaseRecord.h.

BaseTable

friend class BaseTable

friend

Definition at line 217 of file BaseRecord.h.

operator<<

std::ostream & operator<< ( std::ostream & os, BaseRecord const & record )

friend

Write the record's content out, one field on each line.

Definition at line 158 of file BaseRecord.cc.

                                                                 {
    record._stream(os);
    return os;
}

---

The documentation for this class was generated from the following files:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-10.0.0/Linux64/afw/g5a012ec0e7+477f9c599b/include/lsst/afw/table/BaseRecord.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-10.0.0/Linux64/afw/g5a012ec0e7+477f9c599b/src/table/BaseRecord.cc