Loading [MathJax]/extensions/tex2jax.js
LSST Applications g0fba68d861+83433b07ee,g16d25e1f1b+23bc9e47ac,g1ec0fe41b4+3ea9d11450,g1fd858c14a+9be2b0f3b9,g2440f9efcc+8c5ae1fdc5,g35bb328faa+8c5ae1fdc5,g4a4af6cd76+d25431c27e,g4d2262a081+c74e83464e,g53246c7159+8c5ae1fdc5,g55585698de+1e04e59700,g56a49b3a55+92a7603e7a,g60b5630c4e+1e04e59700,g67b6fd64d1+3fc8cb0b9e,g78460c75b0+7e33a9eb6d,g786e29fd12+668abc6043,g8352419a5c+8c5ae1fdc5,g8852436030+60e38ee5ff,g89139ef638+3fc8cb0b9e,g94187f82dc+1e04e59700,g989de1cb63+3fc8cb0b9e,g9d31334357+1e04e59700,g9f33ca652e+0a83e03614,gabe3b4be73+8856018cbb,gabf8522325+977d9fabaf,gb1101e3267+8b4b9c8ed7,gb89ab40317+3fc8cb0b9e,gc0af124501+57ccba3ad1,gcf25f946ba+60e38ee5ff,gd6cbbdb0b4+1cc2750d2e,gd794735e4e+7be992507c,gdb1c4ca869+be65c9c1d7,gde0f65d7ad+c7f52e58fe,ge278dab8ac+6b863515ed,ge410e46f29+3fc8cb0b9e,gf35d7ec915+97dd712d81,gf5e32f922b+8c5ae1fdc5,gf618743f1b+747388abfa,gf67bdafdda+3fc8cb0b9e,w.2025.18
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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
29#include "astshim/Frame.h"
30
31namespace ast {
32
80class TimeFrame : public Frame {
81 friend class Object;
82
83public:
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;
101
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
153protected:
154 virtual std::shared_ptr<Object> copyPolymorphic() const override {
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
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
Frame(int naxes, std::string const &options="")
Construct a Frame.
Definition Frame.h:168
std::shared_ptr< T > copyImpl() const
Implementation of deep copy.
Definition Object.h:320
void setD(std::string const &attrib, double value)
Set the value of an attribute as a double.
Definition Object.h:472
double getD(std::string const &attrib) const
Get the value of an attribute as a double.
Definition Object.h:374
std::string const getC(std::string const &attrib) const
Get the value of an attribute as a string.
Definition Object.h:361
std::string getClassName() const
Get Class: the name of the class (e.g.
Definition Object.h:139
void setC(std::string const &attrib, std::string const &value)
Set the value of an attribute as a string.
Definition Object.h:460
AstObject const * getRawPtr() const
Get the raw AST pointer.
Definition Object.h:292
friend class Object
Definition TimeFrame.h:81
virtual ~TimeFrame()
Definition TimeFrame.h:94
TimeFrame(TimeFrame &&)=default
TimeFrame(TimeFrame const &)=default
Copy constructor: make a deep copy.
virtual std::shared_ptr< Object > copyPolymorphic() const override
Return a deep copy of this object.
Definition TimeFrame.h:154
TimeFrame(AstTimeFrame *rawptr)
Construct a TimeFrame from a raw AST pointer.
Definition TimeFrame.h:159
TimeFrame & operator=(TimeFrame &&)=default
void setLTOffset(double offset)
Set LTOffset: the offset of Local Time from UTC, in hours.
Definition TimeFrame.h:145
TimeFrame & operator=(TimeFrame const &)=delete
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
Get the current system time.
Definition TimeFrame.h:123
void setTimeOrigin(double origin)
Set TimeOrigin: the zero point for TimeFrame axis values.
Definition TimeFrame.h:148
std::shared_ptr< TimeFrame > copy() const
Return a deep copy of this object.
Definition TimeFrame.h:103
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
void setTimeScale(std::string const &scale)
Set TimeScale: the timescale used by the TimeFrame.
Definition TimeFrame.h:151
TimeFrame(std::string const &options="")
Construct a TimeFrame.
Definition TimeFrame.h:89
std::string getTimeScale() const
Get TimeScale: the timescale used by the TimeFrame.
Definition TimeFrame.h:139
double safeDouble(double val)
Return a double value after checking status and replacing AST__BAD with nan
Definition utils.h:100
AST wrapper classes and functions.
void assertOK(AstObject *rawPtr1=nullptr, AstObject *rawPtr2=nullptr)
Throw std::runtime_error if AST's state is bad.
Definition base.cc:49
T static_pointer_cast(T... args)
T str(T... args)