LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Channel.cc
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 
23 #include "astshim/base.h"
24 #include "astshim/KeyMap.h"
25 #include "astshim/Object.h"
26 #include "astshim/Stream.h"
27 #include "astshim/Channel.h"
28 
29 namespace ast {
30 
31 Channel::Channel(Stream &stream, std::string const &options)
32  : Channel(astChannel(detail::source, detail::sink, "%s", options.c_str()), stream) {
33  assertOK();
34 }
35 
36 Channel::Channel(AstChannel *chan, Stream &stream, bool isFits)
37  : Object(reinterpret_cast<AstObject *>(chan)), _stream(stream) {
38  astPutChannelData(getRawPtr(), &_stream);
39  _stream.setIsFits(isFits);
40  assertOK();
41 }
42 
43 Channel::Channel(AstChannel *chan) : Object(reinterpret_cast<AstObject *>(chan)), _stream() { assertOK(); }
44 
46  if (_stream.hasStdStream()) {
47  // avoid any attempt to read or write while the stream is being destroyed
48  astPutChannelData(getRawPtr(), nullptr);
49  }
50 }
51 
53  AstObject *rawRet = reinterpret_cast<AstObject *>(astRead(getRawPtr()));
54  assertOK(rawRet);
55  if (!rawRet) {
56  throw std::runtime_error("Could not read an AST object from this channel");
57  }
58  return Object::fromAstObject<Object>(rawRet, false);
59 }
60 
61 int Channel::write(Object const &object) {
62  int ret = astWrite(getRawPtr(), object.getRawPtr());
63  assertOK();
64  return ret;
65 }
66 
68  AstKeyMap *rawKeyMap =
69  reinterpret_cast<AstKeyMap *>(astWarnings(reinterpret_cast<AstChannel const *>(getRawPtr())));
70  assertOK();
71  return rawKeyMap ? KeyMap(rawKeyMap) : KeyMap();
72 }
73 
74 } // namespace ast
Channel provides input/output of AST objects.
Definition: Channel.h:60
virtual ~Channel()
Definition: Channel.cc:45
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
Channel(Stream &stream, std::string const &options="")
Construct a channel that uses a provided Stream.
Definition: Channel.cc:31
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
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
AstObject const * getRawPtr() const
Get the raw AST pointer.
Definition: Object.h:292
A stream for ast::Channel.
Definition: Stream.h:41
bool hasStdStream()
Return true if this Stream has an input or output std::stream.
Definition: Stream.h:73
void setIsFits(bool isFits)
set isFits
Definition: Stream.h:129
void sink(const char *cstr)
Sink function that allows astChannel to sink to a Stream.
Definition: Stream.h:239
const char * source()
Source function that allows astChannel to source from a Stream.
Definition: Stream.h:224
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