lsst.astshim  14.0-11-g0e62142+2
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  _basicAddFrame(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  virtual void addFrame(int iframe, Mapping const &map, Frame const &frame) {
209  _basicAddFrame(iframe, map, frame);
210  }
211 
232  void addVariant(Mapping const &map, std::string const &name) {
233  astAddVariant(getRawPtr(), map.getRawPtr(), name.c_str());
234  assertOK();
235  }
236 
241  std::string getAllVariants() const { return getC("AllVariants"); }
242 
246  int getBase() const { return getI("Base"); }
247 
251  int getCurrent() const { return getI("Current"); }
252 
268  std::shared_ptr<Frame> getFrame(int iframe, bool copy = true) const {
269  auto *rawFrame = reinterpret_cast<AstObject *>(astGetFrame(getRawPtr(), iframe));
270  assertOK(rawFrame);
271  if (!rawFrame) {
272  throw std::runtime_error("getFrame failed (returned a null frame)");
273  }
274  return Object::fromAstObject<Frame>(rawFrame, copy);
275  }
276 
302  std::shared_ptr<Mapping> getMapping(int from = BASE, int to = CURRENT) const {
303  AstObject *rawMap = reinterpret_cast<AstObject *>(astGetMapping(getRawPtr(), from, to));
304  assertOK(rawMap);
305  if (!rawMap) {
306  throw std::runtime_error("getMapping failed (returned a null mapping)");
307  }
308  return Object::fromAstObject<Mapping>(rawMap, true);
309  }
310 
314  int getNFrame() const { return getI("NFrame"); }
315 
321  std::string getVariant() const { return getC("Variant"); }
322 
365  void mirrorVariants(int iframe) {
366  astMirrorVariants(getRawPtr(), iframe);
367  assertOK();
368  }
369 
408  void remapFrame(int iframe, Mapping &map) {
409  astRemapFrame(getRawPtr(), iframe, map.copy()->getRawPtr());
410  assertOK();
411  };
412 
440  virtual void removeFrame(int iframe) {
441  astRemoveFrame(getRawPtr(), iframe);
442  assertOK();
443  }
444 
461  void renameVariant(std::string const &name) {
462  astAddVariant(getRawPtr(), nullptr, name.c_str());
463  assertOK();
464  }
465 
469  void setBase(int ind) { setI("Base", ind); }
470 
474  void setCurrent(int ind) { setI("Current", ind); }
475 
476 protected:
477  virtual std::shared_ptr<Object> copyPolymorphic() const override {
478  return copyImpl<FrameSet, AstFrameSet>();
479  }
480 
488  explicit FrameSet(AstFrameSet *rawPtr) : Frame(reinterpret_cast<AstFrame *>(rawPtr)) {
489  if (!astIsAFrameSet(getRawPtr())) {
490  std::ostringstream os;
491  os << "this is a " << getClassName() << ", which is not a FrameSet";
492  throw std::invalid_argument(os.str());
493  }
494  }
495 
496 private:
497  // non-virtual version of addFrame for use by constructors
498  void _basicAddFrame(int iframe, Mapping const &map, Frame const &frame) {
499  if (iframe == AST__ALLFRAMES) {
500  throw std::runtime_error("iframe = AST__ALLFRAMES; call addAxes instead");
501  }
502  // astAddFrame makes deep copies of the map and frame, so no need to do anything extra
503  astAddFrame(getRawPtr(), iframe, map.getRawPtr(), frame.getRawPtr());
504  assertOK();
505  }
506 
507 };
508 
509 } // namespace ast
510 
511 #endif
int getBase() const
Definition: FrameSet.h:246
virtual void removeFrame(int iframe)
Definition: FrameSet.h:440
AstObject const * getRawPtr() const
Definition: Object.h:289
int getNFrame() const
Definition: FrameSet.h:314
int getI(std::string const &attrib) const
Definition: Object.h:402
AST wrapper classes and functions.
Definition: attributes_channel.dox:1
int getCurrent() const
Definition: FrameSet.h:251
std::string getClassName() const
Definition: Object.h:136
std::shared_ptr< Frame > getFrame(int iframe, bool copy=true) const
Definition: FrameSet.h:268
void assertOK(AstObject *rawPtr1=nullptr, AstObject *rawPtr2=nullptr)
Definition: base.cc:49
virtual std::shared_ptr< Object > copyPolymorphic() const override
Definition: FrameSet.h:477
void setBase(int ind)
Definition: FrameSet.h:469
std::string getVariant() const
Definition: FrameSet.h:321
void mirrorVariants(int iframe)
Definition: FrameSet.h:365
static int constexpr CURRENT
index of current frame
Definition: FrameSet.h:105
void addVariant(Mapping const &map, std::string const &name)
Definition: FrameSet.h:232
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:408
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:461
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:241
void setCurrent(int ind)
Definition: FrameSet.h:474
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:499
std::string const getC(std::string const &attrib) const
Definition: Object.h:363
virtual void addFrame(int iframe, Mapping const &map, Frame const &frame)
Definition: FrameSet.h:208
Definition: Object.h:51
FrameSet(AstFrameSet *rawPtr)
Definition: FrameSet.h:488
Definition: FrameSet.h:99
std::shared_ptr< Mapping > getMapping(int from=BASE, int to=CURRENT) const
Definition: FrameSet.h:302