LSSTApplications  20.0.0
LSSTDataManagementBasePackage
CmpMap.h
Go to the documentation of this file.
1 /*
2  * LSST Data Management System
3  * Copyright 2017 AURA/LSST.
4  *
5  * This product includes software developed by the
6  * LSST Project (http://www.lsst.org/).
7  *
8  * This program is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the LSST License Statement and
19  * the GNU General Public License along with this program. If not,
20  * see <https://www.lsstcorp.org/LegalNotices/>.
21  */
22 #ifndef ASTSHIM_CMPMAP_H
23 #define ASTSHIM_CMPMAP_H
24 
25 #include <memory>
26 #include <sstream>
27 #include <stdexcept>
28 
29 #include "astshim/base.h"
30 #include "astshim/detail/utils.h"
31 #include "astshim/Mapping.h"
32 
33 namespace ast {
34 
60 class CmpMap : public Mapping {
61  friend class Object;
62 
63 public:
77  explicit CmpMap(Mapping const &map1, Mapping const &map2, bool series, std::string const &options = "")
78  : Mapping(reinterpret_cast<AstMapping *>(astCmpMap(const_cast<AstObject *>(map1.getRawPtr()),
79  const_cast<AstObject *>(map2.getRawPtr()),
80  series, "%s", options.c_str()))) {
81  assertOK();
82  }
83 
84  virtual ~CmpMap() {}
85 
87  CmpMap(CmpMap const &) = default;
88  CmpMap(CmpMap &&) = default;
89  CmpMap &operator=(CmpMap const &) = delete;
90  CmpMap &operator=(CmpMap &&) = default;
91 
93  std::shared_ptr<CmpMap> copy() const { return std::static_pointer_cast<CmpMap>(copyPolymorphic()); }
94 
101  std::shared_ptr<Mapping> operator[](int i) const { return decompose<Mapping>(i, false); };
102 
104  bool getSeries() { return detail::isSeries(reinterpret_cast<AstCmpMap *>(getRawPtr())); }
105 
106 protected:
107  virtual std::shared_ptr<Object> copyPolymorphic() const override {
108  return copyImpl<CmpMap, AstCmpMap>();
109  }
110 
113  explicit CmpMap(AstCmpMap *rawptr) : Mapping(reinterpret_cast<AstMapping *>(rawptr)) {
114  if (!astIsACmpMap(getRawPtr())) {
116  os << "this is a " << getClassName() << ", which is not a CmpMap";
117  throw std::invalid_argument(os.str());
118  }
119  }
120 };
121 
122 } // namespace ast
123 
124 #endif
std::string
STL class.
std::shared_ptr
STL class.
ast::assertOK
void assertOK(AstObject *rawPtr1=nullptr, AstObject *rawPtr2=nullptr)
Throw std::runtime_error if AST's state is bad.
Definition: base.cc:49
ast::CmpMap::getSeries
bool getSeries()
Return True if the map is in series.
Definition: CmpMap.h:104
ast::Mapping
An abstract base class for objects which transform one set of coordinates to another.
Definition: Mapping.h:59
ast::CmpMap::CmpMap
CmpMap(CmpMap const &)=default
Copy constructor: make a deep copy.
base.h
ast::CmpMap::copyPolymorphic
virtual std::shared_ptr< Object > copyPolymorphic() const override
Return a deep copy of this object.
Definition: CmpMap.h:107
ast::Object
Abstract base class for all AST objects.
Definition: Object.h:51
ast::CmpMap::CmpMap
CmpMap(AstCmpMap *rawptr)
Construct a CmpMap from a raw AST pointer (protected instead of private so that SeriesMap and Paralle...
Definition: CmpMap.h:113
ast::CmpMap::operator=
CmpMap & operator=(CmpMap &&)=default
ast::CmpMap::CmpMap
CmpMap(CmpMap &&)=default
ast::detail::isSeries
bool isSeries(AstCmpMap const *cmpMap)
Return true if the compound map is in series.
Definition: utils.cc:47
ast::CmpMap::operator[]
std::shared_ptr< Mapping > operator[](int i) const
Return a shallow copy of one of the two component mappings.
Definition: CmpMap.h:101
ast::Object::getClassName
std::string getClassName() const
Get Class: the name of the class (e.g.
Definition: Object.h:139
ast::CmpMap::copy
std::shared_ptr< CmpMap > copy() const
Return a deep copy of this object.
Definition: CmpMap.h:93
std::invalid_argument
STL class.
std::ostringstream
STL class.
ast
AST wrapper classes and functions.
Definition: attributes_channel.dox:1
os
std::ostream * os
Definition: Schema.cc:746
Mapping.h
ast::CmpMap::operator=
CmpMap & operator=(CmpMap const &)=delete
ast::Object::getRawPtr
AstObject const * getRawPtr() const
Get the raw AST pointer.
Definition: Object.h:292
ast::CmpMap
Abstract base class for SeriesMap and ParallelMap.
Definition: CmpMap.h:60
utils.h
ast::CmpMap::CmpMap
CmpMap(Mapping const &map1, Mapping const &map2, bool series, std::string const &options="")
Construct a CmpMap.
Definition: CmpMap.h:77
ast::CmpMap::~CmpMap
virtual ~CmpMap()
Definition: CmpMap.h:84