LSST Applications  21.0.0+3c14b91618,21.0.0+9f51b1e3f7,21.0.0-1-ga51b5d4+6691386486,21.0.0-10-g2408eff+093cbc5a4d,21.0.0-10-g560fb7b+b5197f4bfa,21.0.0-10-gcf60f90+88fef039d6,21.0.0-15-g490e301a+1aca7ce27a,21.0.0-2-g103fe59+a65a629d54,21.0.0-2-g1367e85+7f080822af,21.0.0-2-g45278ab+9f51b1e3f7,21.0.0-2-g5242d73+7f080822af,21.0.0-2-g7f82c8f+20b0e168c7,21.0.0-2-g8f08a60+e6fd6d9ff9,21.0.0-2-ga326454+20b0e168c7,21.0.0-2-gde069b7+66c51b65da,21.0.0-2-gecfae73+1385e31ff3,21.0.0-2-gfc62afb+7f080822af,21.0.0-20-g09baf175d+b753e4a737,21.0.0-3-g357aad2+34cf5c551a,21.0.0-3-g4be5c26+7f080822af,21.0.0-3-g65f322c+013fced60c,21.0.0-3-g7d9da8d+3c14b91618,21.0.0-3-gaa929c8+b5197f4bfa,21.0.0-3-ge02ed75+1caa01c806,21.0.0-4-g3af6bfd+3791265f16,21.0.0-4-g591bb35+1caa01c806,21.0.0-4-g88306b8+fb98652b4f,21.0.0-4-gccdca77+86bf7a300d,21.0.0-4-ge8a399c+b26ce82291,21.0.0-43-g9a3faf29+c9d24e8573,21.0.0-5-g073e055+09d740ccc5,21.0.0-6-g2d4f3f3+9f51b1e3f7,21.0.0-6-g4e60332+1caa01c806,21.0.0-6-g8356267+caf0b8986d,21.0.0-7-g6531d7b+5c053f0a73,21.0.0-7-g98eecf7+3609eddee2,21.0.0-8-ga5967ee+609c2f0a1c,master-gac4afde19b+1caa01c806,w.2021.09
LSST Data Management Base Package
Channel.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_CHANNEL_H
23 #define ASTSHIM_CHANNEL_H
24 
25 #include <memory>
26 #include <ostream>
27 
28 #include "astshim/base.h"
29 #include "astshim/Object.h"
30 #include "astshim/Stream.h"
31 
32 namespace ast {
33 
34 class KeyMap;
35 
60 class Channel : public Object {
61  friend class Object;
62 
63 public:
74  explicit Channel(Stream &stream, std::string const &options = "");
75 
76  virtual ~Channel();
77 
78  Channel(Channel const &) = delete;
79  Channel(Channel &&) = default;
80  Channel &operator=(Channel const &) = delete;
81  Channel &operator=(Channel &&) = default;
82 
85  throw std::logic_error(
86  "Channel cannot be deep copied because its contained stream cannot be deep copied");
87  }
88 
90  bool getComment() const { return getB("Comment"); }
91 
93  int getFull() const { return getI("Full"); }
94 
96  int getIndent() const { return getB("Indent"); }
97 
99  int getReportLevel() const { return getI("ReportLevel"); }
100 
102  bool getSkip() const { return getB("Skip"); }
103 
105  bool getStrict() const { return getB("Strict"); }
106 
109 
111  void setComment(bool skip) { setB("Comment", skip); }
112 
114  void setFull(int full) { setI("Full", full); }
115 
117  void setIndent(int indent) { setI("Indent", indent); }
118 
125  void setReportLevel(int level) {
126  if ((level < 0) || (level > 3)) {
128  os << "level = " << level << " not in range [0, 3]";
129  throw std::invalid_argument(os.str());
130  }
131  setI("ReportLevel", level);
132  }
133 
135  void setSkip(bool skip) { setB("Skip", skip); }
136 
138  void setStrict(bool strict) { setB("Strict", strict); }
139 
153  KeyMap warnings() const;
154 
156  int write(Object const &object);
157 
158 protected:
159  virtual std::shared_ptr<Object> copyPolymorphic() const override { return std::shared_ptr<Object>(); }
160 
170  explicit Channel(AstChannel *chan, Stream &stream, bool isFits=false);
171 
177  explicit Channel(AstChannel *chan);
178 
179 private:
180  Stream _stream;
181 };
182 
183 } // namespace ast
184 
185 #endif
std::ostream * os
Definition: Schema.cc:746
Channel provides input/output of AST objects.
Definition: Channel.h:60
virtual ~Channel()
Definition: Channel.cc:45
void setIndent(int indent)
Set Indent: indentation increment between objects.
Definition: Channel.h:117
bool getStrict() const
Get Strict: generate errors instead of warnings?
Definition: Channel.h:105
int getFull() const
Get Full: level of output detail; one of -1: minimum, 0: normal, 1: verbose.
Definition: Channel.h:93
void setComment(bool skip)
Set Comment: include textual comments in output?
Definition: Channel.h:111
Channel & operator=(Channel &&)=default
Channel(Channel &&)=default
KeyMap warnings() const
Return a KeyMap holding the text of any warnings issued as a result of the previous invocation of rea...
Definition: Channel.cc:67
int getReportLevel() const
Get ReportLevel: report level.
Definition: Channel.h:99
Channel(Stream &stream, std::string const &options="")
Construct a channel that uses a provided Stream.
Definition: Channel.cc:31
void setStrict(bool strict)
Set Strict: generate errors instead of warnings?
Definition: Channel.h:138
std::shared_ptr< Channel > copy() const
Return a deep copy of this object.
Definition: Channel.h:84
Channel(Channel const &)=delete
bool getComment() const
Get Comment: include textual comments in output?
Definition: Channel.h:90
void setReportLevel(int level)
Set ReportLevel: report level; an integer in the range [0, 3] where 0 is the most verbose.
Definition: Channel.h:125
void setSkip(bool skip)
Set Skip: skip irrelevant data on input?
Definition: Channel.h:135
bool getSkip() const
Get Skip: skip irrelevant data on input?
Definition: Channel.h:102
int getIndent() const
Get Indent: indentation increment between objects.
Definition: Channel.h:96
virtual std::shared_ptr< Object > copyPolymorphic() const override
Return a deep copy of this object.
Definition: Channel.h:159
std::shared_ptr< Object > read()
Read an object from a channel.
Definition: Channel.cc:52
int write(Object const &object)
Write an object to a channel.
Definition: Channel.cc:61
Channel & operator=(Channel const &)=delete
void setFull(int full)
Set Full: level of output detail; one of -1: minimum, 0: normal, 1: verbose.
Definition: Channel.h:114
KeyMap is used to store a set of values with associated keys which identify the values.
Definition: KeyMap.h:83
Abstract base class for all AST objects.
Definition: Object.h:51
void setI(std::string const &attrib, int value)
Set the value of an attribute as an int.
Definition: Object.h:500
bool getB(std::string const &attrib) const
Get the value of an attribute as a bool.
Definition: Object.h:348
int getI(std::string const &attrib) const
Get the value of an attribute as an int.
Definition: Object.h:400
void setB(std::string const &attrib, bool value)
Set the value of an attribute as a bool.
Definition: Object.h:452
A stream for ast::Channel.
Definition: Stream.h:41
AST wrapper classes and functions.