LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+1b3060144d,g18429d2f64+f642bf4753,g199a45376c+0ba108daf9,g1fd858c14a+2dcf163641,g262e1987ae+7b8c96d2ca,g29ae962dfc+3bd6ecb08a,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53e1a9e7c5,g4595892280+fef73a337f,g47891489e3+2efcf17695,g4d44eb3520+642b70b07e,g53246c7159+8c5ae1fdc5,g67b6fd64d1+2efcf17695,g67fd3c3899+b70e05ef52,g74acd417e5+317eb4c7d4,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+2efcf17695,g8d7436a09f+3be3c13596,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+a4e7b16d9b,g97be763408+ad77d7208f,g9dd6db0277+b70e05ef52,ga681d05dcb+a3f46e7fff,gabf8522325+735880ea63,gac2eed3f23+2efcf17695,gb89ab40317+2efcf17695,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+b70e05ef52,gdab6d2f7ff+317eb4c7d4,gdc713202bf+b70e05ef52,gdfd2d52018+b10e285e0f,ge365c994fd+310e8507c4,ge410e46f29+2efcf17695,geaed405ab2+562b3308c0,gffca2db377+8c5ae1fdc5,w.2025.35
LSST Data Management Base Package
Loading...
Searching...
No Matches
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)