LSSTApplications  17.0+11,17.0+34,17.0+56,17.0+57,17.0+59,17.0+7,17.0-1-g377950a+33,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+28,17.0.1-1-g55520dc+49,17.0.1-1-g5f4ed7e+52,17.0.1-1-g6dd7d69+17,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+55,17.0.1-1-gfc65f5f+50,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+1,17.0.1-11-ge9de802+16,17.0.1-16-ga14f7d5c+4,17.0.1-17-gc79d625+1,17.0.1-17-gdae4c4a+8,17.0.1-2-g26618f5+29,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-20-g2ca2f74+6,17.0.1-23-gf3eadeb7+1,17.0.1-3-g7e86b59+39,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+40,17.0.1-30-g596af8797,17.0.1-4-g59d126d+4,17.0.1-4-gc69c472+5,17.0.1-6-g5afd9b9+4,17.0.1-7-g35889ee+1,17.0.1-7-gc7c8782+18,17.0.1-9-gc4bbfb2+3,w.2019.22
LSSTDataManagementBasePackage
Simple.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 /*
3  * LSST Data Management System
4  * Copyright 2008, 2009, 2010, 2011 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_Simple_h_INCLUDED
24 #define AFW_TABLE_Simple_h_INCLUDED
25 
29 #include "lsst/afw/table/Catalog.h"
33 
34 namespace lsst {
35 namespace afw {
36 namespace table {
37 
38 class SimpleRecord;
39 class SimpleTable;
40 
48 class SimpleRecord : public BaseRecord {
49 public:
50  typedef SimpleTable Table;
54 
65  BaseRecord(token, std::move(data))
66  {}
67 
70  }
71 
73  RecordId getId() const;
75  void setId(RecordId id);
76 
78  void setCoord(lsst::geom::SpherePoint const& coord);
79 
80  lsst::geom::Angle getRa() const;
81  void setRa(lsst::geom::Angle ra);
82 
83  lsst::geom::Angle getDec() const;
86 
87  SimpleRecord(const SimpleRecord&) = delete;
88  SimpleRecord& operator=(const SimpleRecord&) = delete;
89  SimpleRecord(SimpleRecord&&) = delete;
90  SimpleRecord& operator=(SimpleRecord&&) = delete;
91  ~SimpleRecord() override;
92 
93 private:
94  friend class SimpleTable;
95 };
96 
102 class SimpleTable : public BaseTable {
103 public:
108 
119  static std::shared_ptr<SimpleTable> make(Schema const& schema,
121 
130  return make(schema, IdFactory::makeSimple());
131  }
132 
141  Schema r = getMinimalSchema().schema;
142  r.disconnectAliases();
143  return r;
144  }
145 
152  static bool checkSchema(Schema const& other) { return other.contains(getMinimalSchema().schema); }
153 
155  std::shared_ptr<IdFactory> getIdFactory() { return _idFactory; }
156 
158  std::shared_ptr<IdFactory const> getIdFactory() const { return _idFactory; }
159 
161  void setIdFactory(std::shared_ptr<IdFactory> f) { _idFactory = f; }
162 
164 
169  static Key<RecordId> getIdKey() { return getMinimalSchema().id; }
172  static CoordKey getCoordKey() { return getMinimalSchema().coord; }
174 
177 
180  return std::static_pointer_cast<SimpleRecord>(_makeRecord());
181  }
182 
186  }
187 
191  }
192 
193  SimpleTable& operator=(SimpleTable const&) = delete;
194  SimpleTable& operator=(SimpleTable&&) = delete;
195  ~SimpleTable() override;
196 
197 protected:
199 
200  explicit SimpleTable(SimpleTable const& other);
201  explicit SimpleTable(SimpleTable&& other);
202 
203  std::shared_ptr<BaseTable> _clone() const override;
204 
205  std::shared_ptr<BaseRecord> _makeRecord() override;
206 
207 private:
208  // Struct that holds the minimal schema and the special keys we've added to it.
209  struct MinimalSchema {
210  Schema schema;
212  CoordKey coord;
213 
214  MinimalSchema();
215  };
216 
217  // Return the singleton minimal schema.
218  static MinimalSchema& getMinimalSchema();
219 
220  friend class io::FitsWriter;
221 
222  // Return a writer object that knows how to save in FITS format. See also FitsWriter.
223  std::shared_ptr<io::FitsWriter> makeFitsWriter(fits::Fits* fitsfile, int flags) const override;
224 
225  std::shared_ptr<IdFactory> _idFactory; // generates IDs for new records
226 };
227 
228 inline RecordId SimpleRecord::getId() const { return get(SimpleTable::getIdKey()); }
230 
233  set(SimpleTable::getCoordKey(), coord);
234 }
235 
238 
241 } // namespace table
242 } // namespace afw
243 } // namespace lsst
244 
245 #endif // !AFW_TABLE_Simple_h_INCLUDED
Defines the fields and offsets for a table.
Definition: Schema.h:50
Writer object for FITS binary tables.
Definition: FitsWriter.h:25
static Schema makeMinimalSchema()
Return a minimal schema for Simple tables and records.
Definition: Simple.h:140
Helper struct that contains the information passed from BaseTable to BaseRecord at construction...
Definition: BaseTable.h:32
RecordId getId() const
Convenience accessors for the keys in the minimal reference schema.
Definition: Simple.h:228
static bool checkSchema(Schema const &other)
Return true if the given schema is a valid SimpleTable schema.
Definition: Simple.h:152
Key< lsst::geom::Angle > getRa() const noexcept
Return a constituent Key.
Definition: aggregates.h:267
A mapping between the keys of two Schemas, used to copy data between them.
Definition: SchemaMapper.h:21
SortedCatalogT< Record const > ConstCatalog
Definition: Simple.h:107
std::shared_ptr< SimpleRecord > copyRecord(BaseRecord const &other, SchemaMapper const &mapper)
Deep-copy a record, requiring that it have the same schema as this table.
Definition: Simple.h:189
static Key< RecordId > getIdKey()
Get keys for standard fields shared by all references.
Definition: Simple.h:170
void disconnectAliases()
Sever the connection between this schema and any others with which it shares aliases.
Definition: Schema.cc:729
STL namespace.
Key< lsst::geom::Angle > getDec() const noexcept
Return a constituent Key.
Definition: aggregates.h:268
table::Key< int > id
Definition: Detector.cc:166
A simple struct that combines the two arguments that must be passed to most cfitsio routines and cont...
Definition: fits.h:297
std::shared_ptr< BaseRecord > copyRecord(BaseRecord const &input)
Deep-copy a record, requiring that it have the same schema as this table.
Definition: BaseTable.cc:125
lsst::geom::SpherePoint getCoord() const
Convenience accessors for the keys in the minimal reference schema.
Definition: Simple.h:231
double dec
Definition: Match.cc:41
A class representing an angle.
Definition: Angle.h:127
void setIdFactory(std::shared_ptr< IdFactory > f)
Switch to a new IdFactory – object that generates IDs for the table (may be null).
Definition: Simple.h:161
SortedCatalogT< Record > Catalog
Definition: Simple.h:106
Table class that must contain a unique ID field and a celestial coordinate field. ...
Definition: Simple.h:102
A base class for image defects.
char * data
Definition: BaseRecord.cc:62
Custom catalog class for record/table subclasses that are guaranteed to have an ID, and should generally be sorted by that ID.
Definition: fwd.h:63
std::shared_ptr< SimpleRecord > copyRecord(BaseRecord const &other)
Deep-copy a record, requiring that it have the same schema as this table.
Definition: Simple.h:184
int contains(Schema const &other, int flags=EQUAL_KEYS) const
Test whether the given schema is a subset of this.
Definition: Schema.cc:679
std::shared_ptr< IdFactory const > getIdFactory() const
Return the object that generates IDs for the table (may be null).
Definition: Simple.h:158
table::Schema schema
Definition: Camera.cc:161
T static_pointer_cast(T... args)
ColumnViewT< SimpleRecord > ColumnView
Definition: Simple.h:51
ColumnViewT< SimpleRecord > ColumnView
Definition: Simple.h:105
SimpleRecord & operator=(const SimpleRecord &)=delete
lsst::geom::Angle getDec() const
Convenience accessors for the keys in the minimal reference schema.
Definition: Simple.h:239
std::shared_ptr< BaseTable const > getTable() const
Return the table this record is associated with.
Definition: BaseRecord.h:83
std::shared_ptr< SimpleTable const > getTable() const
Definition: Simple.h:68
SortedCatalogT< SimpleRecord > Catalog
Definition: Simple.h:52
Base class for all records.
Definition: BaseRecord.h:31
std::shared_ptr< SimpleTable > clone() const
Return a polymorphic deep copy of the table.
Definition: Simple.h:176
Point in an unspecified spherical coordinate system.
Definition: SpherePoint.h:57
A class used as a handle to a particular field in a table.
Definition: fwd.h:45
std::shared_ptr< SimpleRecord > makeRecord()
Default-construct an associated record.
Definition: Simple.h:179
ItemVariant const * other
Definition: Schema.cc:56
static std::shared_ptr< IdFactory > makeSimple()
Return a simple IdFactory that simply counts from 1.
Definition: IdFactory.cc:70
SimpleRecord(ConstructionToken const &token, detail::RecordData &&data)
Constructor used by SimpleTable.
Definition: Simple.h:64
friend class SimpleTable
Definition: Simple.h:94
Record class that must contain a unique ID field and a celestial coordinate field.
Definition: Simple.h:48
void setId(RecordId id)
Convenience accessors for the keys in the minimal reference schema.
Definition: Simple.h:229
void setCoord(lsst::geom::SpherePoint const &coord)
Convenience accessors for the keys in the minimal reference schema.
Definition: Simple.h:232
static CoordKey getCoordKey()
Key for the celestial coordinates.
Definition: Simple.h:172
std::shared_ptr< IdFactory > getIdFactory()
Return the object that generates IDs for the table (may be null).
Definition: Simple.h:155
void setRa(lsst::geom::Angle ra)
Convenience accessors for the keys in the minimal reference schema.
Definition: Simple.h:237
lsst::geom::Angle getRa() const
Convenience accessors for the keys in the minimal reference schema.
Definition: Simple.h:236
SortedCatalogT< SimpleRecord const > ConstCatalog
Definition: Simple.h:53
Base class for all tables.
Definition: BaseTable.h:61
SchemaMapper * mapper
Definition: SchemaMapper.cc:78
A FunctorKey used to get or set celestial coordinates from a pair of lsst::geom::Angle keys...
Definition: aggregates.h:210
void setDec(lsst::geom::Angle dec)
Convenience accessors for the keys in the minimal reference schema.
Definition: Simple.h:240
static std::shared_ptr< SimpleTable > make(Schema const &schema)
Construct a new table.
Definition: Simple.h:129