lsst.afw.table::FieldBase< T > Struct Template Reference

Field base class default implementation (used for numeric scalars and Angle). More...

#include <FieldBase.h>

Inheritance diagram for lsst.afw.table::FieldBase< T >:

Public Types
typedef T	Value
	the type returned by BaseRecord::get More...
typedef T &	Reference
	the type returned by BaseRecord::operator[] (non-const) More...
typedef T const &	ConstReference
	the type returned by BaseRecord::operator[] (const) More...
typedef T	Element
	the type of subfields (the same as the type itself for scalars) More...

Public Member Functions
int	getElementCount () const
	Return the number of subfield elements (always one for scalars). More...
	FieldBase ()
	FieldBase (int)

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

Protected Member Functions
void	stream (std::ostream &os) const
	Defines how Fields are printed. More...
Reference	getReference (Element *p, ndarray::Manager::Ptr const &) const
	Used to implement RecordBase::operator[] (non-const). More...
ConstReference	getConstReference (Element const *p, ndarray::Manager::Ptr const &) const
	Used to implement RecordBase::operator[] (const). More...
Value	getValue (Element const *p, ndarray::Manager::Ptr const &) const
	Used to implement RecordBase::get. More...
void	setValue (Element *p, ndarray::Manager::Ptr const &, Value v) const
	Used to implement RecordBase::set. More...

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

Detailed Description

template<typename T>
struct lsst.afw.table::FieldBase< T >

Field base class default implementation (used for numeric scalars and Angle).

FieldBase is where all the implementation

Definition at line 50 of file FieldBase.h.

Member Typedef Documentation

template<typename T>

typedef T const& lsst.afw.table::FieldBase< T >::ConstReference

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

Definition at line 54 of file FieldBase.h.

template<typename T>

typedef T lsst.afw.table::FieldBase< T >::Element

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

Definition at line 55 of file FieldBase.h.

template<typename T>

typedef T& lsst.afw.table::FieldBase< T >::Reference

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

Definition at line 53 of file FieldBase.h.

template<typename T>

typedef T lsst.afw.table::FieldBase< T >::Value

the type returned by BaseRecord::get

Definition at line 52 of file FieldBase.h.

Constructor & Destructor Documentation

template<typename T>

lsst.afw.table::FieldBase< T >::FieldBase ( )

inline

Definition at line 67 of file FieldBase.h.

{}

template<typename T>

lsst.afw.table::FieldBase< T >::FieldBase ( int  )

inline

Definition at line 68 of file FieldBase.h.

                   {
        throw LSST_EXCEPT(
            lsst::pex::exceptions::LogicError,
            "Constructor disabled (it only appears to exist as a workaround for a SWIG bug)."
        );
    }

Member Function Documentation

template<typename T>

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

inlineprotected

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

Definition at line 88 of file FieldBase.h.

{ return *p; }

template<typename T>

int lsst.afw.table::FieldBase< T >::getElementCount ( ) const

inline

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

Definition at line 58 of file FieldBase.h.

{ return 1; }

template<typename T>

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

inlineprotected

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

Definition at line 85 of file FieldBase.h.

{ return *p; }

template<typename T>

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

static

Return a string description of the field type.

template<typename T>

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

inlineprotected

Used to implement RecordBase::get.

Definition at line 91 of file FieldBase.h.

{ return *p; }

template<typename T>

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

inlinestaticprotected

Needed to allow Keys to be default-constructed.

Definition at line 79 of file FieldBase.h.

{ return FieldBase(); }

template<typename T>

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

inlineprotected

Used to implement RecordBase::set.

Definition at line 94 of file FieldBase.h.

{ *p = v; }

template<typename T>

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

inlineprotected

Defines how Fields are printed.

Definition at line 82 of file FieldBase.h.

{}

---

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

• /home/lsstsw/stack/Linux64/afw/10.0-40-g4349866+2/include/lsst/afw/table/FieldBase.h