Field base class specialization for arrays. More...

#include <FieldBase.h>

Public Types
using	Value = ndarray::Array<const U, 1, 1>
	the type returned by BaseRecord::get

using	Reference = ndarray::ArrayRef<U, 1, 1>
	the type returned by BaseRecord::operator[]

using	ConstReference = ndarray::ArrayRef<const U, 1, 1>
	the type returned by BaseRecord::operator[] (const)

using	Element = U
	the type of subfields and array elements

using	Value
	the type returned by BaseRecord::get

using	Reference
	the type returned by BaseRecord::operator[] (non-const)

using	ConstReference
	the type returned by BaseRecord::operator[] (const)

using	Element
	the type of subfields (the same as the type itself for scalars)

Public Member Functions
	FieldBase (size_t size=0)
	Construct a FieldBase with the given size.

	FieldBase (FieldBase const &) noexcept=default

	FieldBase (FieldBase &&) noexcept=default

FieldBase &	operator= (FieldBase const &) noexcept=default

FieldBase &	operator= (FieldBase &&) noexcept=default

	~FieldBase () noexcept=default

std::size_t	getElementCount () const noexcept
	Return the number of subfield elements (equal to the size of the array), or 0 for a variable-length array.

std::size_t	getSize () const noexcept
	Return the size of the array (equal to the number of subfield elements), or 0 for a variable-length array.

bool	isVariableLength () const noexcept
	Return true if the field is variable-length (each record can have a different size array).

std::size_t	getElementCount () const noexcept
	Return the number of subfield elements (always one for scalars).

	FieldBase ()=default

	FieldBase (std::size_t)

	FieldBase (FieldBase const &) noexcept=default

	FieldBase (FieldBase &&) noexcept=default

FieldBase &	operator= (FieldBase const &) noexcept=default

FieldBase &	operator= (FieldBase &&) noexcept=default

	~FieldBase () noexcept=default

Static Public Member Functions
static std::string	getTypeString ()
	Return a string description of the field type.

static std::string	getTypeString ()
	Return a string description of the field type.

Protected Member Functions
void	stream (std::ostream &os) const
	Defines how Fields are printed.

Reference	getReference (Element *p, ndarray::Manager::Ptr const &m) const
	Used to implement BaseRecord::operator[] (non-const).

ConstReference	getConstReference (Element const *p, ndarray::Manager::Ptr const &m) const
	Used to implement BaseRecord::operator[] (const).

Value	getValue (Element const *p, ndarray::Manager::Ptr const &m) const
	Used to implement BaseRecord::get.

void	setValue (Element *p, ndarray::Manager::Ptr const &, ndarray::Array< Element, 1, 1 > const &value) const
	Used to implement BaseRecord::set; accepts only non-const arrays of the right type.

template<typename Derived>
void	setValue (Element *p, ndarray::Manager::Ptr const &, ndarray::ExpressionBase< Derived > const &value) const
	Used to implement BaseRecord::set; accepts any ndarray expression.

void	stream (std::ostream &os) const
	Defines how Fields are printed.

Reference	getReference (Element *p, ndarray::Manager::Ptr const &) const
	Used to implement BaseRecord::operator[] (non-const).

ConstReference	getConstReference (Element const *p, ndarray::Manager::Ptr const &) const
	Used to implement BaseRecord::operator[] (const).

Value	getValue (Element const *p, ndarray::Manager::Ptr const &) const
	Used to implement BaseRecord::get.

void	setValue (Element *p, ndarray::Manager::Ptr const &, Value v) const
	Used to implement BaseRecord::set.

Static Protected Member Functions
static FieldBase	makeDefault () noexcept
	Needed to allow Keys to be default-constructed.

static FieldBase	makeDefault () noexcept
	Needed to allow Keys to be default-constructed.

Detailed Description

template<typename U>
struct lsst::afw::table::FieldBase< Array >

Field base class specialization for arrays.

The Array tag is used for both fixed-length (same size in every record, accessible via ColumnView) and variable-length arrays; variable-length arrays are initialized with a size of 0. Ideally, we'd use complete different tag classes for those two very different types, but this was limited in the original (pre-C++11) implementation and now it would be an API change.

Definition at line 96 of file FieldBase.h.

Member Typedef Documentation

◆ ConstReference [1/2]

using lsst::afw::table::FieldBase< Array >::ConstReference

the type returned by BaseRecord::operator[] (const)

Definition at line 44 of file FieldBase.h.

◆ ConstReference [2/2]

template<typename U>

using lsst::afw::table::FieldBase< Array >::ConstReference = ndarray::ArrayRef<const U, 1, 1>

the type returned by BaseRecord::operator[] (const)

Definition at line 103 of file FieldBase.h.

◆ Element [1/2]

using lsst::afw::table::FieldBase< Array >::Element

the type of subfields (the same as the type itself for scalars)

Definition at line 45 of file FieldBase.h.

◆ Element [2/2]

template<typename U>

using lsst::afw::table::FieldBase< Array >::Element = U

the type of subfields and array elements

Definition at line 105 of file FieldBase.h.

◆ Reference [1/2]

using lsst::afw::table::FieldBase< Array >::Reference

the type returned by BaseRecord::operator[] (non-const)

Definition at line 43 of file FieldBase.h.

◆ Reference [2/2]

template<typename U>

using lsst::afw::table::FieldBase< Array >::Reference = ndarray::ArrayRef<U, 1, 1>

the type returned by BaseRecord::operator[]

Definition at line 100 of file FieldBase.h.

◆ Value [1/2]

using lsst::afw::table::FieldBase< Array >::Value

the type returned by BaseRecord::get

Definition at line 42 of file FieldBase.h.

◆ Value [2/2]

template<typename U>

using lsst::afw::table::FieldBase< Array >::Value = ndarray::Array<const U, 1, 1>

the type returned by BaseRecord::get

Definition at line 97 of file FieldBase.h.

Constructor & Destructor Documentation

◆ FieldBase() [1/7]

template<typename U>

lsst::afw::table::FieldBase< Array >::FieldBase ( size_t size = 0 )

inline

Construct a FieldBase with the given size.

A size == 0 indicates a variable-length array. Negative sizes are not permitted.

This constructor is implicit with a default so it can be used in the Field constructor (as if it were an int argument) without specializing Field. In other words, it allows one to construct a 25-element array field like this:

Field< Array<float> >("name", "documentation", 25);

...even though the third argument to the Field constructor takes a FieldBase, not an int.

Definition at line 120 of file FieldBase.h.

◆ FieldBase() [2/7]

template<typename U>

lsst::afw::table::FieldBase< Array >::FieldBase ( FieldBase< Array > const & )

defaultnoexcept

◆ FieldBase() [3/7]

template<typename U>

lsst::afw::table::FieldBase< Array >::FieldBase ( FieldBase< Array > && )

defaultnoexcept

◆ ~FieldBase() [1/2]

template<typename U>

lsst::afw::table::FieldBase< Array >::~FieldBase ( )

defaultnoexcept

◆ FieldBase() [4/7]

lsst::afw::table::FieldBase< Array >::FieldBase ( )

default

◆ FieldBase() [5/7]

lsst::afw::table::FieldBase< Array >::FieldBase ( std::size_t )

inline

Definition at line 57 of file FieldBase.h.

◆ FieldBase() [6/7]

lsst::afw::table::FieldBase< Array >::FieldBase ( FieldBase< Array > const & )

defaultnoexcept

◆ FieldBase() [7/7]

lsst::afw::table::FieldBase< Array >::FieldBase ( FieldBase< Array > && )

defaultnoexcept

◆ ~FieldBase() [2/2]

lsst::afw::table::FieldBase< Array >::~FieldBase ( )

defaultnoexcept

Member Function Documentation

◆ getConstReference() [1/2]

ConstReference lsst::afw::table::FieldBase< Array< U > >::getConstReference	(	Element const *	p,
		ndarray::Manager::Ptr const &	) const

inlineprotected

Used to implement BaseRecord::operator[] (const).

Definition at line 78 of file FieldBase.h.

◆ getConstReference() [2/2]

template<typename U>

ConstReference lsst::afw::table::FieldBase< Array< U > >::getConstReference	(	Element const *	p,
		ndarray::Manager::Ptr const &	m ) const

inlineprotected

Used to implement BaseRecord::operator[] (const).

Definition at line 159 of file FieldBase.h.

◆ getElementCount() [1/2]

std::size_t lsst::afw::table::FieldBase< Array >::getElementCount ( ) const

inlinenoexcept

Return the number of subfield elements (always one for scalars).

Definition at line 48 of file FieldBase.h.

◆ getElementCount() [2/2]

template<typename U>

std::size_t lsst::afw::table::FieldBase< Array >::getElementCount ( ) const

inlinenoexcept

Return the number of subfield elements (equal to the size of the array), or 0 for a variable-length array.

Definition at line 134 of file FieldBase.h.

◆ getReference() [1/2]

Reference lsst::afw::table::FieldBase< Array< U > >::getReference	(	Element *	p,
		ndarray::Manager::Ptr const &	) const

inlineprotected

Used to implement BaseRecord::operator[] (non-const).

Definition at line 75 of file FieldBase.h.

◆ getReference() [2/2]

template<typename U>

Reference lsst::afw::table::FieldBase< Array< U > >::getReference	(	Element *	p,
		ndarray::Manager::Ptr const &	m ) const

inlineprotected

Used to implement BaseRecord::operator[] (non-const).

Definition at line 151 of file FieldBase.h.

◆ getSize()

template<typename U>

std::size_t lsst::afw::table::FieldBase< Array >::getSize ( ) const

inlinenoexcept

Return the size of the array (equal to the number of subfield elements), or 0 for a variable-length array.

Definition at line 138 of file FieldBase.h.

◆ getTypeString() [1/2]

std::string lsst::afw::table::FieldBase< Array >::getTypeString ( )

static

Return a string description of the field type.

Definition at line 51 of file FieldBase.cc.

◆ getTypeString() [2/2]

template<typename U>

std::string lsst::afw::table::FieldBase< Array >::getTypeString ( )

static

Return a string description of the field type.

Definition at line 63 of file FieldBase.cc.

◆ getValue() [1/2]

Value lsst::afw::table::FieldBase< Array< U > >::getValue	(	Element const *	p,
		ndarray::Manager::Ptr const &	) const

inlineprotected

Used to implement BaseRecord::get.

Definition at line 81 of file FieldBase.h.

◆ getValue() [2/2]

template<typename U>

Value lsst::afw::table::FieldBase< Array< U > >::getValue	(	Element const *	p,
		ndarray::Manager::Ptr const &	m ) const

inlineprotected

Used to implement BaseRecord::get.

Definition at line 167 of file FieldBase.h.

◆ isVariableLength()

template<typename U>

bool lsst::afw::table::FieldBase< Array >::isVariableLength ( ) const

inlinenoexcept

Return true if the field is variable-length (each record can have a different size array).

Definition at line 141 of file FieldBase.h.

◆ makeDefault() [1/2]

static FieldBase lsst::afw::table::FieldBase< Array >::makeDefault ( )

inlinestaticprotectednoexcept

Needed to allow Keys to be default-constructed.

Definition at line 69 of file FieldBase.h.

◆ makeDefault() [2/2]

template<typename U>

static FieldBase lsst::afw::table::FieldBase< Array >::makeDefault ( )

inlinestaticprotectednoexcept

Needed to allow Keys to be default-constructed.

Definition at line 145 of file FieldBase.h.

◆ operator=() [1/4]

FieldBase & lsst::afw::table::FieldBase< Array >::operator= ( FieldBase< Array > && )

defaultnoexcept

◆ operator=() [2/4]

template<typename U>

FieldBase & lsst::afw::table::FieldBase< Array >::operator= ( FieldBase< Array > && )

defaultnoexcept

◆ operator=() [3/4]

FieldBase & lsst::afw::table::FieldBase< Array >::operator= ( FieldBase< Array > const & )

defaultnoexcept

◆ operator=() [4/4]

template<typename U>

FieldBase & lsst::afw::table::FieldBase< Array >::operator= ( FieldBase< Array > const & )

defaultnoexcept

◆ setValue() [1/3]

template<typename U>

void lsst::afw::table::FieldBase< Array< U > >::setValue	(	Element *	p,
		ndarray::Manager::Ptr const &	,
		ndarray::Array< Element, 1, 1 > const &	value ) const

inlineprotected

Used to implement BaseRecord::set; accepts only non-const arrays of the right type.

Fixed-length arrays are handled by copying the data from value to p through p + _size. Variable-length arrays are handled by setting p to the address of value, an ndarray, hence a shallow copy (ndarray arrays are reference-counted so this will not leak memory). If you want deep assignment of variable-length data, use operator[] to get a reference and assign to that.

Definition at line 180 of file FieldBase.h.

◆ setValue() [2/3]

template<typename U>

template<typename Derived>

void lsst::afw::table::FieldBase< Array< U > >::setValue	(	Element *	p,
		ndarray::Manager::Ptr const &	,
		ndarray::ExpressionBase< Derived > const &	value ) const

inlineprotected

Used to implement BaseRecord::set; accepts any ndarray expression.

Definition at line 191 of file FieldBase.h.

◆ setValue() [3/3]

void lsst::afw::table::FieldBase< Array< U > >::setValue	(	Element *	p,
		ndarray::Manager::Ptr const &	,
		Value	v ) const

inlineprotected

Used to implement BaseRecord::set.

Definition at line 84 of file FieldBase.h.

◆ stream() [1/2]

void lsst::afw::table::FieldBase< Array >::stream ( std::ostream & os ) const

inlineprotected

Defines how Fields are printed.

Definition at line 72 of file FieldBase.h.

◆ stream() [2/2]

template<typename U>

void lsst::afw::table::FieldBase< Array >::stream ( std::ostream & os ) const

inlineprotected

Defines how Fields are printed.

Definition at line 148 of file FieldBase.h.

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

include/lsst/afw/table/FieldBase.h
src/table/FieldBase.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ ConstReference [1/2]

◆ ConstReference [2/2]

◆ Element [1/2]

◆ Element [2/2]

◆ Reference [1/2]

◆ Reference [2/2]

◆ Value [1/2]

◆ Value [2/2]

Constructor & Destructor Documentation

◆ FieldBase() [1/7]

◆ FieldBase() [2/7]

◆ FieldBase() [3/7]

◆ ~FieldBase() [1/2]

◆ FieldBase() [4/7]

◆ FieldBase() [5/7]

◆ FieldBase() [6/7]

◆ FieldBase() [7/7]

◆ ~FieldBase() [2/2]

Member Function Documentation

◆ getConstReference() [1/2]

◆ getConstReference() [2/2]

◆ getElementCount() [1/2]

◆ getElementCount() [2/2]

◆ getReference() [1/2]

◆ getReference() [2/2]

◆ getSize()

◆ getTypeString() [1/2]

◆ getTypeString() [2/2]

◆ getValue() [1/2]

◆ getValue() [2/2]

◆ isVariableLength()

◆ makeDefault() [1/2]

◆ makeDefault() [2/2]

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

◆ setValue() [1/3]

◆ setValue() [2/3]

◆ setValue() [3/3]

◆ stream() [1/2]

◆ stream() [2/2]