lsst.afw
21.0.0-35-g4939cbb3d+fb0e51fe34
|
A FunctorKey used to get or set a lsst::geom::Point from an (x,y) pair of int or double Keys. More...
#include <aggregates.h>
Public Types | |
using | Value = lsst::geom::Point< T, 2 > |
The data type for get and set. More... | |
Public Member Functions | |
PointKey () noexcept | |
Default constructor; instance will not be usable unless subsequently assigned to. More... | |
PointKey (Key< T > const &x, Key< T > const &y) noexcept | |
Construct from a pair of Keys. More... | |
PointKey (PointKey const &) noexcept=default | |
PointKey (PointKey &&) noexcept=default | |
PointKey & | operator= (PointKey const &) noexcept=default |
PointKey & | operator= (PointKey &&) noexcept=default |
~PointKey () noexcept override=default | |
PointKey (SubSchema const &s) | |
Construct from a subschema, assuming x and y subfields. More... | |
lsst::geom::Point< T, 2 > | get (BaseRecord const &record) const override |
Get a Point from the given record. More... | |
void | set (BaseRecord &record, lsst::geom::Point< T, 2 > const &value) const override |
Set a Point in the given record. More... | |
bool | operator== (PointKey< T > const &other) const noexcept |
Compare the FunctorKey for equality with another, using the underlying x and y Keys. More... | |
bool | operator!= (PointKey< T > const &other) const noexcept |
std::size_t | hash_value () const noexcept |
Return a hash of this object. More... | |
bool | isValid () const noexcept |
Return True if both the x and y Keys are valid. More... | |
Key< T > | getX () const noexcept |
Return the underlying x Key. More... | |
Key< T > | getY () const noexcept |
Return the underlying y Key. More... | |
virtual void | set (BaseRecord &record, T const &value) const =0 |
Static Public Member Functions | |
static PointKey | addFields (Schema &schema, std::string const &name, std::string const &doc, std::string const &unit) |
Add a pair of _x, _y fields to a Schema, and return a PointKey that points to them. More... | |
A FunctorKey used to get or set a lsst::geom::Point from an (x,y) pair of int or double Keys.
Definition at line 49 of file aggregates.h.
|
inherited |
The data type for get and set.
Definition at line 77 of file FunctorKey.h.
|
inlinenoexcept |
Default constructor; instance will not be usable unless subsequently assigned to.
Definition at line 64 of file aggregates.h.
|
inlinenoexcept |
Construct from a pair of Keys.
Definition at line 67 of file aggregates.h.
|
defaultnoexcept |
|
defaultnoexcept |
|
overridedefaultnoexcept |
|
inline |
Construct from a subschema, assuming x and y subfields.
If a schema has "a_x" and "a_y" fields, this constructor allows you to construct a PointKey via:
PointKey<T> k(schema["a"]);
Definition at line 83 of file aggregates.h.
|
static |
Add a pair of _x, _y fields to a Schema, and return a PointKey that points to them.
[in,out] | schema | Schema to add fields to. |
[in] | name | Name prefix for all fields; "_x", "_y", will be appended to this to form the full field names. |
[in] | doc | String used as the documentation for the fields. |
[in] | unit | String used as the unit for all fields. |
Definition at line 36 of file aggregates.cc.
|
overridevirtual |
Get a Point from the given record.
Implements lsst::afw::table::OutputFunctorKey< T >.
Definition at line 44 of file aggregates.cc.
|
inlinenoexcept |
Return the underlying x Key.
Definition at line 107 of file aggregates.h.
|
inlinenoexcept |
Return the underlying y Key.
Definition at line 110 of file aggregates.h.
|
inlinenoexcept |
Return a hash of this object.
Definition at line 98 of file aggregates.h.
|
inlinenoexcept |
Return True if both the x and y Keys are valid.
Definition at line 104 of file aggregates.h.
|
inlinenoexcept |
Definition at line 94 of file aggregates.h.
|
defaultnoexcept |
|
defaultnoexcept |
|
inlinenoexcept |
Compare the FunctorKey for equality with another, using the underlying x and y Keys.
Definition at line 93 of file aggregates.h.
|
override |
Set a Point in the given record.
Definition at line 49 of file aggregates.cc.
|
pure virtualinherited |