Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_XMLParameterListHelpers.cpp
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 
46 #include "Teuchos_CommHelpers.hpp"
47 
48 void Teuchos::updateParametersFromXmlFileAndBroadcast(
49  const std::string &xmlFileName,
50  const Ptr<ParameterList> &paramList,
51  const Comm<int> &comm,
52  bool overwrite
53  )
54 {
55  if (comm.getSize()==1)
56  updateParametersFromXmlFile(xmlFileName, paramList);
57  else {
58  if (comm.getRank()==0) {
59  XMLParameterListReader xmlPLReader;
60  xmlPLReader.setAllowsDuplicateSublists( false );
61  FileInputSource xmlFile(xmlFileName);
62  XMLObject xmlParams = xmlFile.getObject();
63  std::string xmlString = toString(xmlParams);
64  int strsize = static_cast<int>(xmlString.size());
65  broadcast<int, int>(comm, 0, &strsize);
66  broadcast<int, char>(comm, 0, strsize, &xmlString[0]);
67  updateParametersFromXmlString(xmlString, paramList,overwrite);
68  }
69  else {
70  int strsize;
71  broadcast<int, int>(comm, 0, &strsize);
72  std::string xmlString;
73  xmlString.resize(strsize);
74  broadcast<int, char>(comm, 0, strsize, &xmlString[0]);
75  updateParametersFromXmlString(xmlString, paramList,overwrite);
76  }
77  }
78 }
Writes an XML object to a parameter list.
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void updateParametersFromXmlFile(const std::string &xmlFileName, const Ptr< ParameterList > &paramList)
Reads XML parameters from a file and updates those already in the given parameter list...
std::string toString(const any &rhs)
Converts the value in any to a std::string.
Additional ParameterList XML helper functions including parallel support.
Definition of XMLInputSource derived class for reading XML from a file.
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void updateParametersFromXmlString(const std::string &xmlStr, const Ptr< ParameterList > &paramList, bool overwrite=true)
Reads XML parameters from a std::string and updates those already in the given parameter list...