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

#include <PolicyWriter.h>

Inheritance diagram for lsst::pex::policy::PolicyWriter:

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...

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

out	the 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

file	the path to the output file
append	if 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

policy	the policy data to write
doDecl	if 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

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.

◆ 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

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.

◆ writeDouble()

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

virtual

write the given property out as policy data

Parameters

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.

◆ writeDoubles()

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

pure virtual

write an array of property values with a given name

Parameters

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.

◆ writeFile()

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

virtual

write the given property out as policy data

Parameters

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.

◆ writeFiles()

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

pure virtual

write an array of property values with a given name

Parameters

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.

◆ writeInt()

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

virtual

write the given property out as policy data

Parameters

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.

◆ writeInts()

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

pure virtual

write an array of property values with a given name

Parameters

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.

◆ writePolicies()

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

pure virtual

write an array of property values with a given name

Parameters

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.

◆ writePolicy()

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

virtual

write the given property out as policy data

Parameters

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.

◆ writeString()

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

virtual

write the given property out as policy data

Parameters

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.

◆ writeStrings()

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

pure virtual

write an array of property values with a given name

Parameters

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.

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:

/j/snowflake/release/lsstsw/stack/Linux64/pex_policy/18.1.0-1-g0001055+12/include/lsst/pex/policy/PolicyWriter.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PolicyWriter() [1/2]

◆ PolicyWriter() [2/2]

◆ ~PolicyWriter()

Member Function Documentation

◆ close()

◆ toString()

◆ write()

◆ writeBool()

◆ writeBools()

◆ writeDouble()

◆ writeDoubles()

◆ writeFile()

◆ writeFiles()

◆ writeInt()

◆ writeInts()

◆ writePolicies()

◆ writePolicy()

◆ writeString()

◆ writeStrings()

Member Data Documentation

◆ _os