LSSTApplications  20.0.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:
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
lsst::pex::policy::PolicyWriter
An abstract interface for writing policy data to streams.
Definition: PolicyWriter.h:47
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.
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.
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
lsst::pex::policy::Policy
a container for holding hierarchical configuration data in memory.
Definition: Policy.h:167
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
lsst::pex::policy::PolicyWriter::PolicyWriter
PolicyWriter(std::ostream *out=0)
create a writer attached to an output stream.
Policy.h
std::ostream
STL class.
lsst::pex::policy::PolicyWriter::writeString
virtual void writeString(const std::string &name, const std::string &value)
lsst::pex::policy::PolicyWriter::~PolicyWriter
virtual ~PolicyWriter()
delete this writer
lsst::pex::policy::PolicyWriter::PolicyWriter
PolicyWriter(const std::string &file, bool append=false)
create a writer attached to a file.
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
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
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.display.ds9.ds9.file
file
Definition: ds9.py:39
lsst::pex::policy::PolicyFile
a representation of a file containing Policy parameter data.
Definition: PolicyFile.h:58
lsst::pex::policy::PolicyWriter::writeDoubles
virtual void writeDoubles(const std::string &name, const Policy::DoubleArray &values)=0
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)