FlagHandler.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 LSST_MEAS_BASE_FlagHandler_h_INCLUDED
#define LSST_MEAS_BASE_FlagHandler_h_INCLUDED

#include <vector>

#include "lsst/afw/table/Schema.h"
#include "lsst/afw/table/BaseRecord.h"
#include "lsst/meas/base/exceptions.h"

namespace lsst { namespace meas { namespace base {

struct FlagDefinition {

    FlagDefinition() {
    }

    FlagDefinition(std::string _name, std::string _doc) {
        name = _name;
        doc = _doc;
    }

    std::string name;
    std::string doc;
};

class FlagHandler {
public:

    enum { FAILURE=0 };

    FlagHandler() {}

    static FlagHandler addFields(
        afw::table::Schema & schema,
        std::string const & prefix,
        FlagDefinition const * begin,
        FlagDefinition const * end
    );

    static FlagHandler addFields(
        afw::table::Schema & schema,
        std::string const & prefix,
        std::vector<FlagDefinition> const * flagDefs
    );

    FlagHandler(
        afw::table::SubSchema const & s,
        FlagDefinition const * begin,
        FlagDefinition const * end
    );

    FlagDefinition getDefinition(std::size_t i) const {
        assert(_vector.size() > i);  // Flag 'i' needs to be available
        return _vector[i].first;
    }

    bool getValue(afw::table::BaseRecord const & record, std::size_t i) const {
        assert(_vector.size() > i);  // Flag 'i' needs to be available
        return record.get(_vector[i].second);
    }

    void setValue(afw::table::BaseRecord & record, std::size_t i, bool value) const {
        assert(_vector.size() > i);  // Flag 'i' needs to be available
        record.set(_vector[i].second, value);
    }

    void handleFailure(afw::table::BaseRecord & record, MeasurementError const * error=NULL) const;

private:

    typedef std::vector< std::pair<FlagDefinition, afw::table::Key<afw::table::Flag> > > Vector;

    Vector _vector;
};

}}} // lsst::meas::base

#endif // !LSST_MEAS_BASE_FlagHandler_h_INCLUDED