lsst.astshim  master-g139ee105a0+1
FrameSet.h
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_FRAMESET_H
23 #define ASTSHIM_FRAMESET_H
24 
25 #include <memory>
26 #include <sstream>
27 #include <stdexcept>
28 
29 #include "astshim/base.h"
30 #include "astshim/Frame.h"
31 
32 namespace ast {
33 
99 class FrameSet : public Frame {
100  friend class Frame; // so Frame can call the protected raw ptr constructor
101  friend class Object;
102 
103 public:
104  static int constexpr BASE = AST__BASE;
105  static int constexpr CURRENT = AST__CURRENT;
106  static int constexpr NOFRAME = AST__NOFRAME;
107 
117  explicit FrameSet(Frame const &frame, std::string const &options = "")
118  : FrameSet(astFrameSet(frame.copy()->getRawPtr(), "%s", options.c_str())) {}
119 
130  explicit FrameSet(Frame const &baseFrame, Mapping const &mapping, Frame const &currentFrame,
131  std::string const &options = "")
132  : FrameSet(astFrameSet(baseFrame.copy()->getRawPtr(), "%s", options.c_str())) {
133  addFrame(1, mapping, currentFrame);
134  }
135 
136  virtual ~FrameSet() {}
137 
138  FrameSet(FrameSet const &) = delete;
139  FrameSet(FrameSet &&) = default;
140  FrameSet &operator=(FrameSet const &) = delete;
141  FrameSet &operator=(FrameSet &&) = default;
142 
144  std::shared_ptr<FrameSet> copy() const { return std::static_pointer_cast<FrameSet>(copyPolymorphic()); }
145 
158  void addAxes(Frame const &frame) {
159  astAddFrame(getRawPtr(), AST__ALLFRAMES, nullptr, frame.getRawPtr());
160  assertOK();
161  }
162 
208  void addFrame(int iframe, Mapping const &map, Frame const &frame) {
209  if (iframe == AST__ALLFRAMES) {
210  throw std::runtime_error("iframe = AST__ALLFRAMES; call addAxes instead");
211  }
212  // astAddFrame makes deep copies of the map and frame, so no need to do anything extra
213  astAddFrame(getRawPtr(), iframe, map.getRawPtr(), frame.getRawPtr());
214  assertOK();
215  }
216 
237  void addVariant(Mapping const &map, std::string const &name) {
238  astAddVariant(getRawPtr(), map.getRawPtr(), name.c_str());
239  assertOK();
240  }
241 
246  std::string getAllVariants() const { return getC("AllVariants"); }
247 
251  int getBase() const { return getI("Base"); }
252 
256  int getCurrent() const { return getI("Current"); }
257 
273  std::shared_ptr<Frame> getFrame(int iframe, bool copy = true) const {
274  auto *rawFrame = reinterpret_cast<AstObject *>(astGetFrame(getRawPtr(), iframe));
275  assertOK(rawFrame);
276  if (!rawFrame) {
277  throw std::runtime_error("getFrame failed (returned a null frame)");
278  }
279  return Object::fromAstObject<Frame>(rawFrame, copy);
280  }
281 
307  std::shared_ptr<Mapping> getMapping(int ind1 = BASE, int ind2 = CURRENT) const {
308  AstObject *rawMap = reinterpret_cast<AstObject *>(astGetMapping(getRawPtr(), ind1, ind2));
309  assertOK(rawMap);
310  if (!rawMap) {
311  throw std::runtime_error("getMapping failed (returned a null mapping)");
312  }
313  return Object::fromAstObject<Mapping>(rawMap, true);
314  }
315 
319  int getNFrame() const { return getI("NFrame"); }
320 
326  std::string getVariant() const { return getC("Variant"); }
327 
370  void mirrorVariants(int iframe) {
371  astMirrorVariants(getRawPtr(), iframe);
372  assertOK();
373  }
374 
413  void remapFrame(int iframe, Mapping &map) {
414  astRemapFrame(getRawPtr(), iframe, map.copy()->getRawPtr());
415  assertOK();
416  };
417 
445  void removeFrame(int iframe) {
446  astRemoveFrame(getRawPtr(), iframe);
447  assertOK();
448  }
449 
466  void renameVariant(std::string const &name) {
467  astAddVariant(getRawPtr(), nullptr, name.c_str());
468  assertOK();
469  }
470 
474  void setBase(int ind) { setI("Base", ind); }
475 
479  void setCurrent(int ind) { setI("Current", ind); }
480 
481 protected:
482  virtual std::shared_ptr<Object> copyPolymorphic() const override {
483  return copyImpl<FrameSet, AstFrameSet>();
484  }
485 
493  explicit FrameSet(AstFrameSet *rawPtr) : Frame(reinterpret_cast<AstFrame *>(rawPtr)) {
494  if (!astIsAFrameSet(getRawPtr())) {
495  std::ostringstream os;
496  os << "this is a " << getClassName() << ", which is not a FrameSet";
497  throw std::invalid_argument(os.str());
498  }
499  }
500 };
501 
502 } // namespace ast
503 
504 #endif
int getBase() const
Definition: FrameSet.h:251
AstObject const * getRawPtr() const
Definition: Object.h:286
int getNFrame() const
Definition: FrameSet.h:319
int getI(std::string const &attrib) const
Definition: Object.h:399
AST wrapper classes and functions.
Definition: attributes_channel.dox:1
int getCurrent() const
Definition: FrameSet.h:256
std::string getClassName() const
Definition: Object.h:133
std::shared_ptr< Frame > getFrame(int iframe, bool copy=true) const
Definition: FrameSet.h:273
void assertOK(AstObject *rawPtr1=nullptr, AstObject *rawPtr2=nullptr)
Definition: base.cc:49
virtual std::shared_ptr< Object > copyPolymorphic() const override
Definition: FrameSet.h:482
void setBase(int ind)
Definition: FrameSet.h:474
std::string getVariant() const
Definition: FrameSet.h:326
void mirrorVariants(int iframe)
Definition: FrameSet.h:370
std::shared_ptr< Mapping > getMapping(int ind1=BASE, int ind2=CURRENT) const
Definition: FrameSet.h:307
static int constexpr CURRENT
index of current frame
Definition: FrameSet.h:105
void addVariant(Mapping const &map, std::string const &name)
Definition: FrameSet.h:237
Definition: Mapping.h:59
std::shared_ptr< FrameSet > copy() const
Return a deep copy of this object.
Definition: FrameSet.h:144
void remapFrame(int iframe, Mapping &map)
Definition: FrameSet.h:413
Definition: Frame.h:157
static int constexpr NOFRAME
an invalid frame index
Definition: FrameSet.h:106
std::shared_ptr< Mapping > copy() const
Return a deep copy of this object.
Definition: Mapping.h:71
void renameVariant(std::string const &name)
Definition: FrameSet.h:466
FrameSet(Frame const &baseFrame, Mapping const &mapping, Frame const &currentFrame, std::string const &options="")
Definition: FrameSet.h:130
void addAxes(Frame const &frame)
Definition: FrameSet.h:158
std::string getAllVariants() const
Definition: FrameSet.h:246
void addFrame(int iframe, Mapping const &map, Frame const &frame)
Definition: FrameSet.h:208
void setCurrent(int ind)
Definition: FrameSet.h:479
FrameSet(Frame const &frame, std::string const &options="")
Definition: FrameSet.h:117
static int constexpr BASE
index of base frame
Definition: FrameSet.h:104
void setI(std::string const &attrib, int value)
Definition: Object.h:496
std::string const getC(std::string const &attrib) const
Definition: Object.h:360
Definition: Object.h:49
FrameSet(AstFrameSet *rawPtr)
Definition: FrameSet.h:493
Definition: FrameSet.h:99
void removeFrame(int iframe)
Definition: FrameSet.h:445