Template Struct Field¶

Defined in File Field.h

Inheritance Relationships¶

Base Type¶

public lsst::afw::table::FieldBase< T > (Template Struct FieldBase)

Struct Documentation¶

template<typename T> struct Field : public lsst::afw::table::FieldBase<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.

Public Types

typedef FieldBase<T>::Element Element: Type used to store field data in the table (a field may have multiple elements).

Public Functions

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

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.

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