LSSTApplications  19.0.0-14-gb0260a2+72efe9b372,20.0.0+7927753e06,20.0.0+8829bf0056,20.0.0+995114c5d2,20.0.0+b6f4b2abd1,20.0.0+bddc4f4cbe,20.0.0-1-g253301a+8829bf0056,20.0.0-1-g2b7511a+0d71a2d77f,20.0.0-1-g5b95a8c+7461dd0434,20.0.0-12-g321c96ea+23efe4bbff,20.0.0-16-gfab17e72e+fdf35455f6,20.0.0-2-g0070d88+ba3ffc8f0b,20.0.0-2-g4dae9ad+ee58a624b3,20.0.0-2-g61b8584+5d3db074ba,20.0.0-2-gb780d76+d529cf1a41,20.0.0-2-ged6426c+226a441f5f,20.0.0-2-gf072044+8829bf0056,20.0.0-2-gf1f7952+ee58a624b3,20.0.0-20-geae50cf+e37fec0aee,20.0.0-25-g3dcad98+544a109665,20.0.0-25-g5eafb0f+ee58a624b3,20.0.0-27-g64178ef+f1f297b00a,20.0.0-3-g4cc78c6+e0676b0dc8,20.0.0-3-g8f21e14+4fd2c12c9a,20.0.0-3-gbd60e8c+187b78b4b8,20.0.0-3-gbecbe05+48431fa087,20.0.0-38-ge4adf513+a12e1f8e37,20.0.0-4-g97dc21a+544a109665,20.0.0-4-gb4befbc+087873070b,20.0.0-4-gf910f65+5d3db074ba,20.0.0-5-gdfe0fee+199202a608,20.0.0-5-gfbfe500+d529cf1a41,20.0.0-6-g64f541c+d529cf1a41,20.0.0-6-g9a5b7a1+a1cd37312e,20.0.0-68-ga3f3dda+5fca18c6a4,20.0.0-9-g4aef684+e18322736b,w.2020.45
LSSTDataManagementBasePackage
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 
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())) {
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
std::string
STL class.
std::shared_ptr
STL class.
ast::Object::setD
void setD(std::string const &attrib, double value)
Set the value of an attribute as a double.
Definition: Object.h:476
ast::TimeFrame::TimeFrame
TimeFrame(TimeFrame &&)=default
ast::TimeFrame::setAlignTimeScale
void setAlignTimeScale(std::string const &scale)
Set AlignTimeScale: time scale in which to align TimeFrames.
Definition: TimeFrame.h:142
ast::assertOK
void assertOK(AstObject *rawPtr1=nullptr, AstObject *rawPtr2=nullptr)
Throw std::runtime_error if AST's state is bad.
Definition: base.cc:49
Frame.h
ast::TimeFrame::currentTime
double currentTime() const
Get the current system time.
Definition: TimeFrame.h:123
ast::Object
Abstract base class for all AST objects.
Definition: Object.h:51
ast::TimeFrame::setTimeOrigin
void setTimeOrigin(double origin)
Set TimeOrigin: the zero point for TimeFrame axis values.
Definition: TimeFrame.h:148
ast::TimeFrame::~TimeFrame
virtual ~TimeFrame()
Definition: TimeFrame.h:94
ast::TimeFrame::operator=
TimeFrame & operator=(TimeFrame &&)=default
ast::TimeFrame::setTimeScale
void setTimeScale(std::string const &scale)
Set TimeScale: the timescale used by the TimeFrame.
Definition: TimeFrame.h:151
ast::Object::getClassName
std::string getClassName() const
Get Class: the name of the class (e.g.
Definition: Object.h:139
ast::Frame
Frame is used to represent a coordinate system.
Definition: Frame.h:157
ast::TimeFrame::copy
std::shared_ptr< TimeFrame > copy() const
Return a deep copy of this object.
Definition: TimeFrame.h:103
ast::Frame::offset
PointD offset(PointD point1, PointD point2, double offset) const
Find the point which is offset a specified distance along the geodesic curve between two other points...
Definition: Frame.h:1075
ast::TimeFrame::operator=
TimeFrame & operator=(TimeFrame const &)=delete
ast::TimeFrame::getLTOffset
double getLTOffset() const
Get LTOffset: the offset of Local Time from UTC, in hours.
Definition: TimeFrame.h:133
ast::TimeFrame::getTimeOrigin
double getTimeOrigin() const
Get TimeOrigin: the zero point for TimeFrame axis values.
Definition: TimeFrame.h:136
ast::TimeFrame::TimeFrame
TimeFrame(std::string const &options="")
Construct a TimeFrame.
Definition: TimeFrame.h:89
ast::TimeFrame::TimeFrame
TimeFrame(AstTimeFrame *rawptr)
Construct a TimeFrame from a raw AST pointer.
Definition: TimeFrame.h:159
std::invalid_argument
STL class.
utils.h
result
py::object result
Definition: _schema.cc:429
ast::TimeFrame::copyPolymorphic
virtual std::shared_ptr< Object > copyPolymorphic() const override
Return a deep copy of this object.
Definition: TimeFrame.h:154
std::ostringstream
STL class.
ast::detail::safeDouble
double safeDouble(double val)
Return a double value after checking status and replacing AST__BAD with nan
Definition: utils.h:100
ast
AST wrapper classes and functions.
Definition: attributes_channel.dox:1
os
std::ostream * os
Definition: Schema.cc:746
ast::Object::getD
double getD(std::string const &attrib) const
Get the value of an attribute as a double.
Definition: Object.h:374
ast::Object::setC
void setC(std::string const &attrib, std::string const &value)
Set the value of an attribute as a string.
Definition: Object.h:464
ast::TimeFrame::setLTOffset
void setLTOffset(double offset)
Set LTOffset: the offset of Local Time from UTC, in hours.
Definition: TimeFrame.h:145
ast::TimeFrame
A TimeFrame is a specialised form of one-dimensional Frame which represents various coordinate system...
Definition: TimeFrame.h:80
ast::TimeFrame::TimeFrame
TimeFrame(TimeFrame const &)=default
Copy constructor: make a deep copy.
ast::Object::getC
std::string const getC(std::string const &attrib) const
Get the value of an attribute as a string.
Definition: Object.h:361
lsst::afw.display.ds9.scale
def scale(algorithm, min, max=None, frame=None)
Definition: ds9.py:109
ast::TimeFrame::getAlignTimeScale
std::string getAlignTimeScale() const
Get AlignTimeScale: time scale in which to align TimeFrames.
Definition: TimeFrame.h:130
ast::Object::getRawPtr
AstObject const * getRawPtr() const
Get the raw AST pointer.
Definition: Object.h:292
ast::TimeFrame::getTimeScale
std::string getTimeScale() const
Get TimeScale: the timescale used by the TimeFrame.
Definition: TimeFrame.h:139