LSSTApplications  20.0.0
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 : std::ios_base::trunc)), _os(0) {
59  _myos->exceptions(std::ofstream::failbit | std::ofstream::badbit);
60  _os = _myos;
61 }
62 
64  if (_myos) delete _myos;
65 }
66 
67 /*
68  * return the written data as a string. This string will be non-empty
69  * only if this class was was instantiated without an attached stream.
70  */
72  std::ostringstream* ss = dynamic_cast<std::ostringstream*>(_os);
73  if (ss) return ss->str();
74  return std::string();
75 }
76 
77 /*
78  * close the output stream. This has no effect if the attached
79  * stream is not a file stream.
80  */
81 void PolicyWriter::close() {
82  std::ofstream* fs = dynamic_cast<std::ofstream*>(_os);
83  if (fs) fs->close();
84 }
85 
86 /*
87  * write the contents of a policy the attached stream. Each top-level
88  * parameter will be recursively printed.
89  * @param policy the policy data to write
90  */
91 void PolicyWriter::write(const Policy& policy, bool doDecl) {
92  if (doDecl) (*_os) << "#<?cfg paf policy ?>" << std::endl;
93 
94  Policy::StringArray names = policy.names(true);
95  Policy::StringArray::const_iterator ni;
96  for (ni = names.begin(); ni != names.end(); ++ni) {
97  try {
98  const std::type_info& tp = policy.typeOf(*ni);
99  if (tp == typeid(bool)) {
100  writeBools(*ni, policy.getBoolArray(*ni));
101  } else if (tp == typeid(int)) {
102  writeInts(*ni, policy.getIntArray(*ni));
103  } else if (tp == typeid(double)) {
104  writeDoubles(*ni, policy.getDoubleArray(*ni));
105  } else if (tp == typeid(std::string)) {
106  writeStrings(*ni, policy.getStringArray(*ni));
108  writePolicies(*ni, policy.getPolicyArray(*ni));
110  writeFiles(*ni, policy.getFileArray(*ni));
111  } else {
112  throw LSST_EXCEPT(pexExcept::LogicError, "Policy: unexpected type for name=" + *ni);
113  }
114  } catch (NameNotFound&) {
115  // shouldn't happen
116  writeString(*ni, "<missing data>");
117  }
118  }
119 }
120 
121 void PolicyWriter::writeBool(const std::string& name, bool value) {
122  std::vector<bool> vals;
123  vals.push_back(value);
124  writeBools(name, vals);
125 }
126 
127 void PolicyWriter::writeInt(const std::string& name, int value) {
128  std::vector<int> vals;
129  vals.push_back(value);
130  writeInts(name, vals);
131 }
132 
133 void PolicyWriter::writeDouble(const std::string& name, double value) {
134  std::vector<double> vals;
135  vals.push_back(value);
136  writeDoubles(name, vals);
137 }
138 
139 void PolicyWriter::writeString(const std::string& name, const std::string& value) {
141  vals.push_back(value);
142  writeStrings(name, vals);
143 }
144 
145 void PolicyWriter::writePolicy(const std::string& name, const Policy& value) {
147  vals.push_back(Policy::Ptr(new Policy(value)));
148  writePolicies(name, vals);
149 }
150 
151 void PolicyWriter::writeFile(const std::string& name, const PolicyFile& value) {
153  vals.push_back(Policy::FilePtr(new PolicyFile(value)));
154  writeFiles(name, vals);
155 }
156 
157 //@endcond
158 
159 } // namespace policy
160 } // namespace pex
161 } // namespace lsst
lsst::daf::base::PropertySet::typeOfT
static std::type_info const & typeOfT()
Get type info for the specified class.
lsst::pex::policy::PolicyWriter::writeBool
virtual void writeBool(const std::string &name, bool value)
write the given property out as policy data
lsst::pex::policy::PolicyWriter::writeInts
virtual void writeInts(const std::string &name, const Policy::IntArray &values)=0
std::string
STL class.
std::shared_ptr
STL class.
lsst::pex::policy::PolicyWriter::write
virtual void write(const Policy &policy, bool doDecl=false)
write the contents of a policy the attached stream.
std::vector
STL class.
std::type_info
lsst::pex::policy::Policy::StringArray
std::vector< std::string > StringArray
Definition: Policy.h:178
ast::append
std::shared_ptr< FrameSet > append(FrameSet const &first, FrameSet const &second)
Construct a FrameSet that performs two transformations in series.
Definition: functional.cc:33
PolicyWriter.h
the definition of the PolicyWriter class
boost::filesystem
Definition: PolicyFile.cc:47
lsst::afw::geom.transform.transformContinued.name
string name
Definition: transformContinued.py:32
lsst::pex::policy::PolicyWriter::writeFiles
virtual void writeFiles(const std::string &name, const Policy::FilePtrArray &values)=0
lsst::pex::policy::PolicyWriter::toString
std::string toString()
return the written data as a string.
pex
Definition: __init__.py:1
std::vector::push_back
T push_back(T... args)
lsst::pex::policy::PolicyWriter::PolicyWriter
PolicyWriter(std::ostream *out=0)
create a writer attached to an output stream.
Policy.h
lsst::pex::policy::Policy::Ptr
std::shared_ptr< Policy > Ptr
Definition: Policy.h:169
lsst::pex::policy::Policy::FilePtr
std::shared_ptr< PolicyFile > FilePtr
Definition: Policy.h:173
std::ostream
STL class.
std::ofstream
STL class.
lsst::pex::policy::PolicyWriter::writeString
virtual void writeString(const std::string &name, const std::string &value)
lsst::pex::exceptions::LogicError
Reports errors in the logical structure of the program.
Definition: Runtime.h:46
lsst::pex::policy::PolicyWriter::~PolicyWriter
virtual ~PolicyWriter()
delete this writer
PolicyFile.h
definition of the PolicyFile class
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
LSST_EXCEPT
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
std::ostringstream
STL class.
lsst::pex::policy::PolicyWriter::writeFile
virtual void writeFile(const std::string &name, const PolicyFile &value)
lsst::pex::policy::PolicyWriter::writePolicies
virtual void writePolicies(const std::string &name, const Policy::PolicyPtrArray &values)=0
std::endl
T endl(T... args)
lsst::pex::policy::PolicyWriter::writeStrings
virtual void writeStrings(const std::string &name, const Policy::StringArray &values)=0
lsst::pex::policy::PolicyWriter::writeBools
virtual void writeBools(const std::string &name, const Policy::BoolArray &values)=0
write an array of property values with a given name
lsst::daf::base::Persistable
Base class for all persistable classes.
Definition: Persistable.h:75
std
STL namespace.
lsst.display.ds9.ds9.file
file
Definition: ds9.py:39
lsst::daf::base::PropertySet
Class for storing generic metadata.
Definition: PropertySet.h:67
std::ostringstream::str
T str(T... args)
lsst::pex::policy::PolicyWriter::writeDoubles
virtual void writeDoubles(const std::string &name, const Policy::DoubleArray &values)=0
std::trunc
T trunc(T... args)
lsst::pex::policy::PolicyWriter::_os
std::ostream * _os
the output stream.
Definition: PolicyWriter.h:132
lsst::pex::policy::PolicyWriter::close
void close()
close the output stream.
lsst::pex::policy::PolicyWriter::writeDouble
virtual void writeDouble(const std::string &name, double value)
lsst::pex::policy::PolicyWriter::writeInt
virtual void writeInt(const std::string &name, int value)
lsst::pex::policy::PolicyWriter::writePolicy
virtual void writePolicy(const std::string &name, const Policy &value)