LSSTApplications  19.0.0-14-gb0260a2+d60062ef16,20.0.0+1540ce6389,20.0.0+7c6b12c2f9,20.0.0+ae956f52c5,20.0.0+be870186d9,20.0.0+e2e26847c2,20.0.0-1-g10df615+7683e4f082,20.0.0-1-g253301a+7c6b12c2f9,20.0.0-1-g2b7511a+46a6078777,20.0.0-1-g3dda6ea+606b36f8c0,20.0.0-1-g4d801e7+901ee84527,20.0.0-1-g5b95a8c+a5fa15ec54,20.0.0-1-gb058bd0+46a6078777,20.0.0-1-gb88604f+acecce4127,20.0.0-1-gc96f8cb+61a4a056b1,20.0.0-1-gedffbd8+4f0e391d5e,20.0.0-10-g0891cd99+aadc987f3e,20.0.0-10-g9a20bd332+576ca7b471,20.0.0-17-gcdbda88+ed0d4927ab,20.0.0-2-g4dae9ad+61a4a056b1,20.0.0-2-g61b8584+85c46248f3,20.0.0-2-gb780d76+f45b7d88f4,20.0.0-2-gf072044+7c6b12c2f9,20.0.0-21-g9bbb7f7+61a4a056b1,20.0.0-22-gc512666+9eba1c4719,20.0.0-23-g8900aa8+68630f7098,20.0.0-3-g1653f94+85c46248f3,20.0.0-3-g4cc78c6+63636aeed8,20.0.0-3-g750bffe+e05f822de9,20.0.0-3-gbd60e8c+ff10c6d78d,20.0.0-32-g15a0e07c+ff1c9f120b,20.0.0-4-g97dc21a+68630f7098,20.0.0-4-gfea843c+f45b7d88f4,20.0.0-5-g357b56b+f45b7d88f4,20.0.0-6-g9a5b7a1+2c4171520d,20.0.0-61-g4de25fb+e4dd172200,20.0.0-7-gcda7bf1+85e953d7e4,w.2020.43
LSSTDataManagementBasePackage
Public Member Functions | Protected Attributes | List of all members
lsst.pex::policy::PolicyWriter Class Referenceabstract

An abstract interface for writing policy data to streams. More...

#include <PolicyWriter.h>

Inheritance diagram for lsst.pex::policy::PolicyWriter:
lsst.pex::policy::paf::PAFWriter

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...
 
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)
 
virtual void writeDouble (const std::string &name, double value)
 
virtual void writeString (const std::string &name, const std::string &value)
 
virtual void writePolicy (const std::string &name, const Policy &value)
 
virtual void writeFile (const std::string &name, const PolicyFile &value)
 
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
 
virtual void writeDoubles (const std::string &name, const Policy::DoubleArray &values)=0
 
virtual void writeStrings (const std::string &name, const Policy::StringArray &values)=0
 
virtual void writePolicies (const std::string &name, const Policy::PolicyPtrArray &values)=0
 
virtual void writeFiles (const std::string &name, const Policy::FilePtrArray &values)=0
 
void close ()
 close the output stream. More...
 
std::string toString ()
 return the written data as a string. More...
 

Protected Attributes

std::ostream * _os
 the output stream. More...
 

Detailed Description

An abstract interface for writing policy data to streams.

Definition at line 47 of file PolicyWriter.h.

Constructor & Destructor Documentation

◆ PolicyWriter() [1/2]

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.

Parameters
outthe output stream to write data to

◆ PolicyWriter() [2/2]

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.

Parameters
filethe path to the output file
appendif true, open the file to append. (default is false.)

◆ ~PolicyWriter()

virtual lsst.pex::policy::PolicyWriter::~PolicyWriter ( )
virtual

delete this writer

Member Function Documentation

◆ close()

void lsst.pex::policy::PolicyWriter::close ( )

close the output stream.

This has no effect if the attached stream is not a file stream.

◆ toString()

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.

◆ write()

virtual void lsst.pex::policy::PolicyWriter::write ( const Policy &  policy,
bool  doDecl = false 
)
virtual

write the contents of a policy the attached stream.

Each top-level parameter will be recursively printed.

Parameters
policythe policy data to write
doDeclif true, precede the data with the appropriate file format type.

◆ writeBool()

virtual void lsst.pex::policy::PolicyWriter::writeBool ( const std::string &  name,
bool  value 
)
virtual

write the given property out as policy data

Parameters
namethe 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.
valuethe value to save under that name.

◆ writeBools()

virtual void lsst.pex::policy::PolicyWriter::writeBools ( const std::string &  name,
const Policy::BoolArray &  values 
)
pure virtual

write an array of property values with a given name

Parameters
namethe 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.
valuesthe values to save under that name.

Implemented in lsst.pex::policy::paf::PAFWriter.

◆ writeDouble()

virtual void lsst.pex::policy::PolicyWriter::writeDouble ( const std::string &  name,
double  value 
)
virtual

◆ writeDoubles()

virtual void lsst.pex::policy::PolicyWriter::writeDoubles ( const std::string &  name,
const Policy::DoubleArray &  values 
)
pure virtual

Implemented in lsst.pex::policy::paf::PAFWriter.

◆ writeFile()

virtual void lsst.pex::policy::PolicyWriter::writeFile ( const std::string &  name,
const PolicyFile &  value 
)
virtual

◆ writeFiles()

virtual void lsst.pex::policy::PolicyWriter::writeFiles ( const std::string &  name,
const Policy::FilePtrArray &  values 
)
pure virtual

Implemented in lsst.pex::policy::paf::PAFWriter.

◆ writeInt()

virtual void lsst.pex::policy::PolicyWriter::writeInt ( const std::string &  name,
int  value 
)
virtual

◆ writeInts()

virtual void lsst.pex::policy::PolicyWriter::writeInts ( const std::string &  name,
const Policy::IntArray &  values 
)
pure virtual

Implemented in lsst.pex::policy::paf::PAFWriter.

◆ writePolicies()

virtual void lsst.pex::policy::PolicyWriter::writePolicies ( const std::string &  name,
const Policy::PolicyPtrArray &  values 
)
pure virtual

Implemented in lsst.pex::policy::paf::PAFWriter.

◆ writePolicy()

virtual void lsst.pex::policy::PolicyWriter::writePolicy ( const std::string &  name,
const Policy &  value 
)
virtual

◆ writeString()

virtual void lsst.pex::policy::PolicyWriter::writeString ( const std::string &  name,
const std::string &  value 
)
virtual

◆ writeStrings()

virtual void lsst.pex::policy::PolicyWriter::writeStrings ( const std::string &  name,
const Policy::StringArray &  values 
)
pure virtual

Implemented in lsst.pex::policy::paf::PAFWriter.

Member Data Documentation

◆ _os

std::ostream* lsst.pex::policy::PolicyWriter::_os
protected

the output stream.

This should always be non-null.

Definition at line 132 of file PolicyWriter.h.

The documentation for this class was generated from the following file:
Generated on Wed Oct 28 2020 07:51:48 for LSSTApplications by   doxygen 1.8.18