LSSTApplications  10.0-2-g4f67435,11.0.rc2+1,11.0.rc2+12,11.0.rc2+3,11.0.rc2+4,11.0.rc2+5,11.0.rc2+6,11.0.rc2+7,11.0.rc2+8
LSSTDataManagementBasePackage
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
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 >:
lsst.afw.table::Key< afw::table::Array< int > > lsst.afw.table::Key< afw::table::Flag > lsst.afw.table::Key< afw::table::RecordId > lsst.afw.table::Key< CentroidElement > lsst.afw.table::Key< double > lsst.afw.table::Key< ErrElement > lsst.afw.table::Key< float > lsst.afw.table::Key< Flux > lsst.afw.table::Key< FluxErrElement > lsst.afw.table::Key< geom::lsst::afw::geom::Angle > lsst.afw.table::Key< int > lsst.afw.table::Key< lsst::afw::table::Array< double > > lsst.afw.table::Key< Mag > lsst.afw.table::Key< MagErrElement > lsst.afw.table::Key< RecordId > lsst.afw.table::Field< T > lsst.afw.table::Key< 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 48 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 52 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 53 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 51 of file FieldBase.h.

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

the type returned by BaseRecord::get

Definition at line 50 of file FieldBase.h.

Constructor & Destructor Documentation

template<typename T>
lsst.afw.table::FieldBase< T >::FieldBase ( )
inline

Definition at line 65 of file FieldBase.h.

65 {}
template<typename T>
lsst.afw.table::FieldBase< T >::FieldBase ( int  )
inline

Definition at line 66 of file FieldBase.h.

66  {
67  throw LSST_EXCEPT(
68  lsst::pex::exceptions::LogicError,
69  "Constructor disabled (it only appears to exist as a workaround for a SWIG bug)."
70  );
71  }
#define LSST_EXCEPT(type,...)
Definition: Exception.h:46

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 86 of file FieldBase.h.

86 { 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 56 of file FieldBase.h.

56 { 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 83 of file FieldBase.h.

83 { 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 89 of file FieldBase.h.

89 { 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 77 of file FieldBase.h.

77 { 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 92 of file FieldBase.h.

92 { *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 80 of file FieldBase.h.

80 {}

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