LSST Applications g0b6bd0c080+a72a5dd7e6,g1182afd7b4+2a019aa3bb,g17e5ecfddb+2b8207f7de,g1d67935e3f+06cf436103,g38293774b4+ac198e9f13,g396055baef+6a2097e274,g3b44f30a73+6611e0205b,g480783c3b1+98f8679e14,g48ccf36440+89c08d0516,g4b93dc025c+98f8679e14,g5c4744a4d9+a302e8c7f0,g613e996a0d+e1c447f2e0,g6c8d09e9e7+25247a063c,g7271f0639c+98f8679e14,g7a9cd813b8+124095ede6,g9d27549199+a302e8c7f0,ga1cf026fa3+ac198e9f13,ga32aa97882+7403ac30ac,ga786bb30fb+7a139211af,gaa63f70f4e+9994eb9896,gabf319e997+ade567573c,gba47b54d5d+94dc90c3ea,gbec6a3398f+06cf436103,gc6308e37c7+07dd123edb,gc655b1545f+ade567573c,gcc9029db3c+ab229f5caf,gd01420fc67+06cf436103,gd877ba84e5+06cf436103,gdb4cecd868+6f279b5b48,ge2d134c3d5+cc4dbb2e3f,ge448b5faa6+86d1ceac1d,gecc7e12556+98f8679e14,gf3ee170dca+25247a063c,gf4ac96e456+ade567573c,gf9f5ea5b4d+ac198e9f13,gff490e6085+8c2580be5c,w.2022.27
LSST Data Management Base Package
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
Definition: SchemaMapper.cc:72
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:500
int getI(std::string const &attrib) const
Get the value of an attribute as an int.
Definition: Object.h:400
void setC(std::string const &attrib, std::string const &value)
Set the value of an attribute as a string.
Definition: Object.h:464
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
const char * source()
Source function that allows astChannel to source from a Stream.
Definition: Stream.h:224
void sink(const char *cstr)
Sink function that allows astChannel to sink to a Stream.
Definition: Stream.h:239
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
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:174