LSSTApplications  19.0.0-14-gb0260a2+72efe9b372,20.0.0+7927753e06,20.0.0+8829bf0056,20.0.0+995114c5d2,20.0.0+b6f4b2abd1,20.0.0+bddc4f4cbe,20.0.0-1-g253301a+8829bf0056,20.0.0-1-g2b7511a+0d71a2d77f,20.0.0-1-g5b95a8c+7461dd0434,20.0.0-12-g321c96ea+23efe4bbff,20.0.0-16-gfab17e72e+fdf35455f6,20.0.0-2-g0070d88+ba3ffc8f0b,20.0.0-2-g4dae9ad+ee58a624b3,20.0.0-2-g61b8584+5d3db074ba,20.0.0-2-gb780d76+d529cf1a41,20.0.0-2-ged6426c+226a441f5f,20.0.0-2-gf072044+8829bf0056,20.0.0-2-gf1f7952+ee58a624b3,20.0.0-20-geae50cf+e37fec0aee,20.0.0-25-g3dcad98+544a109665,20.0.0-25-g5eafb0f+ee58a624b3,20.0.0-27-g64178ef+f1f297b00a,20.0.0-3-g4cc78c6+e0676b0dc8,20.0.0-3-g8f21e14+4fd2c12c9a,20.0.0-3-gbd60e8c+187b78b4b8,20.0.0-3-gbecbe05+48431fa087,20.0.0-38-ge4adf513+a12e1f8e37,20.0.0-4-g97dc21a+544a109665,20.0.0-4-gb4befbc+087873070b,20.0.0-4-gf910f65+5d3db074ba,20.0.0-5-gdfe0fee+199202a608,20.0.0-5-gfbfe500+d529cf1a41,20.0.0-6-g64f541c+d529cf1a41,20.0.0-6-g9a5b7a1+a1cd37312e,20.0.0-68-ga3f3dda+5fca18c6a4,20.0.0-9-g4aef684+e18322736b,w.2020.45
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  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
STL class.
ast::XmlChan::XmlChan
XmlChan(XmlChan const &)=delete
ast::XmlChan
XmlChan provides input/output of AST objects.
Definition: XmlChan.h:46
ast::assertOK
void assertOK(AstObject *rawPtr1=nullptr, AstObject *rawPtr2=nullptr)
Throw std::runtime_error if AST's state is bad.
Definition: base.cc:49
ast::XmlChan::operator=
XmlChan & operator=(XmlChan const &)=delete
ast::XmlChan::getXmlPrefix
std::string getXmlPrefix()
Get XmlPrefix: the namespace prefix to use when writing.
Definition: XmlChan.h:79
lsst.pex.config.history.format
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:174
ast::XmlChan::getXmlLength
int getXmlLength() const
Get XmlLength: controls output buffer length.
Definition: XmlChan.h:76
ast::Channel
Channel provides input/output of AST objects.
Definition: Channel.h:60
ast::Stream
A stream for ast::Channel.
Definition: Stream.h:41
ast::XmlChan::setXmlLength
void setXmlLength(int len)
Set XmlLength: controls output buffer length; 0 for no limit.
Definition: XmlChan.h:85
ast::detail::source
const char * source()
Source function that allows astChannel to source from a Stream.
Definition: Stream.h:224
ast::Object::getI
int getI(std::string const &attrib) const
Get the value of an attribute as an int.
Definition: Object.h:400
ast::XmlChan::setXmlFormat
void setXmlFormat(std::string const &format)
Set XmlFormat System for formatting Objects as XML.
Definition: XmlChan.h:82
Channel.h
ast::XmlChan::setXmlPrefix
void setXmlPrefix(std::string const &prefix)
Set XmlPrefix: the namespace prefix to use when writing.
Definition: XmlChan.h:88
ast::XmlChan::operator=
XmlChan & operator=(XmlChan &&)=default
ast::XmlChan::XmlChan
XmlChan(XmlChan &&)=default
base.h
ast
AST wrapper classes and functions.
Definition: attributes_channel.dox:1
ast::Object::setC
void setC(std::string const &attrib, std::string const &value)
Set the value of an attribute as a string.
Definition: Object.h:464
ast::XmlChan::XmlChan
XmlChan(Stream &stream, std::string const &options="")
Construct a channel that uses a provided Stream.
Definition: XmlChan.h:58
ast::Object::setI
void setI(std::string const &attrib, int value)
Set the value of an attribute as an int.
Definition: Object.h:500
ast::Object::getC
std::string const getC(std::string const &attrib) const
Get the value of an attribute as a string.
Definition: Object.h:361
Object.h
prefix
std::string prefix
Definition: SchemaMapper.cc:79
ast::XmlChan::getXmlFormat
std::string getXmlFormat() const
Get XmlFormat System for formatting Objects as XML.
Definition: XmlChan.h:73
ast::detail::sink
void sink(const char *cstr)
Sink function that allows astChannel to sink to a Stream.
Definition: Stream.h:239
ast::XmlChan::~XmlChan
virtual ~XmlChan()
Definition: XmlChan.h:65
Stream.h