Field.h

Go to the documentation of this file.

// -*- lsst-c++ -*-
#ifndef AFW_TABLE_Field_h_INCLUDED
#define AFW_TABLE_Field_h_INCLUDED

#include <iostream>

#include "lsst/afw/table/FieldBase.h"

namespace lsst {
namespace afw {
namespace table {

template <typename T>
struct Field : public FieldBase<T> {
    typedef typename FieldBase<T>::Element Element;

    Field(std::string const& name, std::string const& doc, std::string const& units = "",
          FieldBase<T> const& size = FieldBase<T>())
            : FieldBase<T>(size), _name(name), _doc(doc), _units(units) {}

    Field(std::string const& name, std::string const& doc, FieldBase<T> const& size)
            : FieldBase<T>(size), _name(name), _doc(doc), _units() {}

    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 _name; }

    std::string const& getDoc() const noexcept { return _doc; }

    std::string const& getUnits() const noexcept { return _units; }

    inline friend std::ostream& operator<<(std::ostream& os, Field<T> const& field) {
        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 << ")";
    }

    Field<T> copyRenamed(std::string const& newName) const {
        return Field<T>(newName, getDoc(), getUnits(), *this);
    }

private:
    std::string _name;
    std::string _doc;
    std::string _units;
};
}  // namespace table
}  // namespace afw
}  // namespace lsst

#endif  // !AFW_TABLE_Field_h_INCLUDED