LSSTApplications  16.0-10-g0ee56ad+5,16.0-11-ga33d1f2+5,16.0-12-g3ef5c14+3,16.0-12-g71e5ef5+18,16.0-12-gbdf3636+3,16.0-13-g118c103+3,16.0-13-g8f68b0a+3,16.0-15-gbf5c1cb+4,16.0-16-gfd17674+3,16.0-17-g7c01f5c+3,16.0-18-g0a50484+1,16.0-20-ga20f992+8,16.0-21-g0e05fd4+6,16.0-21-g15e2d33+4,16.0-22-g62d8060+4,16.0-22-g847a80f+4,16.0-25-gf00d9b8+1,16.0-28-g3990c221+4,16.0-3-gf928089+3,16.0-32-g88a4f23+5,16.0-34-gd7987ad+3,16.0-37-gc7333cb+2,16.0-4-g10fc685+2,16.0-4-g18f3627+26,16.0-4-g5f3a788+26,16.0-5-gaf5c3d7+4,16.0-5-gcc1f4bb+1,16.0-6-g3b92700+4,16.0-6-g4412fcd+3,16.0-6-g7235603+4,16.0-69-g2562ce1b+2,16.0-8-g14ebd58+4,16.0-8-g2df868b+1,16.0-8-g4cec79c+6,16.0-8-gadf6c7a+1,16.0-8-gfc7ad86,16.0-82-g59ec2a54a+1,16.0-9-g5400cdc+2,16.0-9-ge6233d7+5,master-g2880f2d8cf+3,v17.0.rc1
LSSTDataManagementBasePackage
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 
63  virtual ~XmlChan() {}
64 
65  XmlChan(XmlChan const &) = delete;
66  XmlChan(XmlChan &&) = default;
67  XmlChan &operator=(XmlChan const &) = delete;
68  XmlChan &operator=(XmlChan &&) = default;
69 
71  std::string getXmlFormat() const { return getC("XmlFormat"); }
72 
74  int getXmlLength() const { return getI("XmlLength"); }
75 
77  std::string getXmlPrefix() { return getC("XmlPrefix"); }
78 
80  void setXmlFormat(std::string const &format) { setC("XmlFormat", format); }
81 
83  void setXmlLength(int len) { setI("XmlLength", len); }
84 
86  void setXmlPrefix(std::string const &prefix) { setC("XmlPrefix", prefix); }
87 };
88 
89 } // namespace ast
90 
91 #endif
void setXmlPrefix(std::string const &prefix)
Set XmlPrefix: the namespace prefix to use when writing.
Definition: XmlChan.h:86
void sink(const char *cstr)
Sink function that allows astChannel to sink to a Stream.
Definition: Stream.h:239
int getI(std::string const &attrib) const
Get the value of an attribute as an int.
Definition: Object.h:399
AST wrapper classes and functions.
XmlChan(Stream &stream, std::string const &options="")
Construct a channel that uses a provided Stream.
Definition: XmlChan.h:58
Channel provides input/output of AST objects.
Definition: Channel.h:60
tuple options
Definition: lsstimport.py:47
std::string prefix
Definition: SchemaMapper.cc:79
STL class.
void setC(std::string const &attrib, std::string const &value)
Set the value of an attribute as a string.
Definition: Object.h:460
std::string getXmlFormat() const
Get XmlFormat System for formatting Objects as XML.
Definition: XmlChan.h:71
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:168
virtual ~XmlChan()
Definition: XmlChan.h:63
const char * source()
Source function that allows astChannel to source from a Stream.
Definition: Stream.h:224
std::string getXmlPrefix()
Get XmlPrefix: the namespace prefix to use when writing.
Definition: XmlChan.h:77
XmlChan & operator=(XmlChan const &)=delete
XmlChan provides input/output of AST objects.
Definition: XmlChan.h:46
void setI(std::string const &attrib, int value)
Set the value of an attribute as an int.
Definition: Object.h:496
std::string const getC(std::string const &attrib) const
Get the value of an attribute as a string.
Definition: Object.h:360
int getXmlLength() const
Get XmlLength: controls output buffer length.
Definition: XmlChan.h:74
void setXmlLength(int len)
Set XmlLength: controls output buffer length; 0 for no limit.
Definition: XmlChan.h:83
A stream for ast::Channel.
Definition: Stream.h:41
void setXmlFormat(std::string const &format)
Set XmlFormat System for formatting Objects as XML.
Definition: XmlChan.h:80