lsst::afw::table::SimpleRecord Class Reference

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

#include <Simple.h>

Inheritance diagram for lsst::afw::table::SimpleRecord:

Public Types
typedef SimpleTable	Table
typedef ColumnViewT< SimpleRecord >	ColumnView
typedef SortedCatalogT< SimpleRecord >	Catalog
typedef SortedCatalogT< SimpleRecord const >	ConstCatalog

Public Member Functions
	SimpleRecord (ConstructionToken const &token, detail::RecordData &&data)
	Constructor used by SimpleTable. More...
std::shared_ptr< SimpleTable const >	getTable () const
	SimpleRecord (const SimpleRecord &)=delete
SimpleRecord &	operator= (const SimpleRecord &)=delete
	SimpleRecord (SimpleRecord &&)=delete
SimpleRecord &	operator= (SimpleRecord &&)=delete
	~SimpleRecord () override
Schema	getSchema () const
	Return the Schema that holds this record's fields and keys. More...
template<typename T >
Field< T >::Element *	getElement (Key< T > const &key)
	Return a pointer to the underlying elements of a field (non-const). More...
template<typename T >
Field< T >::Element const *	getElement (Key< T > const &key) const
	Return a pointer to the underlying elements of a field (const). More...
template<typename T >
Field< T >::Reference	operator[] (Key< T > const &key)
	Return a reference (or reference-like type) to the field's value. More...
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. More...
template<typename Ref >
Ref	operator[] (ReferenceFunctorKey< Ref > const &key)
template<typename ConstRef >
ConstRef	operator[] (ConstReferenceFunctorKey< ConstRef > const &key) const
template<typename T >
Field< T >::Value	get (Key< T > const &key) const
	Return the value of a field for the given key. More...
template<typename T >
T	get (OutputFunctorKey< T > const &key) const
	Compute a calculated or aggregate field. More...
template<typename T , typename U >
void	set (Key< T > const &key, U const &value)
	Set value of a field for the given key. More...
template<typename T , typename U >
void	set (InputFunctorKey< T > const &key, U const &value)
	Set a calculated or aggregate field. More...
void	assign (BaseRecord const &other)
	Copy all field values from other to this, requiring that they have equal schemas. More...
void	assign (BaseRecord const &other, SchemaMapper const &mapper)
	Copy field values from other to this, using a mapper. More...
ndarray::Manager::Ptr	getManager () const
RecordId	getId () const
	Convenience accessors for the keys in the minimal reference schema. More...
void	setId (RecordId id)
	Convenience accessors for the keys in the minimal reference schema. More...
lsst::geom::SpherePoint	getCoord () const
	Convenience accessors for the keys in the minimal reference schema. More...
void	setCoord (lsst::geom::SpherePoint const &coord)
	Convenience accessors for the keys in the minimal reference schema. More...
lsst::geom::Angle	getRa () const
	Convenience accessors for the keys in the minimal reference schema. More...
void	setRa (lsst::geom::Angle ra)
	Convenience accessors for the keys in the minimal reference schema. More...
lsst::geom::Angle	getDec () const
	Convenience accessors for the keys in the minimal reference schema. More...
void	setDec (lsst::geom::Angle dec)
	Convenience accessors for the keys in the minimal reference schema. More...

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

Friends
class	SimpleTable

Detailed Description

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

Member Typedef Documentation

Catalog

typedef SortedCatalogT<SimpleRecord> lsst::afw::table::SimpleRecord::Catalog

Definition at line 52 of file Simple.h.

ColumnView

typedef ColumnViewT<SimpleRecord> lsst::afw::table::SimpleRecord::ColumnView

Definition at line 51 of file Simple.h.

ConstCatalog

typedef SortedCatalogT<SimpleRecord const> lsst::afw::table::SimpleRecord::ConstCatalog

Definition at line 53 of file Simple.h.

Table

typedef SimpleTable lsst::afw::table::SimpleRecord::Table

Definition at line 50 of file Simple.h.

Constructor & Destructor Documentation

SimpleRecord() [1/3]

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

inline

Constructor used by SimpleTable.

While formally public, this constructor is conceptually and effectively protected, due to the (protected) ConstructionToken argument.

This is to allow make_shared to be used, as that cannot be used on a truly protected or private constructor.

Definition at line 64 of file Simple.h.

                                                                            :
        BaseRecord(token, std::move(data))
    {}

SimpleRecord() [2/3]

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

delete

SimpleRecord() [3/3]

lsst::afw::table::SimpleRecord::SimpleRecord ( SimpleRecord &&  )

delete

~SimpleRecord()

lsst::afw::table::SimpleRecord::~SimpleRecord ( )

overridedefault

Member Function Documentation

_assign()

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

inlineprotectedvirtualinherited

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

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

Definition at line 209 of file BaseRecord.h.

{}

_stream()

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

protectedvirtualinherited

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

inherited

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

Definition at line 123 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  )

inherited

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

Definition at line 131 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

inlineinherited

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

inlineinherited

Compute a calculated or aggregate field.

Definition at line 172 of file BaseRecord.h.

                                                {
        return key.get(*this);
    }

getCoord()

lsst::geom::SpherePoint lsst::afw::table::SimpleRecord::getCoord ( ) const

inline

Convenience accessors for the keys in the minimal reference schema.

Definition at line 231 of file Simple.h.

{ return get(SimpleTable::getCoordKey()); }

getDec()

lsst::geom::Angle lsst::afw::table::SimpleRecord::getDec ( ) const

inline

Convenience accessors for the keys in the minimal reference schema.

Definition at line 239 of file Simple.h.

{ return get(SimpleTable::getCoordKey().getDec()); }

getElement() [1/2]

template<typename T >

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

inlineinherited

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

inlineinherited

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

getId()

RecordId lsst::afw::table::SimpleRecord::getId ( ) const

inline

Convenience accessors for the keys in the minimal reference schema.

Definition at line 228 of file Simple.h.

{ return get(SimpleTable::getIdKey()); }

getManager()

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

inlineinherited

Definition at line 200 of file BaseRecord.h.

{ return _manager; }

getRa()

lsst::geom::Angle lsst::afw::table::SimpleRecord::getRa ( ) const

inline

Convenience accessors for the keys in the minimal reference schema.

Definition at line 236 of file Simple.h.

{ return get(SimpleTable::getCoordKey().getRa()); }

getSchema()

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

inlineinherited

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<SimpleTable const> lsst::afw::table::SimpleRecord::getTable ( ) const

inline

Definition at line 68 of file Simple.h.

                                                      {
        return std::static_pointer_cast<SimpleTable const>(BaseRecord::getTable());
    }

operator=() [1/2]

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

delete

operator=() [2/2]

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

delete

operator[]() [1/4]

template<typename T >

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

inlineinherited

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[]() [2/4]

template<typename T >

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

inlineinherited

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[]() [3/4]

template<typename Ref >

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

inlineinherited

Definition at line 185 of file BaseRecord.h.

                                                        {
        return key.getReference(*this);
    }

operator[]() [4/4]

template<typename ConstRef >

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

inlineinherited

Definition at line 190 of file BaseRecord.h.

                                                                             {
        return key.getConstReference(*this);
    }

set() [1/2]

template<typename T , typename U >

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

inlineinherited

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

set() [2/2]

template<typename T , typename U >

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

inlineinherited

Set a calculated or aggregate field.

Definition at line 180 of file BaseRecord.h.

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

setCoord()

void lsst::afw::table::SimpleRecord::setCoord ( lsst::geom::SpherePoint const &  coord )

inline

Convenience accessors for the keys in the minimal reference schema.

Definition at line 232 of file Simple.h.

                                                                   {
    set(SimpleTable::getCoordKey(), coord);
}

setDec()

void lsst::afw::table::SimpleRecord::setDec ( lsst::geom::Angle  dec )

inline

Convenience accessors for the keys in the minimal reference schema.

Definition at line 240 of file Simple.h.

{ set(SimpleTable::getCoordKey().getDec(), dec); }

setId()

void lsst::afw::table::SimpleRecord::setId ( RecordId  id )

inline

Convenience accessors for the keys in the minimal reference schema.

Definition at line 229 of file Simple.h.

{ set(SimpleTable::getIdKey(), id); }

setRa()

void lsst::afw::table::SimpleRecord::setRa ( lsst::geom::Angle  ra )

inline

Convenience accessors for the keys in the minimal reference schema.

Definition at line 237 of file Simple.h.

{ set(SimpleTable::getCoordKey().getRa(), ra); }

Friends And Related Function Documentation

SimpleTable

friend class SimpleTable

friend

Definition at line 94 of file Simple.h.

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/afw/19.0.0-4-ga671dab3b+1/include/lsst/afw/table/Simple.h
• /j/snowflake/release/lsstsw/stack/Linux64/afw/19.0.0-4-ga671dab3b+1/src/table/Simple.cc