LSSTApplications  16.0-11-g09ed895+2,16.0-11-g12e47bd,16.0-11-g9bb73b2+6,16.0-12-g5c924a4+6,16.0-14-g9a974b3+1,16.0-15-g1417920+1,16.0-15-gdd5ca33+1,16.0-16-gf0259e2,16.0-17-g31abd91+7,16.0-17-g7d7456e+7,16.0-17-ga3d2e9f+13,16.0-18-ga4d4bcb+1,16.0-18-gd06566c+1,16.0-2-g0febb12+21,16.0-2-g9d5294e+69,16.0-2-ga8830df+6,16.0-20-g21842373+7,16.0-24-g3eae5ec,16.0-28-gfc9ea6c+4,16.0-29-ge8801f9,16.0-3-ge00e371+34,16.0-4-g18f3627+13,16.0-4-g5f3a788+20,16.0-4-ga3eb747+10,16.0-4-gabf74b7+29,16.0-4-gb13d127+6,16.0-49-g42e581f7+6,16.0-5-g27fb78a+7,16.0-5-g6a53317+34,16.0-5-gb3f8a4b+87,16.0-6-g9321be7+4,16.0-6-gcbc7b31+42,16.0-6-gf49912c+29,16.0-7-gd2eeba5+51,16.0-71-ge89f8615e,16.0-8-g21fd5fe+29,16.0-8-g3a9f023+20,16.0-8-g4734f7a+1,16.0-8-g5858431+3,16.0-9-gf5c1f43+8,master-gd73dc1d098+1,w.2019.01
LSSTDataManagementBasePackage
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 
32  : Channel(astChannel(detail::source, detail::sink, "%s", options.c_str()), stream) {}
33 
34 Channel::Channel(AstChannel *chan, Stream &stream, bool isFits)
35  : Object(reinterpret_cast<AstObject *>(chan)), _stream(stream) {
36  astPutChannelData(getRawPtr(), &_stream);
37  _stream.setIsFits(isFits);
38  assertOK();
39 }
40 
41 Channel::Channel(AstChannel *chan) : Object(reinterpret_cast<AstObject *>(chan)), _stream() { assertOK(); }
42 
44  if (_stream.hasStdStream()) {
45  // avoid any attempt to read or write while the stream is being destroyed
46  astPutChannelData(getRawPtr(), nullptr);
47  }
48 }
49 
51  AstObject *rawRet = reinterpret_cast<AstObject *>(astRead(getRawPtr()));
52  if (!rawRet) {
53  throw std::runtime_error("Could not read an AST object from this channel");
54  }
55  return Object::fromAstObject<Object>(rawRet, false);
56 }
57 
58 int Channel::write(Object const &object) {
59  int ret = astWrite(getRawPtr(), object.getRawPtr());
60  assertOK();
61  return ret;
62 }
63 
65  AstKeyMap *rawKeyMap =
66  reinterpret_cast<AstKeyMap *>(astWarnings(reinterpret_cast<AstChannel const *>(getRawPtr())));
67  assertOK();
68  return rawKeyMap ? KeyMap(rawKeyMap) : KeyMap();
69 }
70 
71 } // namespace ast
void sink(const char *cstr)
Sink function that allows astChannel to sink to a Stream.
Definition: Stream.h:239
KeyMap is used to store a set of values with associated keys which identify the values.
Definition: KeyMap.h:83
AstObject const * getRawPtr() const
Get the raw AST pointer.
Definition: Object.h:291
void setIsFits(bool isFits)
set isFits
Definition: Stream.h:129
bool hasStdStream()
Return true if this Stream has an input or output std::stream.
Definition: Stream.h:73
AST wrapper classes and functions.
Channel provides input/output of AST objects.
Definition: Channel.h:60
void assertOK(AstObject *rawPtr1=nullptr, AstObject *rawPtr2=nullptr)
Throw std::runtime_error if AST&#39;s state is bad.
Definition: base.cc:49
tuple options
Definition: lsstimport.py:47
Channel(Stream &stream, std::string const &options="")
Construct a channel that uses a provided Stream.
Definition: Channel.cc:31
STL class.
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:64
int write(Object const &object)
Write an object to a channel.
Definition: Channel.cc:58
const char * source()
Source function that allows astChannel to source from a Stream.
Definition: Stream.h:224
virtual ~Channel()
Definition: Channel.cc:43
Abstract base class for all AST objects.
Definition: Object.h:51
std::shared_ptr< Object > read()
Read an object from a channel.
Definition: Channel.cc:50
A stream for ast::Channel.
Definition: Stream.h:41