Channel.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_CHANNEL_H
#define ASTSHIM_CHANNEL_H

#include <memory>
#include <ostream>

#include "astshim/base.h"
#include "astshim/Object.h"
#include "astshim/Stream.h"

namespace ast {

class KeyMap;

class Channel : public Object {
    friend class Object;

public:
    explicit Channel(Stream &stream, std::string const &options = "");

    virtual ~Channel();

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

    std::shared_ptr<Channel> copy() const {
        throw std::logic_error(
                "Channel cannot be deep copied because its contained stream cannot be deep copied");
    }

    bool getComment() const { return getB("Comment"); }

    int getFull() const { return getI("Full"); }

    int getIndent() const { return getB("Indent"); }

    int getReportLevel() const { return getI("ReportLevel"); }

    bool getSkip() const { return getB("Skip"); }

    bool getStrict() const { return getB("Strict"); }

    std::shared_ptr<Object> read();

    void setComment(bool skip) { setB("Comment", skip); }

    void setFull(int full) { setI("Full", full); }

    void setIndent(int indent) { setI("Indent", indent); }

    void setReportLevel(int level) {
        if ((level < 0) || (level > 3)) {
            std::ostringstream os;
            os << "level = " << level << " not in range [0, 3]";
            throw std::invalid_argument(os.str());
        }
        setI("ReportLevel", level);
    }

    void setSkip(bool skip) { setB("Skip", skip); }

    void setStrict(bool strict) { setB("Strict", strict); }

    KeyMap warnings() const;

    int write(Object const &object);

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

    explicit Channel(AstChannel *chan, Stream &stream, bool isFits=false);

    explicit Channel(AstChannel *chan);

private:
    Stream _stream;  
};

}  // namespace ast

#endif