lsst.afw g5c39d4753b+b7a74ad830
FunctorKey.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#ifndef AFW_TABLE_FunctorKey_h_INCLUDED
24#define AFW_TABLE_FunctorKey_h_INCLUDED
25
26#include "lsst/afw/table/fwd.h"
27#include "lsst/afw/table/Key.h"
28
29namespace lsst {
30namespace afw {
31namespace table {
32
39template <typename T>
41public:
43 using Value = T;
44
45 virtual T get(BaseRecord const& record) const = 0;
46
47 virtual ~OutputFunctorKey() noexcept = default;
48};
49
56template <typename T>
58public:
60 using Value = T;
61
62 virtual void set(BaseRecord& record, T const& value) const = 0;
63
64 virtual ~InputFunctorKey() noexcept = default;
65};
66
73template <typename T>
74class FunctorKey : public OutputFunctorKey<T>, public InputFunctorKey<T> {
75public:
77 using Value = T;
78};
79
90template <typename T>
92public:
93 virtual T getReference(BaseRecord& record) const = 0;
94
95 virtual ~ReferenceFunctorKey() noexcept = default;
96};
97
108template <typename T>
110public:
111 virtual T getConstReference(BaseRecord const& record) const = 0;
112
113 virtual ~ConstReferenceFunctorKey() noexcept = default;
114};
115} // namespace table
116} // namespace afw
117} // namespace lsst
118
119#endif // !AFW_TABLE_FunctorKey_h_INCLUDED
Base class for all records.
Definition: BaseRecord.h:31
Base class for objects that can return a const reference to part of a record, but are not a true Key.
Definition: FunctorKey.h:109
virtual ~ConstReferenceFunctorKey() noexcept=default
virtual T getConstReference(BaseRecord const &record) const =0
Convenience base class that combines the OutputFunctorKey and InputFunctorKey.
Definition: FunctorKey.h:74
Base class for objects that can set a value on a record, but are not a true Key themselves.
Definition: FunctorKey.h:57
virtual ~InputFunctorKey() noexcept=default
virtual void set(BaseRecord &record, T const &value) const =0
T Value
The data type for set.
Definition: FunctorKey.h:60
Base class for objects that can extract a value from a record, but are not a true Key themselves.
Definition: FunctorKey.h:40
T Value
The data type for get.
Definition: FunctorKey.h:43
virtual ~OutputFunctorKey() noexcept=default
virtual T get(BaseRecord const &record) const =0
Base class for objects that can return a non-const reference to part of a record, but are not a true ...
Definition: FunctorKey.h:91
virtual ~ReferenceFunctorKey() noexcept=default
virtual T getReference(BaseRecord &record) const =0
A base class for image defects.