lsst::afw::table::PointKey< T > Class Template Reference

A FunctorKey used to get or set a geom::Point from an (x,y) pair of int or double Keys. More...

#include <aggregates.h>

Inheritance diagram for lsst::afw::table::PointKey< T >:

Public Member Functions
	PointKey ()
	Default constructor; instance will not be usable unless subsequently assigned to. More...
	PointKey (Key< T > const &x, Key< T > const &y)
	Construct from a pair of Keys. More...
	PointKey (SubSchema const &s)
	Construct from a subschema, assuming x and y subfields. More...
virtual geom::Point< T, 2 >	get (BaseRecord const &record) const
	Get a Point from the given record. More...
virtual void	set (BaseRecord &record, geom::Point< T, 2 > const &value) const
	Set a Point in the given record. More...
bool	isValid () const
	Return True if both the x and y Keys are valid. More...
Key< T >	getX () const
	Return the underlying x Key. More...
Key< T >	getY () const
	Return the underlying y Key. More...
bool	operator== (PointKey< T > const &other) const
	Compare the FunctorKey for equality with another, using the underlying x and y Keys. More...
bool	operator!= (PointKey< T > const &other) const
	Compare the FunctorKey for equality with another, using the underlying x and y Keys. More...
Public Member Functions inherited from lsst::afw::table::OutputFunctorKey< lsst::afw::geom::Point< T, 2 > >
virtual	~OutputFunctorKey ()
Public Member Functions inherited from lsst::afw::table::InputFunctorKey< lsst::afw::geom::Point< T, 2 > >
virtual	~InputFunctorKey ()

Static Public Member Functions
static PointKey	addFields (Schema &schema, std::string const &name, std::string const &doc, std::string const &unit)

Private Attributes
Key< T >	_x
Key< T >	_y

Detailed Description

template<typename T>
class lsst::afw::table::PointKey< T >

A FunctorKey used to get or set a geom::Point from an (x,y) pair of int or double Keys.

Definition at line 48 of file aggregates.h.

Constructor & Destructor Documentation

template<typename T>

lsst::afw::table::PointKey< T >::PointKey ( )

inline

Default constructor; instance will not be usable unless subsequently assigned to.

Definition at line 68 of file aggregates.h.

: _x(), _y() {}

template<typename T>

lsst::afw::table::PointKey< T >::PointKey ( Key< T > const &  x, Key< T > const &  y  )

inline

Construct from a pair of Keys.

Definition at line 71 of file aggregates.h.

: _x(x), _y(y) {}

template<typename T>

lsst::afw::table::PointKey< T >::PointKey ( SubSchema const &  s )

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 82 of file aggregates.h.

: _x(s["x"]), _y(s["y"]) {}

Member Function Documentation

template<typename T>

static PointKey lsst::afw::table::PointKey< T >::addFields ( Schema &  schema, std::string const &  name, std::string const &  doc, std::string const &  unit  )

static

Add a pair of _x, _y fields to a Schema, and return a PointKey that points to them.

Parameters

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

template<typename T>

virtual geom::Point<T,2> lsst::afw::table::PointKey< T >::get ( BaseRecord const &  record ) const

virtual

Get a Point from the given record.

Implements lsst::afw::table::OutputFunctorKey< lsst::afw::geom::Point< T, 2 > >.

template<typename T>

Key<T> lsst::afw::table::PointKey< T >::getX ( ) const

inline

Return the underlying x Key.

Definition at line 100 of file aggregates.h.

{ return _x; }

template<typename T>

Key<T> lsst::afw::table::PointKey< T >::getY ( ) const

inline

Return the underlying y Key.

Definition at line 103 of file aggregates.h.

{ return _y; }

template<typename T>

bool lsst::afw::table::PointKey< T >::isValid ( ) const

inline

Return True if both the x and y Keys are valid.

Definition at line 97 of file aggregates.h.

{ return _x.isValid() && _y.isValid(); }

template<typename T>

bool lsst::afw::table::PointKey< T >::operator!= ( PointKey< T > const &  other ) const

inline

Compare the FunctorKey for equality with another, using the underlying x and y Keys.

Definition at line 93 of file aggregates.h.

{ return !(*this == other); }

template<typename T>

bool lsst::afw::table::PointKey< T >::operator== ( PointKey< T > const &  other ) const

inline

Compare the FunctorKey for equality with another, using the underlying x and y Keys.

Definition at line 92 of file aggregates.h.

{ return _x == other._x && _y == other._y; }

template<typename T>

virtual void lsst::afw::table::PointKey< T >::set ( BaseRecord &  record, geom::Point< T, 2 > const &  value  ) const

virtual

Set a Point in the given record.

Implements lsst::afw::table::InputFunctorKey< lsst::afw::geom::Point< T, 2 > >.

Member Data Documentation

template<typename T>

Key<T> lsst::afw::table::PointKey< T >::_x

private

Definition at line 106 of file aggregates.h.

template<typename T>

Key<T> lsst::afw::table::PointKey< T >::_y

private

Definition at line 107 of file aggregates.h.

---

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

• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/table/aggregates.h