lsst.astshim  22.0.1-1-geca5380+dfc68d4d09
TimeFrame.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_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  assertOK();
92  }
93 
94  virtual ~TimeFrame() {}
95 
97  TimeFrame(TimeFrame const &) = default;
98  TimeFrame(TimeFrame &&) = default;
99  TimeFrame &operator=(TimeFrame const &) = delete;
100  TimeFrame &operator=(TimeFrame &&) = default;
101 
103  std::shared_ptr<TimeFrame> copy() const {
104  return std::static_pointer_cast<TimeFrame>(copyPolymorphic());
105  }
106 
123  double currentTime() const {
124  auto result = detail::safeDouble(astCurrentTime(getRawPtr()));
125  assertOK();
126  return result;
127  }
128 
130  std::string getAlignTimeScale() const { return getC("AlignTimeScale"); }
131 
133  double getLTOffset() const { return getD("LTOffset"); }
134 
136  double getTimeOrigin() const { return getD("TimeOrigin"); }
137 
139  std::string getTimeScale() const { return getC("TimeScale"); }
140 
142  void setAlignTimeScale(std::string const &scale) { return setC("AlignTimeScale", scale); }
143 
145  void setLTOffset(double offset) { return setD("LTOffset", offset); }
146 
148  void setTimeOrigin(double origin) { return setD("TimeOrigin", origin); }
149 
151  void setTimeScale(std::string const &scale) { return setC("TimeScale", scale); }
152 
153 protected:
154  virtual std::shared_ptr<Object> copyPolymorphic() const override {
155  return copyImpl<TimeFrame, AstTimeFrame>();
156  }
157 
159  explicit TimeFrame(AstTimeFrame *rawptr) : Frame(reinterpret_cast<AstFrame *>(rawptr)) {
160  if (!astIsATimeFrame(getRawPtr())) {
161  std::ostringstream os;
162  os << "this is a " << getClassName() << ", which is not a TimeFrame";
163  throw std::invalid_argument(os.str());
164  }
165  }
166 };
167 
168 } // namespace ast
169 
170 #endif
Definition: Frame.h:157
PointD offset(PointD point1, PointD point2, double offset) const
Definition: Frame.h:1075
Definition: Object.h:51
void setD(std::string const &attrib, double value)
Definition: Object.h:476
double getD(std::string const &attrib) const
Definition: Object.h:374
std::string const getC(std::string const &attrib) const
Definition: Object.h:361
std::string getClassName() const
Definition: Object.h:139
AstObject const * getRawPtr() const
Definition: Object.h:292
void setC(std::string const &attrib, std::string const &value)
Definition: Object.h:464
Definition: TimeFrame.h:80
std::shared_ptr< TimeFrame > copy() const
Return a deep copy of this object.
Definition: TimeFrame.h:103
virtual ~TimeFrame()
Definition: TimeFrame.h:94
TimeFrame(TimeFrame &&)=default
TimeFrame(TimeFrame const &)=default
Copy constructor: make a deep copy.
TimeFrame & operator=(TimeFrame const &)=delete
TimeFrame(AstTimeFrame *rawptr)
Construct a TimeFrame from a raw AST pointer.
Definition: TimeFrame.h:159
void setLTOffset(double offset)
Set LTOffset: the offset of Local Time from UTC, in hours.
Definition: TimeFrame.h:145
virtual std::shared_ptr< Object > copyPolymorphic() const override
Definition: TimeFrame.h:154
double getTimeOrigin() const
Get TimeOrigin: the zero point for TimeFrame axis values.
Definition: TimeFrame.h:136
void setAlignTimeScale(std::string const &scale)
Set AlignTimeScale: time scale in which to align TimeFrames.
Definition: TimeFrame.h:142
double currentTime() const
Definition: TimeFrame.h:123
void setTimeOrigin(double origin)
Set TimeOrigin: the zero point for TimeFrame axis values.
Definition: TimeFrame.h:148
double getLTOffset() const
Get LTOffset: the offset of Local Time from UTC, in hours.
Definition: TimeFrame.h:133
std::string getAlignTimeScale() const
Get AlignTimeScale: time scale in which to align TimeFrames.
Definition: TimeFrame.h:130
TimeFrame & operator=(TimeFrame &&)=default
void setTimeScale(std::string const &scale)
Set TimeScale: the timescale used by the TimeFrame.
Definition: TimeFrame.h:151
TimeFrame(std::string const &options="")
Definition: TimeFrame.h:89
std::string getTimeScale() const
Get TimeScale: the timescale used by the TimeFrame.
Definition: TimeFrame.h:139
double safeDouble(double val)
Definition: utils.h:100
AST wrapper classes and functions.
Definition: attributes_channel.dox:1
void assertOK(AstObject *rawPtr1=nullptr, AstObject *rawPtr2=nullptr)
Definition: base.cc:49