LSSTApplications  16.0-11-g09ed895+2,16.0-11-g12e47bd,16.0-11-g9bb73b2+6,16.0-12-g5c924a4+6,16.0-14-g9a974b3+1,16.0-15-g1417920+1,16.0-15-gdd5ca33+1,16.0-16-gf0259e2,16.0-17-g31abd91+7,16.0-17-g7d7456e+7,16.0-17-ga3d2e9f+13,16.0-18-ga4d4bcb+1,16.0-18-gd06566c+1,16.0-2-g0febb12+21,16.0-2-g9d5294e+69,16.0-2-ga8830df+6,16.0-20-g21842373+7,16.0-24-g3eae5ec,16.0-28-gfc9ea6c+4,16.0-29-ge8801f9,16.0-3-ge00e371+34,16.0-4-g18f3627+13,16.0-4-g5f3a788+20,16.0-4-ga3eb747+10,16.0-4-gabf74b7+29,16.0-4-gb13d127+6,16.0-49-g42e581f7+6,16.0-5-g27fb78a+7,16.0-5-g6a53317+34,16.0-5-gb3f8a4b+87,16.0-6-g9321be7+4,16.0-6-gcbc7b31+42,16.0-6-gf49912c+29,16.0-7-gd2eeba5+51,16.0-71-ge89f8615e,16.0-8-g21fd5fe+29,16.0-8-g3a9f023+20,16.0-8-g4734f7a+1,16.0-8-g5858431+3,16.0-9-gf5c1f43+8,master-gd73dc1d098+1,w.2019.01
LSSTDataManagementBasePackage
PolicyWriter.cc
Go to the documentation of this file.
1 /*
2  * LSST Data Management System
3  * Copyright 2008, 2009, 2010 LSST Corporation.
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 <http://www.lsstcorp.org/LegalNotices/>.
21  */
22 
27 #include "lsst/pex/policy/Policy.h"
29 
30 #include <fstream>
31 #include <sstream>
32 
33 namespace lsst {
34 namespace pex {
35 namespace policy {
36 
37 //@cond
40 
41 /*
42  * create a writer attached to an output stream
43  * @param out the output stream to write data to
44  */
45 PolicyWriter::PolicyWriter(std::ostream *out) : _myos(0), _os(out) {
46  if (! out) {
47  _myos = new std::ostringstream();
48  _os = _myos;
49  }
50 }
51 
52 /*
53  * create a writer attached to a file. The file will be immediately
54  * opened for writing.
55  * @param file the path to the output file
56  */
58  : _myos(new std::ofstream(file.c_str(), append ? std::ios_base::app
59  : std::ios_base::trunc)),
60  _os(0)
61 {
62  _myos->exceptions(std::ofstream::failbit | std::ofstream::badbit);
63  _os = _myos;
64 }
65 
67  if (_myos) delete _myos;
68 }
69 
70 /*
71  * return the written data as a string. This string will be non-empty
72  * only if this class was was instantiated without an attached stream.
73  */
75  std::ostringstream *ss = dynamic_cast<std::ostringstream*>(_os);
76  if (ss) return ss->str();
77  return std::string();
78 }
79 
80 /*
81  * close the output stream. This has no effect if the attached
82  * stream is not a file stream.
83  */
84 void PolicyWriter::close() {
85  std::ofstream *fs = dynamic_cast<std::ofstream*>(_os);
86  if (fs) fs->close();
87 }
88 
89 /*
90  * write the contents of a policy the attached stream. Each top-level
91  * parameter will be recursively printed.
92  * @param policy the policy data to write
93  */
94 void PolicyWriter::write(const Policy& policy, bool doDecl) {
95  if (doDecl)
96  (*_os) << "#<?cfg paf policy ?>" << std::endl;
97 
98  Policy::StringArray names = policy.names(true);
99  Policy::StringArray::const_iterator ni;
100  for(ni=names.begin(); ni != names.end(); ++ni) {
101  try {
102  const std::type_info& tp = policy.typeOf(*ni);
103  if (tp == typeid(bool)) {
104  writeBools(*ni, policy.getBoolArray(*ni));
105  }
106  else if (tp == typeid(int)) {
107  writeInts(*ni, policy.getIntArray(*ni));
108  }
109  else if (tp == typeid(double)) {
110  writeDoubles(*ni, policy.getDoubleArray(*ni));
111  }
112  else if (tp == typeid(std::string)) {
113  writeStrings(*ni, policy.getStringArray(*ni));
114  }
116  writePolicies(*ni, policy.getPolicyArray(*ni));
117  }
119  writeFiles(*ni, policy.getFileArray(*ni));
120  }
121  else {
122  throw LSST_EXCEPT(pexExcept::LogicError, "Policy: unexpected type for name=" + *ni);
123  }
124  }
125  catch (NameNotFound&) {
126  // shouldn't happen
127  writeString(*ni, "<missing data>");
128  }
129  }
130 
131 }
132 
133 void PolicyWriter::writeBool(const std::string& name, bool value) {
134  std::vector<bool> vals;
135  vals.push_back(value);
136  writeBools(name, vals);
137 }
138 
139 void PolicyWriter::writeInt(const std::string& name, int value) {
140  std::vector<int> vals;
141  vals.push_back(value);
142  writeInts(name, vals);
143 }
144 
145 void PolicyWriter::writeDouble(const std::string& name, double value) {
146  std::vector<double> vals;
147  vals.push_back(value);
148  writeDoubles(name, vals);
149 }
150 
151 void PolicyWriter::writeString(const std::string& name,
152  const std::string& value)
153 {
155  vals.push_back(value);
156  writeStrings(name, vals);
157 }
158 
159 void PolicyWriter::writePolicy(const std::string& name, const Policy& value) {
161  vals.push_back(Policy::Ptr(new Policy(value)));
162  writePolicies(name, vals);
163 }
164 
165 void PolicyWriter::writeFile(const std::string& name,
166  const PolicyFile& value)
167 {
169  vals.push_back(Policy::FilePtr(new PolicyFile(value)));
170  writeFiles(name, vals);
171 }
172 
173 
174 //@endcond
175 
176 }}} // end lsst::pex::policy
static std::type_info const & typeOfT()
Get type info for the specified class.
virtual void write(const Policy &policy, bool doDecl=false)
write the contents of a policy the attached stream.
definition of the PolicyFile class
T trunc(T... args)
std::vector< std::string > StringArray
Definition: Policy.h:181
virtual void writeBool(const std::string &name, bool value)
write the given property out as policy data
the definition of the PolicyWriter class
virtual void writeDouble(const std::string &name, double value)
write the given property out as policy data
T endl(T... args)
STL namespace.
std::shared_ptr< FrameSet > append(FrameSet const &first, FrameSet const &second)
Construct a FrameSet that performs two transformations in series.
Definition: functional.cc:33
std::shared_ptr< PolicyFile > FilePtr
Definition: Policy.h:176
std::string toString()
return the written data as a string.
STL class.
T push_back(T... args)
STL class.
A base class for image defects.
Definition: cameraGeom.dox:3
T close(T... args)
virtual void writeString(const std::string &name, const std::string &value)
write the given property out as policy data
std::shared_ptr< Policy > Ptr
Definition: Policy.h:172
T str(T... args)
Reports errors in the logical structure of the program.
Definition: Runtime.h:46
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
STL class.
PolicyWriter(std::ostream *out=0)
create a writer attached to an output stream.
virtual ~PolicyWriter()
delete this writer
Class for storing generic metadata.
Definition: PropertySet.h:68
Base class for all persistable classes.
Definition: Persistable.h:75
void close()
close the output stream.
STL class.
virtual void writePolicy(const std::string &name, const Policy &value)
write the given property out as policy data
virtual void writeInt(const std::string &name, int value)
write the given property out as policy data
virtual void writeFile(const std::string &name, const PolicyFile &value)
write the given property out as policy data