lsst::afw::table::Field< T > Struct Template Reference

A description of a field in a table. More...

#include <Field.h>

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

Public Types
using	Element = typename FieldBase<T>::Element
	Type used to store field data in the table (a field may have multiple elements).
using	Value = T
	the type returned by BaseRecord::get
using	Reference = T &
	the type returned by BaseRecord::operator[] (non-const)
using	ConstReference = const T &
	the type returned by BaseRecord::operator[] (const)

Public Member Functions
	Field (std::string const &name, std::string const &doc, std::string const &units="", FieldBase< T > const &size=FieldBase< T >())
	Construct a new field.
	Field (std::string const &name, std::string const &doc, FieldBase< T > const &size)
	Construct a new field.
	Field (Field const &)=default
	Field (Field &&) noexcept=default
Field &	operator= (Field const &)=default
Field &	operator= (Field &&) noexcept=default
	~Field () noexcept=default
std::string const &	getName () const noexcept
	Return the name of the field.
std::string const &	getDoc () const noexcept
	Return the documentation for the field.
std::string const &	getUnits () const noexcept
	Return the units for the field.
Field< T >	copyRenamed (std::string const &newName) const
	Return a new Field with a new name and other properties the same as this.
std::size_t	getElementCount () const noexcept
	Return the number of subfield elements (always one for scalars).

Static Public Member Functions
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 &) 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.

Friends
std::ostream &	operator<< (std::ostream &os, Field< T > const &field)
	Stringification.

Detailed Description

template<typename T>
struct lsst::afw::table::Field< T >

A description of a field in a table.

Field combines a type with the field name, documentation, units, and in some cases, the size of the field.

Specializations for different field types are inherited through FieldBase; see the documentation for those specializations for additional information about particular field types.

Definition at line 24 of file Field.h.

Member Typedef Documentation

ConstReference

template<typename T>

using lsst::afw::table::FieldBase< T >::ConstReference = const T &

inherited

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

Definition at line 44 of file FieldBase.h.

Element

template<typename T>

using lsst::afw::table::Field< T >::Element = typename FieldBase<T>::Element

Type used to store field data in the table (a field may have multiple elements).

Definition at line 26 of file Field.h.

Reference

template<typename T>

using lsst::afw::table::FieldBase< T >::Reference = T &

inherited

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

Definition at line 43 of file FieldBase.h.

Value

template<typename T>

using lsst::afw::table::FieldBase< T >::Value = T

inherited

the type returned by BaseRecord::get

Definition at line 42 of file FieldBase.h.

Constructor & Destructor Documentation

Field() [1/4]

template<typename T>

lsst::afw::table::Field< T >::Field ( std::string const & name, std::string const & doc, std::string const & units = "", FieldBase< T > const & size = FieldBase<T>() )

inline

Construct a new field.

Parameters

[in]	name	Name of the field. Schemas provide extra functionality for names whose components are separated by underscores. Field names should be limited to letters, numbers, and underscores.
[in]	doc	Documentation for the field. Should not contain single-quotes to avoid FITS round-trip problems.
[in]	units	Units for the field. Should not contain single-quotes to avoid FITS round-trip problems.
[in]	size	Size of the field as an integer, if appropriate. Field types that accept a size have a FieldBase that is implicitly constructable from an integer, so the argument type should be considered to effectively be int; using FieldBase here allows use to throw when the signature does not match the field type.

Definition at line 44 of file Field.h.

            : FieldBase<T>(size), _name(name), _doc(doc), _units(units) {}

Field() [2/4]

template<typename T>

lsst::afw::table::Field< T >::Field ( std::string const & name, std::string const & doc, FieldBase< T > const & size )

inline

Construct a new field.

Parameters

[in]	name	Name of the field. Schemas provide extra functionality for names whose components are separated by underscores. Field names should be limited to letters, numbers, and underscores.
[in]	doc	Documentation for the field.
[in]	size	Size of the field as an integer, if appropriate. Field types that accept a size have a FieldBase that is implicitly constructable from an integer, so the argument type should be considered to effectively be int; using FieldBase here allows use to throw when the signature does not match the field type.

Definition at line 61 of file Field.h.

            : FieldBase<T>(size), _name(name), _doc(doc), _units() {}

Field() [3/4]

template<typename T>

lsst::afw::table::Field< T >::Field ( Field< T > const & )

default

Field() [4/4]

template<typename T>

lsst::afw::table::Field< T >::Field ( Field< T > && )

defaultnoexcept

~Field()

template<typename T>

lsst::meas::extensions::psfex::Field::~Field ( )

defaultnoexcept

Definition at line 50 of file fieldImpl.cc.

{
    for (int i = 0; i != impl->next; ++i) {
        free(impl->wcs[i]);             // psfex's wcs isn't quite the same as ours ...
        impl->wcs[i] = NULL;            // ... so don't let psfex free it
    }
    field_end(impl);
    impl = NULL;
}

Member Function Documentation

copyRenamed()

template<typename T>

Field< T > lsst::afw::table::Field< T >::copyRenamed ( std::string const & newName ) const

inline

Return a new Field with a new name and other properties the same as this.

Definition at line 89 of file Field.h.

                                                         {
        return Field<T>(newName, getDoc(), getUnits(), *this);
    }

getConstReference()

template<typename T>

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

inlineprotectedinherited

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

Definition at line 78 of file FieldBase.h.

{ return *p; }

getDoc()

template<typename T>

std::string const & lsst::afw::table::Field< T >::getDoc ( ) const

inlinenoexcept

Return the documentation for the field.

Definition at line 74 of file Field.h.

{ return _doc; }

getElementCount()

template<typename T>

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

inlinenoexceptinherited

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

Definition at line 48 of file FieldBase.h.

{ return 1; }

getName()

template<typename T>

std::string const & lsst::afw::table::Field< T >::getName ( ) const

inlinenoexcept

Return the name of the field.

Definition at line 71 of file Field.h.

{ return _name; }

getReference()

template<typename T>

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

inlineprotectedinherited

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

Definition at line 75 of file FieldBase.h.

{ return *p; }

getTypeString()

template<typename T>

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

staticinherited

Return a string description of the field type.

Definition at line 56 of file FieldBase.cc.

                                      {
    return TypeTraits<T>::getName();
}

getUnits()

template<typename T>

std::string const & lsst::afw::table::Field< T >::getUnits ( ) const

inlinenoexcept

Return the units for the field.

Definition at line 77 of file Field.h.

{ return _units; }

getValue()

template<typename T>

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

inlineprotectedinherited

Used to implement BaseRecord::get.

Definition at line 81 of file FieldBase.h.

{ return *p; }

makeDefault()

template<typename T>

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

inlinestaticprotectednoexceptinherited

Needed to allow Keys to be default-constructed.

Definition at line 69 of file FieldBase.h.

{ return FieldBase(); }

operator=() [1/2]

template<typename T>

Field & lsst::afw::table::Field< T >::operator= ( Field< T > && )

defaultnoexcept

operator=() [2/2]

template<typename T>

Field & lsst::afw::table::Field< T >::operator= ( Field< T > const & )

default

setValue()

template<typename T>

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

inlineprotectedinherited

Used to implement BaseRecord::set.

Definition at line 84 of file FieldBase.h.

{ *p = v; }

stream()

template<typename T>

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

inlineprotectedinherited

Defines how Fields are printed.

Definition at line 72 of file FieldBase.h.

{}

Friends And Related Symbol Documentation

operator<<

template<typename T>

std::ostream & operator<< ( std::ostream & os, Field< T > const & field )

friend

Stringification.

Definition at line 80 of file Field.h.

                                                                                {
        os << "Field['" << Field<T>::getTypeString() << "'](name=\"" << field.getName() << "\"";
        if (!field.getDoc().empty()) os << ", doc=\"" << field.getDoc() << "\"";
        if (!field.getUnits().empty()) os << ", units=\"" << field.getUnits() << "\"";
        field.stream(os);
        return os << ")";
    }

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-11.0.0/Linux/afw/g4cdb532a89+a047e97985/include/lsst/afw/table/Field.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-11.0.0/Linux/meas_extensions_psfex/g3fd5ace14f+19c3a54948/src/fieldImpl.cc