Loading [MathJax]/extensions/tex2jax.js
LSST Applications g0fba68d861+83433b07ee,g16d25e1f1b+23bc9e47ac,g1ec0fe41b4+3ea9d11450,g1fd858c14a+9be2b0f3b9,g2440f9efcc+8c5ae1fdc5,g35bb328faa+8c5ae1fdc5,g4a4af6cd76+d25431c27e,g4d2262a081+c74e83464e,g53246c7159+8c5ae1fdc5,g55585698de+1e04e59700,g56a49b3a55+92a7603e7a,g60b5630c4e+1e04e59700,g67b6fd64d1+3fc8cb0b9e,g78460c75b0+7e33a9eb6d,g786e29fd12+668abc6043,g8352419a5c+8c5ae1fdc5,g8852436030+60e38ee5ff,g89139ef638+3fc8cb0b9e,g94187f82dc+1e04e59700,g989de1cb63+3fc8cb0b9e,g9d31334357+1e04e59700,g9f33ca652e+0a83e03614,gabe3b4be73+8856018cbb,gabf8522325+977d9fabaf,gb1101e3267+8b4b9c8ed7,gb89ab40317+3fc8cb0b9e,gc0af124501+57ccba3ad1,gcf25f946ba+60e38ee5ff,gd6cbbdb0b4+1cc2750d2e,gd794735e4e+7be992507c,gdb1c4ca869+be65c9c1d7,gde0f65d7ad+c7f52e58fe,ge278dab8ac+6b863515ed,ge410e46f29+3fc8cb0b9e,gf35d7ec915+97dd712d81,gf5e32f922b+8c5ae1fdc5,gf618743f1b+747388abfa,gf67bdafdda+3fc8cb0b9e,w.2025.18
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
XmlChan.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_XMLCHAN_H
23#define ASTSHIM_XMLCHAN_H
24
25#include "astshim/base.h"
26#include "astshim/Object.h"
27#include "astshim/Stream.h"
28#include "astshim/Channel.h"
29
30namespace ast {
31
46class XmlChan : public Channel {
47public:
58 explicit XmlChan(Stream &stream, std::string const &options = "")
59 : Channel(reinterpret_cast<AstChannel *>(
60 astXmlChan(detail::source, detail::sink, "%s", options.c_str())),
61 stream) {
62 assertOK();
63 }
64
65 virtual ~XmlChan() {}
66
67 XmlChan(XmlChan const &) = delete;
68 XmlChan(XmlChan &&) = default;
69 XmlChan &operator=(XmlChan const &) = delete;
70 XmlChan &operator=(XmlChan &&) = default;
71
73 std::string getXmlFormat() const { return getC("XmlFormat"); }
74
76 int getXmlLength() const { return getI("XmlLength"); }
77
79 std::string getXmlPrefix() { return getC("XmlPrefix"); }
80
82 void setXmlFormat(std::string const &format) { setC("XmlFormat", format); }
83
85 void setXmlLength(int len) { setI("XmlLength", len); }
86
88 void setXmlPrefix(std::string const &prefix) { setC("XmlPrefix", prefix); }
89};
90
91} // namespace ast
92
93#endif
Channel(Stream &stream, std::string const &options="")
Construct a channel that uses a provided Stream.
Definition Channel.cc:31
std::string const getC(std::string const &attrib) const
Get the value of an attribute as a string.
Definition Object.h:361
void setI(std::string const &attrib, int value)
Set the value of an attribute as an int.
Definition Object.h:496
int getI(std::string const &attrib) const
Get the value of an attribute as an int.
Definition Object.cc:178
void setC(std::string const &attrib, std::string const &value)
Set the value of an attribute as a string.
Definition Object.h:460
A stream for ast::Channel.
Definition Stream.h:41
XmlChan(XmlChan &&)=default
int getXmlLength() const
Get XmlLength: controls output buffer length.
Definition XmlChan.h:76
std::string getXmlPrefix()
Get XmlPrefix: the namespace prefix to use when writing.
Definition XmlChan.h:79
std::string getXmlFormat() const
Get XmlFormat System for formatting Objects as XML.
Definition XmlChan.h:73
void setXmlLength(int len)
Set XmlLength: controls output buffer length; 0 for no limit.
Definition XmlChan.h:85
void setXmlFormat(std::string const &format)
Set XmlFormat System for formatting Objects as XML.
Definition XmlChan.h:82
XmlChan(Stream &stream, std::string const &options="")
Construct a channel that uses a provided Stream.
Definition XmlChan.h:58
XmlChan & operator=(XmlChan &&)=default
virtual ~XmlChan()
Definition XmlChan.h:65
XmlChan & operator=(XmlChan const &)=delete
void setXmlPrefix(std::string const &prefix)
Set XmlPrefix: the namespace prefix to use when writing.
Definition XmlChan.h:88
XmlChan(XmlChan const &)=delete
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