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

#include <PAFWriter.h>

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

Public Member Functions
	PAFWriter (std::ostream *out=0)
	create a writer attached to an output stream More...

	PAFWriter (std::ostream *out, const std::string indent)
	create a writer attached to an output stream More...

	PAFWriter (const std::string &file)
	create a writer attached to an output file More...

	PAFWriter (const char *file)

virtual	~PAFWriter ()
	delete this writer More...

virtual void	writeBools (const std::string &name, const Policy::BoolArray &values)
	write an array of property values with a given name More...

virtual void	writeInts (const std::string &name, const Policy::IntArray &values)

virtual void	writeDoubles (const std::string &name, const Policy::DoubleArray &values)

virtual void	writeStrings (const std::string &name, const Policy::StringArray &values)

virtual void	writePolicies (const std::string &name, const Policy::PolicyPtrArray &values)

virtual void	writeFiles (const std::string &name, const Policy::FilePtrArray &values)

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)

void	close ()
	close the output stream. More...

std::string	toString ()
	return the written data as a string. More...

Protected Attributes
std::string	_indent
	the indentation string More...

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

Detailed Description

An abstract interface for writing policy data to streams.

Definition at line 44 of file PAFWriter.h.

Constructor & Destructor Documentation

◆ PAFWriter() [1/4]

lsst.pex::policy::paf::PAFWriter::PAFWriter ( std::ostream * out = 0 )

inlineexplicit

create a writer attached to an output stream

Parameters

out	the output stream to write data to

Definition at line 51 of file PAFWriter.h.

52 : PolicyWriter(out), _indent() { }

◆ PAFWriter() [2/4]

lsst.pex::policy::paf::PAFWriter::PAFWriter	(	std::ostream *	out,
		const std::string	indent
	)

inline

create a writer attached to an output stream

Parameters

out	the output stream to write data to
indent	a string (of spaces) to used as indentation for each line printed out.

Definition at line 60 of file PAFWriter.h.

61 : PolicyWriter(out), _indent(indent)

62 { }

◆ PAFWriter() [3/4]

lsst.pex::policy::paf::PAFWriter::PAFWriter ( const std::string & file )

inlineexplicit

create a writer attached to an output file

Parameters

file	the output file

Definition at line 69 of file PAFWriter.h.

70 : PolicyWriter(file), _indent() { }

◆ PAFWriter() [4/4]

lsst.pex::policy::paf::PAFWriter::PAFWriter ( const char * file )

inlineexplicit

Definition at line 71 of file PAFWriter.h.

72 : PolicyWriter(file), _indent() { }

◆ ~PAFWriter()

virtual lsst.pex::policy::paf::PAFWriter::~PAFWriter ( )

virtual

delete this writer

Member Function Documentation

◆ close()

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

inherited

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 ( )

inherited

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`
	)

virtualinherited

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
	)

virtualinherited

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::paf::PAFWriter::writeBools	(	const std::string &	name,
		const Policy::BoolArray &	values
	)

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.

Implements lsst.pex::policy::PolicyWriter.

◆ writeDouble()

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

virtualinherited

◆ writeDoubles()

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

virtual

Implements lsst.pex::policy::PolicyWriter.

◆ writeFile()

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

virtualinherited

◆ writeFiles()

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

virtual

Implements lsst.pex::policy::PolicyWriter.

◆ writeInt()

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

virtualinherited

◆ writeInts()

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

virtual

Implements lsst.pex::policy::PolicyWriter.

◆ writePolicies()

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

virtual

Implements lsst.pex::policy::PolicyWriter.

◆ writePolicy()

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

virtualinherited

◆ writeString()

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

virtualinherited

◆ writeStrings()

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

virtual

Implements lsst.pex::policy::PolicyWriter.

Member Data Documentation

◆ _indent

std::string lsst.pex::policy::paf::PAFWriter::_indent

protected

the indentation string

Definition at line 108 of file PAFWriter.h.

◆ _os

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

protectedinherited

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/cb4e2dc/Linux64/pex_policy/20.0.0-1-gb058bd0+46a6078777/include/lsst/pex/policy/paf/PAFWriter.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PAFWriter() [1/4]

◆ PAFWriter() [2/4]

◆ PAFWriter() [3/4]

◆ PAFWriter() [4/4]

◆ ~PAFWriter()

Member Function Documentation

◆ close()

◆ toString()

◆ write()

◆ writeBool()

◆ writeBools()

◆ writeDouble()

◆ writeDoubles()

◆ writeFile()

◆ writeFiles()

◆ writeInt()

◆ writeInts()

◆ writePolicies()

◆ writePolicy()

◆ writeString()

◆ writeStrings()

Member Data Documentation

◆ _indent

◆ _os