wns::probe::bus::detail::OutputFormatter Class Reference

abstract Base class for all output formatters More...

#include <probe/bus/detail/OutputFormatter.hpp>

Inheritance diagram for wns::probe::bus::detail::OutputFormatter:

[legend]

Collaboration diagram for wns::probe::bus::detail::OutputFormatter:

[legend]

List of all members.

Public Member Functions
virtual std::string	getFilenameSuffix () const
	returns the filename suffix, empty by default
virtual std::string	getPrefix () const
	returns the comment prefix, empty by default
	OutputFormatter (const StatEvalTable &table)
	Constructor, has to be initialized with the data the Formatter should work upon.
virtual void	print (std::ostream &strm, std::string valueType) const
	invokes printing the formatted output into the given stream object
virtual	~OutputFormatter ()
Protected Member Functions
const std::vector< Sorter > &	sorters () const
	provides deriving classes access to the sorter objects of the StatEvalTable, which is needed for walking the tree and for formatting
Protected Attributes
const StatEvalTable &	data
	Reference to the table containing the data.
Private Member Functions
virtual void	doPrint (std::ostream &strm, std::list< int > fixedIndices, int dim, std::string valueType) const =0
	Implement this to control the formatting.

---

Detailed Description

through an appropriate implementation of the abstract method "print" you can define how the output of a StatEvalTable shall look like.

Definition at line 70 of file OutputFormatter.hpp.

---

Constructor & Destructor Documentation

wns::probe::bus::detail::OutputFormatter::OutputFormatter

(

const StatEvalTable &

table

)

[inline]

Definition at line 100 of file OutputFormatter.hpp.

virtual wns::probe::bus::detail::OutputFormatter::~OutputFormatter

(

)

[inline, virtual]

Definition at line 105 of file OutputFormatter.hpp.

---

Member Function Documentation

virtual void wns::probe::bus::detail::OutputFormatter::doPrint	(	std::ostream &	strm,
		std::list< int >	fixedIndices,
		int	dim,
		std::string	valueType
	)			const [private, pure virtual]

This method is meant to recursively walk over the tree structure of the DynamicMatrix

Implemented in wns::probe::bus::detail::HumanReadable, wns::probe::bus::detail::PythonReadable, wns::probe::bus::detail::MatlabReadable, wns::probe::bus::detail::MatlabReadableSparse, and wns::probe::bus::detail::LogEvalReadable.

virtual std::string wns::probe::bus::detail::OutputFormatter::getFilenameSuffix

(

)

const [inline, virtual]

Reimplemented in wns::probe::bus::detail::PythonReadable, wns::probe::bus::detail::MatlabReadable, wns::probe::bus::detail::LogEvalReadable, and wns::probe::bus::detail::Plain.

Definition at line 123 of file OutputFormatter.hpp.

virtual std::string wns::probe::bus::detail::OutputFormatter::getPrefix

(

)

const [inline, virtual]

Reimplemented in wns::probe::bus::detail::PythonReadable, wns::probe::bus::detail::MatlabReadable, and wns::probe::bus::detail::LogEvalReadable.

Definition at line 117 of file OutputFormatter.hpp.

void OutputFormatter::print	(	std::ostream &	strm,
		std::string	valueType
	)			const [virtual]

Reimplemented in wns::probe::bus::detail::PythonReadable, and wns::probe::bus::detail::MatlabReadable.

Definition at line 46 of file OutputFormatter.cpp.

const std::vector<Sorter>& wns::probe::bus::detail::OutputFormatter::sorters

(

)

const [inline, protected]

Definition at line 91 of file OutputFormatter.hpp.

---

Member Data Documentation

const StatEvalTable& wns::probe::bus::detail::OutputFormatter::data [protected]

Definition at line 84 of file OutputFormatter.hpp.

---

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

• framework/library/src/probe/bus/detail/OutputFormatter.hpp
• framework/library/src/probe/bus/detail/OutputFormatter.cpp