Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Teuchos_XMLObjectImplem.hpp
Go to the documentation of this file.
1// @HEADER
2// ***********************************************************************
3//
4// Teuchos: Common Tools Package
5// Copyright (2004) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38//
39// ***********************************************************************
40// @HEADER
41
42#ifndef TEUCHOS_XMLOBJECTIMPLEM_H
43#define TEUCHOS_XMLOBJECTIMPLEM_H
44
49#include "Teuchos_map.hpp"
50#include "Teuchos_Array.hpp"
51#include "Teuchos_RCP.hpp"
52
53namespace Teuchos
54{
55
56class XMLObject;
57
63{
65
66public:
68 XMLObjectImplem(const std::string& tag);
69
71 XMLObjectImplem* deepCopy() const ;
72
74 void addAttribute(const std::string& name, const std::string& value);
75
77 void addChild(const XMLObject& child);
78
80 void addContent(const std::string& contentLine);
81
83 const std::string& getTag() const {return tag_;}
84
86 bool hasAttribute(const std::string& name) const
87 {return attributes_.find(name) != attributes_.end();}
88
90 const std::string& getAttribute(const std::string& name) const
91 {return (*(attributes_.find(name))).second;}
92
94 int numChildren() const ;
95
97 const XMLObject& getChild(int i) const ;
98
100 int numContentLines() const {return content_.length();}
101
103 const Map& getAttributes() const {return attributes_;}
104
106 const std::string& getContentLine(int i) const {return content_[i];}
107
109 void appendContentLine(const size_t& i, const std::string &str) {
110 content_[i].append(str);
111 }
112
114 void removeContentLine(const size_t& i);
115
117 void print(std::ostream& os, int indent) const ;
118
120 std::string toString() const ;
121
123 std::string header(bool strictXML = false) const ;
124
126 std::string terminatedHeader(bool strictXML = false) const ;
127
129 std::string footer() const {return "</" + getTag() + ">";}
130
131private:
132
134 void printContent(std::ostream& os, int indent) const ;
135
137 static std::string XMLifyAttVal(const std::string &attval);
138
139 std::string tag_;
143
144};
145
146}
147
148#endif
149
Templated array class derived from the STL std::vector.
#define TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
Reference-counted pointer class and non-member templated function implementations.
Provides std::map class for deficient platforms.
Concrete serial communicator subclass.
The XMLObjectImplem class takes care of the low-level implementation details of XMLObject.
const std::string & getAttribute(const std::string &name) const
Look up an attribute by name.
Teuchos::map< std::string, std::string > Map
const std::string & getTag() const
Return the tag std::string.
const Map & getAttributes() const
Get all attributes.
int numContentLines() const
Get the number of content lines.
bool hasAttribute(const std::string &name) const
Determine whether an attribute exists.
const std::string & getContentLine(int i) const
Look up a content line by index.
void appendContentLine(const size_t &i, const std::string &str)
Add string at the the end of a content line.
std::string footer() const
Write the footer.
Representation of an XML data tree. XMLObject is a ref-counted handle to a XMLObjectImplem object,...
std::string toString(const HashSet< Key > &h)