LSSTApplications  20.0.0
LSSTDataManagementBasePackage
UnitMap.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_UNITMAP_H
23 #define ASTSHIM_UNITMAP_H
24 
25 #include <memory>
26 
27 #include "astshim/base.h"
28 #include "astshim/Mapping.h"
29 
30 namespace ast {
31 
44 class UnitMap : public Mapping {
45  friend class Object;
46 
47 public:
54  explicit UnitMap(int ncoord, std::string const &options = "")
55  : Mapping(reinterpret_cast<AstMapping *>(astUnitMap(ncoord, "%s", options.c_str()))) {
56  assertOK();
57  }
58 
59  virtual ~UnitMap() {}
60 
62  UnitMap(UnitMap const &) = default;
63  UnitMap(UnitMap &&) = default;
64  UnitMap &operator=(UnitMap const &) = delete;
65  UnitMap &operator=(UnitMap &&) = default;
66 
68  std::shared_ptr<UnitMap> copy() const { return std::static_pointer_cast<UnitMap>(copyPolymorphic()); }
69 
70 protected:
71  virtual std::shared_ptr<Object> copyPolymorphic() const override {
72  return copyImpl<UnitMap, AstUnitMap>();
73  }
74 
76  explicit UnitMap(AstUnitMap *rawptr) : Mapping(reinterpret_cast<AstMapping *>(rawptr)) {
77  if (!astIsAUnitMap(getRawPtr())) {
79  os << "this is a " << getClassName() << ", which is not a UnitMap";
80  throw std::invalid_argument(os.str());
81  }
82  }
83 };
84 
85 } // namespace ast
86 
87 #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::UnitMap::UnitMap
UnitMap(int ncoord, std::string const &options="")
Construct a UnitMap.
Definition: UnitMap.h:54
ast::Mapping
An abstract base class for objects which transform one set of coordinates to another.
Definition: Mapping.h:59
base.h
ast::Object
Abstract base class for all AST objects.
Definition: Object.h:51
ast::UnitMap::operator=
UnitMap & operator=(UnitMap const &)=delete
ast::UnitMap::UnitMap
UnitMap(UnitMap const &)=default
Copy constructor: make a deep copy.
ast::Object::getClassName
std::string getClassName() const
Get Class: the name of the class (e.g.
Definition: Object.h:139
ast::UnitMap::operator=
UnitMap & operator=(UnitMap &&)=default
ast::UnitMap::UnitMap
UnitMap(UnitMap &&)=default
ast::UnitMap::UnitMap
UnitMap(AstUnitMap *rawptr)
Construct a UnitMap from a raw AST pointer.
Definition: UnitMap.h:76
std::invalid_argument
STL class.
ast::UnitMap::copy
std::shared_ptr< UnitMap > copy() const
Return a deep copy of this object.
Definition: UnitMap.h:68
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::UnitMap::copyPolymorphic
virtual std::shared_ptr< Object > copyPolymorphic() const override
Return a deep copy of this object.
Definition: UnitMap.h:71
ast::UnitMap::~UnitMap
virtual ~UnitMap()
Definition: UnitMap.h:59
ast::Object::getRawPtr
AstObject const * getRawPtr() const
Get the raw AST pointer.
Definition: Object.h:292
ast::UnitMap
A UnitMap is a unit (null) Mapping that has no effect on the coordinates supplied to it.
Definition: UnitMap.h:44