TimeFrame.h

Go to the documentation of this file.

/*
 * LSST Data Management System
 * Copyright 2017 AURA/LSST.
 *
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the LSST License Statement and
 * the GNU General Public License along with this program.  If not,
 * see <https://www.lsstcorp.org/LegalNotices/>.
 */
#ifndef ASTSHIM_TIMEFRAME_H
#define ASTSHIM_TIMEFRAME_H

#include <memory>
#include <vector>

#include "astshim/detail/utils.h"
#include "astshim/Frame.h"

namespace ast {

class TimeFrame : public Frame {
    friend class Object;

public:
    explicit TimeFrame(std::string const &options = "")
            : Frame(reinterpret_cast<AstFrame *>(astTimeFrame("%s", options.c_str()))) {
                assertOK();
            }

    virtual ~TimeFrame() {}

    TimeFrame(TimeFrame const &) = default;
    TimeFrame(TimeFrame &&) = default;
    TimeFrame &operator=(TimeFrame const &) = delete;
    TimeFrame &operator=(TimeFrame &&) = default;

    std::shared_ptr<TimeFrame> copy() const {
        return std::static_pointer_cast<TimeFrame>(copyPolymorphic());
    }

    double currentTime() const {
        auto result = detail::safeDouble(astCurrentTime(getRawPtr()));
        assertOK();
        return result;
    }

    std::string getAlignTimeScale() const { return getC("AlignTimeScale"); }

    double getLTOffset() const { return getD("LTOffset"); }

    double getTimeOrigin() const { return getD("TimeOrigin"); }

    std::string getTimeScale() const { return getC("TimeScale"); }

    void setAlignTimeScale(std::string const &scale) { return setC("AlignTimeScale", scale); }

    void setLTOffset(double offset) { return setD("LTOffset", offset); }

    void setTimeOrigin(double origin) { return setD("TimeOrigin", origin); }

    void setTimeScale(std::string const &scale) { return setC("TimeScale", scale); }

protected:
    virtual std::shared_ptr<Object> copyPolymorphic() const override {
        return copyImpl<TimeFrame, AstTimeFrame>();
    }

    explicit TimeFrame(AstTimeFrame *rawptr) : Frame(reinterpret_cast<AstFrame *>(rawptr)) {
        if (!astIsATimeFrame(getRawPtr())) {
            std::ostringstream os;
            os << "this is a " << getClassName() << ", which is not a TimeFrame";
            throw std::invalid_argument(os.str());
        }
    }
};

}  // namespace ast

#endif