LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
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
std::string prefix
Channel provides input/output of AST objects.
Definition Channel.h:60
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 provides input/output of AST objects.
Definition XmlChan.h:46
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