Loading [MathJax]/extensions/tex2jax.js
LSST Applications g044012fb7c+304891ab8a,g04a91732dc+4e1b87f259,g07dc498a13+f701f15b83,g114c6a66ad+c7887c1284,g1409bbee79+f701f15b83,g1a7e361dbc+f701f15b83,g1fd858c14a+6ebd102b59,g35bb328faa+0eb18584fe,g3bd4b5ce2c+e83bf4edc8,g4e0f332c67+976ceb6bc8,g53246c7159+0eb18584fe,g5477a8d5ce+51234355ef,g60b5630c4e+c7887c1284,g623d845a50+c7887c1284,g6f0c2978f1+98123c34b6,g71fabbc107+c7887c1284,g75b6c65c88+ce466f4385,g78460c75b0+85633614c8,g786e29fd12+02b9b86fc9,g8852436030+cfe5cf5b7b,g89139ef638+f701f15b83,g9125e01d80+0eb18584fe,g95236ca021+d4f98599f0,g974caa22f6+0eb18584fe,g989de1cb63+f701f15b83,g9f33ca652e+b4908f5dcd,gaaedd4e678+f701f15b83,gabe3b4be73+543c3c03c9,gace736f484+07e57cea59,gb1101e3267+487fd1b06d,gb58c049af0+492386d360,gc99c83e5f0+a513197d39,gcf25f946ba+cfe5cf5b7b,gd0fa69b896+babbe6e5fe,gd6cbbdb0b4+3fef02d88a,gde0f65d7ad+e8379653a2,ge278dab8ac+ae64226a64,gfba249425e+0eb18584fe,w.2025.07
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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
29namespace ast {
30
32 : Channel(astChannel(detail::source, detail::sink, "%s", options.c_str()), stream) {
33 assertOK();
34}
35
36Channel::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
43Channel::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
61int 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
static std::shared_ptr< Class > fromAstObject(AstObject *rawObj, bool copy)
Given a bare AST object pointer return a shared pointer to an ast::Object of the correct type.
Definition Object.cc:138
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
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