lsst.astshim  14.0-15-g77b58a8+1
TimeFrame.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_TIMEFRAME_H
23 #define ASTSHIM_TIMEFRAME_H
24 
25 #include <memory>
26 #include <vector>
27 
28 #include "astshim/detail/utils.h"
29 #include "astshim/Frame.h"
30 
31 namespace ast {
32 
80 class TimeFrame : public Frame {
81  friend class Object;
82 
83 public:
89  explicit TimeFrame(std::string const &options = "")
90  : Frame(reinterpret_cast<AstFrame *>(astTimeFrame("%s", options.c_str()))) {}
91 
92  virtual ~TimeFrame() {}
93 
95  TimeFrame(TimeFrame const &) = default;
96  TimeFrame(TimeFrame &&) = default;
97  TimeFrame &operator=(TimeFrame const &) = delete;
98  TimeFrame &operator=(TimeFrame &&) = default;
99 
101  std::shared_ptr<TimeFrame> copy() const {
102  return std::static_pointer_cast<TimeFrame>(copyPolymorphic());
103  }
104 
121  double currentTime() const { return detail::safeDouble(astCurrentTime(getRawPtr())); }
122 
124  std::string getAlignTimeScale() const { return getC("AlignTimeScale"); }
125 
127  double getLTOffset() const { return getD("LTOffset"); }
128 
130  double getTimeOrigin() const { return getD("TimeOrigin"); }
131 
133  std::string getTimeScale() const { return getC("TimeScale"); }
134 
136  void setAlignTimeScale(std::string const &scale) { return setC("AlignTimeScale", scale); }
137 
139  void setLTOffset(double offset) { return setD("LTOffset", offset); }
140 
142  void setTimeOrigin(double origin) { return setD("TimeOrigin", origin); }
143 
145  void setTimeScale(std::string const &scale) { return setC("TimeScale", scale); }
146 
147 protected:
148  virtual std::shared_ptr<Object> copyPolymorphic() const override {
149  return copyImpl<TimeFrame, AstTimeFrame>();
150  }
151 
153  explicit TimeFrame(AstTimeFrame *rawptr) : Frame(reinterpret_cast<AstFrame *>(rawptr)) {
154  if (!astIsATimeFrame(getRawPtr())) {
155  std::ostringstream os;
156  os << "this is a " << getClassName() << ", which is not a TimeFrame";
157  throw std::invalid_argument(os.str());
158  }
159  }
160 };
161 
162 } // namespace ast
163 
164 #endif
double getLTOffset() const
Get LTOffset: the offset of Local Time from UTC, in hours.
Definition: TimeFrame.h:127
virtual std::shared_ptr< Object > copyPolymorphic() const override
Definition: TimeFrame.h:148
AstObject const * getRawPtr() const
Definition: Object.h:291
TimeFrame(AstTimeFrame *rawptr)
Construct a TimeFrame from a raw AST pointer.
Definition: TimeFrame.h:153
AST wrapper classes and functions.
Definition: attributes_channel.dox:1
std::string getAlignTimeScale() const
Get AlignTimeScale: time scale in which to align TimeFrames.
Definition: TimeFrame.h:124
std::string getClassName() const
Definition: Object.h:138
double currentTime() const
Definition: TimeFrame.h:121
std::string getTimeScale() const
Get TimeScale: the timescale used by the TimeFrame.
Definition: TimeFrame.h:133
void setTimeOrigin(double origin)
Set TimeOrigin: the zero point for TimeFrame axis values.
Definition: TimeFrame.h:142
Definition: Frame.h:157
void setC(std::string const &attrib, std::string const &value)
Definition: Object.h:460
void setAlignTimeScale(std::string const &scale)
Set AlignTimeScale: time scale in which to align TimeFrames.
Definition: TimeFrame.h:136
PointD offset(PointD point1, PointD point2, double offset) const
Definition: Frame.h:1074
void setLTOffset(double offset)
Set LTOffset: the offset of Local Time from UTC, in hours.
Definition: TimeFrame.h:139
TimeFrame(std::string const &options="")
Definition: TimeFrame.h:89
double getTimeOrigin() const
Get TimeOrigin: the zero point for TimeFrame axis values.
Definition: TimeFrame.h:130
void setD(std::string const &attrib, double value)
Definition: Object.h:472
double getD(std::string const &attrib) const
Definition: Object.h:373
std::string const getC(std::string const &attrib) const
Definition: Object.h:360
Definition: TimeFrame.h:80
Definition: Object.h:51
std::shared_ptr< TimeFrame > copy() const
Return a deep copy of this object.
Definition: TimeFrame.h:101
void setTimeScale(std::string const &scale)
Set TimeScale: the timescale used by the TimeFrame.
Definition: TimeFrame.h:145