FrameSet.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_FRAMESET_H
#define ASTSHIM_FRAMESET_H

#include <memory>
#include <sstream>
#include <stdexcept>

#include "astshim/base.h"
#include "astshim/Frame.h"

namespace ast {

class FrameSet : public Frame {
    friend class Frame;  // so Frame can call the protected raw ptr constructor
    friend class Object;

public:
    static int constexpr BASE = AST__BASE;        
    static int constexpr CURRENT = AST__CURRENT;  
    static int constexpr NOFRAME = AST__NOFRAME;  

    explicit FrameSet(Frame const &frame, std::string const &options = "")
            : FrameSet(astFrameSet(frame.copy()->getRawPtr(), "%s", options.c_str())) {}

    explicit FrameSet(Frame const &baseFrame, Mapping const &mapping, Frame const &currentFrame,
                      std::string const &options = "")
            : FrameSet(baseFrame, options) {
        _basicAddFrame(1, mapping, currentFrame);
    }

    virtual ~FrameSet() {}

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

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

    void addAxes(Frame const &frame) {
        astAddFrame(getRawPtr(), AST__ALLFRAMES, nullptr, frame.getRawPtr());
        assertOK();
    }

    virtual void addFrame(int iframe, Mapping const &map, Frame const &frame) {
        _basicAddFrame(iframe, map, frame);
    }

    void addVariant(Mapping const &map, std::string const &name) {
        astAddVariant(getRawPtr(), map.getRawPtr(), name.c_str());
        assertOK();
    }

    std::string getAllVariants() const { return getC("AllVariants"); }

    int getBase() const { return getI("Base"); }

    int getCurrent() const { return getI("Current"); }

    std::shared_ptr<Frame> getFrame(int iframe, bool copy = true) const {
        auto *rawFrame = reinterpret_cast<AstObject *>(astGetFrame(getRawPtr(), iframe));
        assertOK(rawFrame);
        if (!rawFrame) {
            throw std::runtime_error("getFrame failed (returned a null frame)");
        }
        return Object::fromAstObject<Frame>(rawFrame, copy);
    }

    std::shared_ptr<Mapping> getMapping(int from = BASE, int to = CURRENT) const {
        AstObject *rawMap = reinterpret_cast<AstObject *>(astGetMapping(getRawPtr(), from, to));
        assertOK(rawMap);
        if (!rawMap) {
            throw std::runtime_error("getMapping failed (returned a null mapping)");
        }
        return Object::fromAstObject<Mapping>(rawMap, true);
    }

    int getNFrame() const { return getI("NFrame"); }

    std::string getVariant() const { return getC("Variant"); }

    void mirrorVariants(int iframe) {
        astMirrorVariants(getRawPtr(), iframe);
        assertOK();
    }

    void remapFrame(int iframe, Mapping &map) {
        astRemapFrame(getRawPtr(), iframe, map.copy()->getRawPtr());
        assertOK();
    };

    virtual void removeFrame(int iframe) {
        astRemoveFrame(getRawPtr(), iframe);
        assertOK();
    }

    void renameVariant(std::string const &name) {
        astAddVariant(getRawPtr(), nullptr, name.c_str());
        assertOK();
    }

    void setBase(int ind) { setI("Base", ind); }

    void setCurrent(int ind) { setI("Current", ind); }

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

    explicit FrameSet(AstFrameSet *rawPtr) : Frame(reinterpret_cast<AstFrame *>(rawPtr)) {
        if (!astIsAFrameSet(getRawPtr())) {
            std::ostringstream os;
            os << "this is a " << getClassName() << ", which is not a FrameSet";
            throw std::invalid_argument(os.str());
        }
    }

private:
    // non-virtual version of addFrame for use by constructors
    void _basicAddFrame(int iframe, Mapping const &map, Frame const &frame) {
        if (iframe == AST__ALLFRAMES) {
            throw std::runtime_error("iframe = AST__ALLFRAMES; call addAxes instead");
        }
        // astAddFrame makes deep copies of the map and frame, so no need to do anything extra
        astAddFrame(getRawPtr(), iframe, map.getRawPtr(), frame.getRawPtr());
        assertOK();
    }

};

}  // namespace ast

#endif