LSST Applications  21.0.0+04719a4bac,21.0.0-1-ga51b5d4+f5e6047307,21.0.0-11-g2b59f77+a9c1acf22d,21.0.0-11-ga42c5b2+86977b0b17,21.0.0-12-gf4ce030+76814010d2,21.0.0-13-g1721dae+760e7a6536,21.0.0-13-g3a573fe+768d78a30a,21.0.0-15-g5a7caf0+f21cbc5713,21.0.0-16-g0fb55c1+b60e2d390c,21.0.0-19-g4cded4ca+71a93a33c0,21.0.0-2-g103fe59+bb20972958,21.0.0-2-g45278ab+04719a4bac,21.0.0-2-g5242d73+3ad5d60fb1,21.0.0-2-g7f82c8f+8babb168e8,21.0.0-2-g8f08a60+06509c8b61,21.0.0-2-g8faa9b5+616205b9df,21.0.0-2-ga326454+8babb168e8,21.0.0-2-gde069b7+5e4aea9c2f,21.0.0-2-gecfae73+1d3a86e577,21.0.0-2-gfc62afb+3ad5d60fb1,21.0.0-25-g1d57be3cd+e73869a214,21.0.0-3-g357aad2+ed88757d29,21.0.0-3-g4a4ce7f+3ad5d60fb1,21.0.0-3-g4be5c26+3ad5d60fb1,21.0.0-3-g65f322c+e0b24896a3,21.0.0-3-g7d9da8d+616205b9df,21.0.0-3-ge02ed75+a9c1acf22d,21.0.0-4-g591bb35+a9c1acf22d,21.0.0-4-g65b4814+b60e2d390c,21.0.0-4-gccdca77+0de219a2bc,21.0.0-4-ge8a399c+6c55c39e83,21.0.0-5-gd00fb1e+05fce91b99,21.0.0-6-gc675373+3ad5d60fb1,21.0.0-64-g1122c245+4fb2b8f86e,21.0.0-7-g04766d7+cd19d05db2,21.0.0-7-gdf92d54+04719a4bac,21.0.0-8-g5674e7b+d1bd76f71f,master-gac4afde19b+a9c1acf22d,w.2021.13
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 
30 namespace ast {
31 
46 class XmlChan : public Channel {
47 public:
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:79
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
XmlChan & operator=(XmlChan const &)=delete
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
virtual ~XmlChan()
Definition: XmlChan.h:65
void setXmlPrefix(std::string const &prefix)
Set XmlPrefix: the namespace prefix to use when writing.
Definition: XmlChan.h:88
XmlChan & operator=(XmlChan &&)=default
XmlChan(XmlChan const &)=delete
void sink(const char *cstr)
Sink function that allows astChannel to sink to a Stream.
Definition: Stream.h:239
const char * source()
Source function that allows astChannel to source from a Stream.
Definition: Stream.h:224
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