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
FlagHandler.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 /*
3  * LSST Data Management System
4  * Copyright 2008-2014 LSST Corporation.
5  *
6  * This product includes software developed by the
7  * LSST Project (http://www.lsst.org/).
8  *
9  * This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the LSST License Statement and
20  * the GNU General Public License along with this program. If not,
21  * see <http://www.lsstcorp.org/LegalNotices/>.
22  */
23 
24 #ifndef LSST_MEAS_BASE_FlagHandler_h_INCLUDED
25 #define LSST_MEAS_BASE_FlagHandler_h_INCLUDED
26 
27 #include <vector>
28 
29 #include "lsst/afw/table/Schema.h"
32 
33 namespace lsst { namespace meas { namespace base {
34 
42  char const * name;
43  char const * doc;
44 };
45 
46 class FlagHandler {
47 public:
48 
49  enum { FAILURE=0 };
50 
52 
53  static FlagHandler addFields(
55  std::string const & prefix,
56  FlagDefinition const * begin,
57  FlagDefinition const * end
58  );
59 
61  afw::table::SubSchema const & s,
62  FlagDefinition const * begin,
63  FlagDefinition const * end
64  );
65 
66  FlagDefinition getDefinition(int i) const { return _vector[i].first; }
67 
68  bool getValue(afw::table::BaseRecord const & record, int i) const {
69  return record.get(_vector[i].second);
70  }
71 
72  void setValue(afw::table::BaseRecord & record, int i, bool value) const {
73  record.set(_vector[i].second, value);
74  }
75 
76  void handleFailure(afw::table::BaseRecord & record, MeasurementError const * error=NULL) const;
77 
78 private:
79 
80  typedef std::vector< std::pair<FlagDefinition, afw::table::Key<afw::table::Flag> > > Vector;
81 
83 };
84 
85 }}} // lsst::meas::base
86 
87 #endif // !LSST_MEAS_BASE_FlagHandler_h_INCLUDED
Defines the fields and offsets for a table.
Definition: Schema.h:46
bool getValue(afw::table::BaseRecord const &record, int i) const
Definition: FlagHandler.h:68
A proxy type for name lookups in a Schema.
Definition: Schema.h:330
Simple POD struct used to define and document flags.
Definition: FlagHandler.h:41
Exception to be thrown when a measurement algorithm experiences a known failure mode.
Definition: exceptions.h:48
Field< T >::Value get(Key< T > const &key) const
Return the value of a field for the given key.
Definition: BaseRecord.h:123
def error
Definition: log.py:108
FlagDefinition getDefinition(int i) const
Definition: FlagHandler.h:66
void setValue(afw::table::BaseRecord &record, int i, bool value) const
Definition: FlagHandler.h:72
tbl::Schema schema
Base class for all records.
Definition: BaseRecord.h:27
void set(Key< T > const &key, U const &value)
Set value of a field for the given key.
Definition: BaseRecord.h:136
void handleFailure(afw::table::BaseRecord &record, MeasurementError const *error=NULL) const
Definition: FlagHandler.cc:59
static FlagHandler addFields(afw::table::Schema &schema, std::string const &prefix, FlagDefinition const *begin, FlagDefinition const *end)
Definition: FlagHandler.cc:28
std::vector< std::pair< FlagDefinition, afw::table::Key< afw::table::Flag > > > Vector
Definition: FlagHandler.h:80