LSSTApplications  16.0-10-g0ee56ad+5,16.0-11-ga33d1f2+5,16.0-12-g3ef5c14+3,16.0-12-g71e5ef5+18,16.0-12-gbdf3636+3,16.0-13-g118c103+3,16.0-13-g8f68b0a+3,16.0-15-gbf5c1cb+4,16.0-16-gfd17674+3,16.0-17-g7c01f5c+3,16.0-18-g0a50484+1,16.0-20-ga20f992+8,16.0-21-g0e05fd4+6,16.0-21-g15e2d33+4,16.0-22-g62d8060+4,16.0-22-g847a80f+4,16.0-25-gf00d9b8+1,16.0-28-g3990c221+4,16.0-3-gf928089+3,16.0-32-g88a4f23+5,16.0-34-gd7987ad+3,16.0-37-gc7333cb+2,16.0-4-g10fc685+2,16.0-4-g18f3627+26,16.0-4-g5f3a788+26,16.0-5-gaf5c3d7+4,16.0-5-gcc1f4bb+1,16.0-6-g3b92700+4,16.0-6-g4412fcd+3,16.0-6-g7235603+4,16.0-69-g2562ce1b+2,16.0-8-g14ebd58+4,16.0-8-g2df868b+1,16.0-8-g4cec79c+6,16.0-8-gadf6c7a+1,16.0-8-gfc7ad86,16.0-82-g59ec2a54a+1,16.0-9-g5400cdc+2,16.0-9-ge6233d7+5,master-g2880f2d8cf+3,v17.0.rc1
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