lsst.pex.policy
13.0-2-g4b114ac+8
|
An abstract interface for writing policy data to streams. More...
#include <PolicyWriter.h>
Public Member Functions | |
PolicyWriter (std::ostream *out=0) | |
create a writer attached to an output stream. More... | |
PolicyWriter (const std::string &file, bool append=false) | |
create a writer attached to a file. More... | |
virtual | ~PolicyWriter () |
delete this writer More... | |
virtual void | write (const Policy &policy, bool doDecl=false) |
write the contents of a policy the attached stream. More... | |
void | close () |
close the output stream. More... | |
std::string | toString () |
return the written data as a string. More... | |
virtual void | writeBool (const std::string &name, bool value) |
write the given property out as policy data More... | |
virtual void | writeInt (const std::string &name, int value) |
write the given property out as policy data More... | |
virtual void | writeDouble (const std::string &name, double value) |
write the given property out as policy data More... | |
virtual void | writeString (const std::string &name, const std::string &value) |
write the given property out as policy data More... | |
virtual void | writePolicy (const std::string &name, const Policy &value) |
write the given property out as policy data More... | |
virtual void | writeFile (const std::string &name, const PolicyFile &value) |
write the given property out as policy data More... | |
virtual void | writeBools (const std::string &name, const Policy::BoolArray &values)=0 |
write an array of property values with a given name More... | |
virtual void | writeInts (const std::string &name, const Policy::IntArray &values)=0 |
write an array of property values with a given name More... | |
virtual void | writeDoubles (const std::string &name, const Policy::DoubleArray &values)=0 |
write an array of property values with a given name More... | |
virtual void | writeStrings (const std::string &name, const Policy::StringArray &values)=0 |
write an array of property values with a given name More... | |
virtual void | writePolicies (const std::string &name, const Policy::PolicyPtrArray &values)=0 |
write an array of property values with a given name More... | |
virtual void | writeFiles (const std::string &name, const Policy::FilePtrArray &values)=0 |
write an array of property values with a given name More... | |
Protected Attributes | |
std::ostream * | _os |
the output stream. More... | |
An abstract interface for writing policy data to streams.
Definition at line 47 of file PolicyWriter.h.
lsst::pex::policy::PolicyWriter::PolicyWriter | ( | std::ostream * | out = 0 | ) |
create a writer attached to an output stream.
If no stream is provided, it will write policy data to an internal string stream; toString() can be used to retrieve the results.
out | the output stream to write data to |
lsst::pex::policy::PolicyWriter::PolicyWriter | ( | const std::string & | file, |
bool | append = false |
||
) |
create a writer attached to a file.
This file will be immediately opened for writing.
file | the path to the output file |
append | if true, open the file to append. (default is false.) |
|
virtual |
delete this writer
void lsst::pex::policy::PolicyWriter::close | ( | ) |
close the output stream.
This has no effect if the attached stream is not a file stream.
std::string lsst::pex::policy::PolicyWriter::toString | ( | ) |
return the written data as a string.
This string will be non-empty only if this class was was instantiated without an attached stream.
|
virtual |
write the contents of a policy the attached stream.
Each top-level parameter will be recursively printed.
policy | the policy data to write |
doDecl | if true, precede the data with the appropriate file format type. |
|
virtual |
write the given property out as policy data
name | the name to save the property as. This may be a hierarchical name; however, an implementation is not guaranteed to support it. If it cannot, it should raise an exception. |
value | the value to save under that name. |
|
pure virtual |
write an array of property values with a given name
name | the name to save the values as. This may be a hierarchical name; however, an implementation is not guaranteed to support it. If it cannot, it should raise an exception. |
values | the values to save under that name. |
Implemented in lsst::pex::policy::paf::PAFWriter.
|
virtual |
write the given property out as policy data
name | the name to save the property as. This may be a hierarchical name; however, an implementation is not guaranteed to support it. If it cannot, it should raise an exception. |
value | the value to save under that name. |
|
pure virtual |
write an array of property values with a given name
name | the name to save the values as. This may be a hierarchical name; however, an implementation is not guaranteed to support it. If it cannot, it should raise an exception. |
values | the values to save under that name. |
Implemented in lsst::pex::policy::paf::PAFWriter.
|
virtual |
write the given property out as policy data
name | the name to save the property as. This may be a hierarchical name; however, an implementation is not guaranteed to support it. If it cannot, it should raise an exception. |
value | the value to save under that name. |
|
pure virtual |
write an array of property values with a given name
name | the name to save the values as. This may be a hierarchical name; however, an implementation is not guaranteed to support it. If it cannot, it should raise an exception. |
values | the values to save under that name. |
Implemented in lsst::pex::policy::paf::PAFWriter.
|
virtual |
write the given property out as policy data
name | the name to save the property as. This may be a hierarchical name; however, an implementation is not guaranteed to support it. If it cannot, it should raise an exception. |
value | the value to save under that name. |
|
pure virtual |
write an array of property values with a given name
name | the name to save the values as. This may be a hierarchical name; however, an implementation is not guaranteed to support it. If it cannot, it should raise an exception. |
values | the values to save under that name. |
Implemented in lsst::pex::policy::paf::PAFWriter.
|
pure virtual |
write an array of property values with a given name
name | the name to save the values as. This may be a hierarchical name; however, an implementation is not guaranteed to support it. If it cannot, it should raise an exception. |
values | the values to save under that name. |
Implemented in lsst::pex::policy::paf::PAFWriter.
|
virtual |
write the given property out as policy data
name | the name to save the property as. This may be a hierarchical name; however, an implementation is not guaranteed to support it. If it cannot, it should raise an exception. |
value | the value to save under that name. |
|
virtual |
write the given property out as policy data
name | the name to save the property as. This may be a hierarchical name; however, an implementation is not guaranteed to support it. If it cannot, it should raise an exception. |
value | the value to save under that name. |
|
pure virtual |
write an array of property values with a given name
name | the name to save the values as. This may be a hierarchical name; however, an implementation is not guaranteed to support it. If it cannot, it should raise an exception. |
values | the values to save under that name. |
Implemented in lsst::pex::policy::paf::PAFWriter.
|
protected |