arrays.h

Go to the documentation of this file.

// -*- lsst-c++ -*-
/*
 * LSST Data Management System
 * Copyright 2008-2014 LSST Corporation.
 *
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the LSST License Statement and
 * the GNU General Public License along with this program.  If not,
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */
#ifndef AFW_TABLE_arrays_h_INCLUDED
#define AFW_TABLE_arrays_h_INCLUDED

#include "lsst/afw/table/FunctorKey.h"
#include "lsst/afw/table/Schema.h"

namespace lsst { namespace afw { namespace table {

template <typename T>
class ArrayKey : public FunctorKey< ndarray::Array<T const,1,1> >,
                 public ReferenceFunctorKey< ndarray::ArrayRef<T,1,1> >,
                 public ConstReferenceFunctorKey< ndarray::ArrayRef<T const,1,1> >
{
public:

    static ArrayKey addFields(
        Schema & schema,
        std::string const & name,
        std::string const & doc,
        std::string const & unit,
        std::vector<T> const & docData
    );

    static ArrayKey addFields(
        Schema & schema,
        std::string const & name,
        std::string const & doc,
        std::string const & unit,
        int size
    );

    ArrayKey() : _begin() {}

    explicit ArrayKey(std::vector< Key<T> > const & keys);

    explicit ArrayKey(Key< Array<T> > const & other);

    ArrayKey(SubSchema const & s);

    int getSize() const { return _size; }

    virtual ndarray::Array<T const,1,1> get(BaseRecord const & record) const;

    virtual void set(BaseRecord & record, ndarray::Array<T const,1,1> const & value) const;

#ifndef SWIG
    virtual ndarray::ArrayRef<T,1,1> getReference(BaseRecord & record) const;

    virtual ndarray::ArrayRef<T const,1,1> getConstReference(BaseRecord const & record) const;
#endif

    bool operator==(ArrayKey<T> const & other) const {
        return other._begin == _begin && other._size == _size;
    }
    bool operator!=(ArrayKey<T> const & other) const { return !operator==(other); }

    bool isValid() const { return _begin.isValid(); }

    Key<T> operator[](int i) const;

    ArrayKey slice(int begin, int end) const;

private:

    ArrayKey(Key<T> const & begin, int size) : _begin(begin), _size(size) {}

    Key<T> _begin;
    int _size;
};

}}} // namespace lsst::afw::table

#endif // !AFW_TABLE_arrays_h_INCLUDED