LSSTApplications  18.1.0
LSSTDataManagementBasePackage
PolicyWriter.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 
3 /*
4  * LSST Data Management System
5  * Copyright 2008, 2009, 2010 LSST Corporation.
6  *
7  * This product includes software developed by the
8  * LSST Project (http://www.lsst.org/).
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the LSST License Statement and
21  * the GNU General Public License along with this program. If not,
22  * see <http://www.lsstcorp.org/LegalNotices/>.
23  */
24 
32 #ifndef LSST_PEX_POLICY_POLICYWRITER_H
33 #define LSST_PEX_POLICY_POLICYWRITER_H
34 
35 #include "lsst/pex/policy/Policy.h"
36 #include <ostream>
37 
38 #define NULL_FILENAME "/dev/null"
39 
40 namespace lsst {
41 namespace pex {
42 namespace policy {
43 
47 class PolicyWriter {
48 public:
49 
56  PolicyWriter(std::ostream *out = 0);
57 
64  PolicyWriter(const std::string& file, bool append=false);
65 
69  virtual ~PolicyWriter();
70 
78  virtual void write(const Policy& policy, bool doDecl=false);
79 
81 
89  virtual void writeBool(const std::string& name, bool value);
90  virtual void writeInt(const std::string& name, int value);
91  virtual void writeDouble(const std::string& name, double value);
92  virtual void writeString(const std::string& name,
93  const std::string& value);
94  virtual void writePolicy(const std::string& name, const Policy& value);
95  virtual void writeFile(const std::string& name, const PolicyFile& value);
97 
99 
107  virtual void writeBools(const std::string& name,
108  const Policy::BoolArray& values) = 0;
109  virtual void writeInts(const std::string& name,
110  const Policy::IntArray& values) = 0;
111  virtual void writeDoubles(const std::string& name,
112  const Policy::DoubleArray& values) = 0;
113  virtual void writeStrings(const std::string& name,
114  const Policy::StringArray& values) = 0;
115  virtual void writePolicies(const std::string& name,
116  const Policy::PolicyPtrArray& values) = 0;
117  virtual void writeFiles(const std::string& name,
118  const Policy::FilePtrArray& values) = 0;
120 
125  void close();
126 
132 
133 
134 private:
135  std::ostream *_myos;
136 protected:
137 
142 };
143 
144 
145 
146 
147 }}} // end namespace lsst::pex::policy
148 
149 #endif // LSST_PEX_POLICY_POLICYWRITER_H
150 
virtual void write(const Policy &policy, bool doDecl=false)
write the contents of a policy the attached stream.
a container for holding hierarchical configuration data in memory.
Definition: Policy.h:169
virtual void writeBool(const std::string &name, bool value)
write the given property out as policy data
virtual void writeDouble(const std::string &name, double value)
write the given property out as policy data
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::string toString()
return the written data as a string.
STL class.
virtual void writeFiles(const std::string &name, const Policy::FilePtrArray &values)=0
write an array of property values with a given name
std::ostream * _os
the output stream.
Definition: PolicyWriter.h:141
An abstract interface for writing policy data to streams.
Definition: PolicyWriter.h:47
virtual void writeDoubles(const std::string &name, const Policy::DoubleArray &values)=0
write an array of property values with a given name
A base class for image defects.
virtual void writeStrings(const std::string &name, const Policy::StringArray &values)=0
write an array of property values with a given name
virtual void writeString(const std::string &name, const std::string &value)
write the given property out as policy data
virtual void writePolicies(const std::string &name, const Policy::PolicyPtrArray &values)=0
write an array of property values with a given name
STL class.
PolicyWriter(std::ostream *out=0)
create a writer attached to an output stream.
virtual ~PolicyWriter()
delete this writer
void close()
close the output stream.
virtual void writeBools(const std::string &name, const Policy::BoolArray &values)=0
write an array of property values with a given name
a representation of a file containing Policy parameter data.
Definition: PolicyFile.h:58
STL class.
virtual void writeInts(const std::string &name, const Policy::IntArray &values)=0
write an array of property values with a given name
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