IntaRNA::OutputHandlerEnsemble Class Reference

#include <OutputHandlerEnsemble.h>

Inheritance diagram for IntaRNA::OutputHandlerEnsemble:

Collaboration diagram for IntaRNA::OutputHandlerEnsemble:

Public Member Functions
	OutputHandlerEnsemble (const OutputConstraint &outConstraint, std::ostream &out, const InteractionEnergy &energy)
virtual	~OutputHandlerEnsemble ()
virtual void	add (const Interaction &interaction)
Public Member Functions inherited from IntaRNA::OutputHandler
	OutputHandler (const OutputConstraint &outConstraint)
virtual	~OutputHandler ()
virtual size_t	reported () const
virtual void	incrementZ (const Z_type subZ)
virtual Z_type	getZ () const
const OutputConstraint &	getOutputConstraint () const

Protected Attributes
std::ostream &	out
	the output stream to write the ensemble information to
const InteractionEnergy &	energy
	the interaction energy handler used for the energy computations
size_t	reportedInteractions
	counter of reported interactions
Z_type	Z
	aggregated overall partition function
Protected Attributes inherited from IntaRNA::OutputHandler
const OutputConstraint	outConstraint
	the output constraints to be applied
size_t	reportedInteractions
	number of reported interactions
Z_type	Z
	overall partition function for the sequences provided in Z_energy

Additional Inherited Members
Static Public Member Functions inherited from IntaRNA::OutputHandler
static std::string	reverse (const std::string &str)

Detailed Description

Interaction output handler that writes ensemble information to stream in a simple linewise, key-value format.

Author

Martin Mann 2014

Constructor & Destructor Documentation

OutputHandlerEnsemble()

IntaRNA::OutputHandlerEnsemble::OutputHandlerEnsemble	(	const OutputConstraint &	outConstraint,
		std::ostream &	out,
		const InteractionEnergy &	energy
	)

Construct a ensemble output handler.

Parameters

outConstraint	the output constraint applied to find the reported interaction
out	the stream to write to
energy	the interaction energy object used for computation

~OutputHandlerEnsemble()

virtual IntaRNA::OutputHandlerEnsemble::~OutputHandlerEnsemble ( )

virtual

destruction, which

• prints ensemble information to stream and
• enforces a flush on the output stream.

Member Function Documentation

add()

virtual void IntaRNA::OutputHandlerEnsemble::add ( const Interaction &  interaction )

virtual

Does nothing but counts the call (no individual interactions are reported)

Parameters

interaction

the interaction to output

Implements IntaRNA::OutputHandler.

Member Data Documentation

energy

const InteractionEnergy& IntaRNA::OutputHandlerEnsemble::energy

protected

the interaction energy handler used for the energy computations

out

std::ostream& IntaRNA::OutputHandlerEnsemble::out

protected

the output stream to write the ensemble information to

reportedInteractions

size_t IntaRNA::OutputHandler::reportedInteractions

protected

counter of reported interactions

Z

Z_type IntaRNA::OutputHandler::Z

protected

aggregated overall partition function

---

The documentation for this class was generated from the following file:

• src/IntaRNA/OutputHandlerEnsemble.h