LSST Applications g063fba187b+cac8b7c890,g0f08755f38+6aee506743,g1653933729+a8ce1bb630,g168dd56ebc+a8ce1bb630,g1a2382251a+b4475c5878,g1dcb35cd9c+8f9bc1652e,g20f6ffc8e0+6aee506743,g217e2c1bcf+73dee94bd0,g28da252d5a+1f19c529b9,g2bbee38e9b+3f2625acfc,g2bc492864f+3f2625acfc,g3156d2b45e+6e55a43351,g32e5bea42b+1bb94961c2,g347aa1857d+3f2625acfc,g35bb328faa+a8ce1bb630,g3a166c0a6a+3f2625acfc,g3e281a1b8c+c5dd892a6c,g3e8969e208+a8ce1bb630,g414038480c+5927e1bc1e,g41af890bb2+8a9e676b2a,g7af13505b9+809c143d88,g80478fca09+6ef8b1810f,g82479be7b0+f568feb641,g858d7b2824+6aee506743,g89c8672015+f4add4ffd5,g9125e01d80+a8ce1bb630,ga5288a1d22+2903d499ea,gb58c049af0+d64f4d3760,gc28159a63d+3f2625acfc,gcab2d0539d+b12535109e,gcf0d15dbbd+46a3f46ba9,gda6a2b7d83+46a3f46ba9,gdaeeff99f8+1711a396fd,ge79ae78c31+3f2625acfc,gef2f8181fd+0a71e47438,gf0baf85859+c1f95f4921,gfa517265be+6aee506743,gfa999e8aa5+17cd334064,w.2024.51
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