LSSTApplications  17.0+124,17.0+14,17.0+73,18.0.0+37,18.0.0+80,18.0.0-4-g68ffd23+4,18.1.0-1-g0001055+12,18.1.0-1-g03d53ef+5,18.1.0-1-g1349e88+55,18.1.0-1-g2505f39+44,18.1.0-1-g5315e5e+4,18.1.0-1-g5e4b7ea+14,18.1.0-1-g7e8fceb+4,18.1.0-1-g85f8cd4+48,18.1.0-1-g8ff0b9f+4,18.1.0-1-ga2c679d+1,18.1.0-1-gd55f500+35,18.1.0-10-gb58edde+2,18.1.0-11-g0997b02+4,18.1.0-13-gfe4edf0b+12,18.1.0-14-g259bd21+21,18.1.0-19-gdb69f3f+2,18.1.0-2-g5f9922c+24,18.1.0-2-gd3b74e5+11,18.1.0-2-gfbf3545+32,18.1.0-26-g728bddb4+5,18.1.0-27-g6ff7ca9+2,18.1.0-3-g52aa583+25,18.1.0-3-g8ea57af+9,18.1.0-3-gb69f684+42,18.1.0-3-gfcaddf3+6,18.1.0-32-gd8786685a,18.1.0-4-gf3f9b77+6,18.1.0-5-g1dd662b+2,18.1.0-5-g6dbcb01+41,18.1.0-6-gae77429+3,18.1.0-7-g9d75d83+9,18.1.0-7-gae09a6d+30,18.1.0-9-gc381ef5+4,w.2019.45
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:
55  PolicyWriter(std::ostream* out = 0);
56 
63  PolicyWriter(const std::string& file, bool append = false);
64 
68  virtual ~PolicyWriter();
69 
77  virtual void write(const Policy& policy, bool doDecl = false);
78 
80 
88  virtual void writeBool(const std::string& name, bool value);
89  virtual void writeInt(const std::string& name, int value);
90  virtual void writeDouble(const std::string& name, double value);
91  virtual void writeString(const std::string& name, const std::string& value);
92  virtual void writePolicy(const std::string& name, const Policy& value);
93  virtual void writeFile(const std::string& name, const PolicyFile& value);
95 
97 
105  virtual void writeBools(const std::string& name, const Policy::BoolArray& values) = 0;
106  virtual void writeInts(const std::string& name, const Policy::IntArray& values) = 0;
107  virtual void writeDoubles(const std::string& name, const Policy::DoubleArray& values) = 0;
108  virtual void writeStrings(const std::string& name, const Policy::StringArray& values) = 0;
109  virtual void writePolicies(const std::string& name, const Policy::PolicyPtrArray& values) = 0;
110  virtual void writeFiles(const std::string& name, const Policy::FilePtrArray& values) = 0;
112 
117  void close();
118 
124 
125 private:
126  std::ostream* _myos;
127 
128 protected:
133 };
134 
135 } // namespace policy
136 } // namespace pex
137 } // namespace lsst
138 
139 #endif // LSST_PEX_POLICY_POLICYWRITER_H
virtual void writeBool(const std::string &name, bool value)
write the given property out as policy data
std::string toString()
return the written data as a string.
virtual void writeInts(const std::string &name, const Policy::IntArray &values)=0
write an array of property values with a given name
virtual ~PolicyWriter()
delete this writer
void close()
close the output stream.
a container for holding hierarchical configuration data in memory.
Definition: Policy.h:167
virtual void writeFiles(const std::string &name, const Policy::FilePtrArray &values)=0
write an array of property values with a given name
std::shared_ptr< FrameSet > append(FrameSet const &first, FrameSet const &second)
Construct a FrameSet that performs two transformations in series.
Definition: functional.cc:33
virtual void write(const Policy &policy, bool doDecl=false)
write the contents of a policy the attached stream.
STL class.
An abstract interface for writing policy data to streams.
Definition: PolicyWriter.h:47
virtual void writeBools(const std::string &name, const Policy::BoolArray &values)=0
write an array of property values with a given name
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 writeFile(const std::string &name, const PolicyFile &value)
write the given property out as policy data
std::ostream * _os
the output stream.
Definition: PolicyWriter.h:132
virtual void writeString(const std::string &name, const std::string &value)
write the given property out as policy data
virtual void writeStrings(const std::string &name, const Policy::StringArray &values)=0
write an array of property values with a given name
virtual void writeDouble(const std::string &name, double 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
Definition: __init__.py:1
STL class.
virtual void writePolicy(const std::string &name, const Policy &value)
write the given property out as policy data
a representation of a file containing Policy parameter data.
Definition: PolicyFile.h:58
PolicyWriter(std::ostream *out=0)
create a writer attached to an output stream.
STL class.
virtual void writePolicies(const std::string &name, const Policy::PolicyPtrArray &values)=0
write an array of property values with a given name