Inheritance diagram for prism::DefaultTableWriter:

Public Member Functions
virtual void	beginDocument (const std::vector< std::string > &bib_files) override
	Adds the document preamble to start of the latex doc.

virtual void	endDocument () override
	Adds the end of the document.

void	beginTable ()

void	endTable ()

virtual void	beginRateBasedSection () override
	Adds a section header before the rate based reactions are put in the table.

virtual void	beginXSecBasedSection () override
	Adds a section header before the cross section based reactions are put in the table.

virtual void	beginFunctionalTable () override
	Adds the beginning of the table for reactions which have functional data.

virtual void	endFunctionalTable () override
	Adds the end of the table for reactions which have functional data.

virtual void	beginTabulatedTable () override
	Adds the beginning of the table for reactions which have data that is collected from a file.

virtual void	endTabulatedTable () override
	Adds the end of the table for reactions which have data that is collected from a file.

virtual void	addFunctionalReaction (const std::shared_ptr< const Reaction > &r) override
	Specification for how to format a row for a single reaction which has data that can be sampled via a function.

virtual void	addTabulatedReaction (const std::shared_ptr< const Reaction > &r) override
	Specification for how to format a row for a single reaction which has data that is collected from a file.

virtual void	addNotes (const std::vector< std::string > &notes) override
	Method for adding notes to the end of a single reaction additionally this method should be used to help store all of the unique notes that exist in a reaction mechanism.

void	clear ()
	clears the state of the writer before a new writing

unsigned int	maxRows ()
	Getter method for the maximum number of reactions allowed in a single table.

std::ostringstream &	tableString ()
	Getter method for the stream to actually write the summary to file.

Protected Attributes
const unsigned int	_max_rows_per_table
	the maximum number of reactions allowed per table

unsigned int	_rxn_count
	a counter for reactions in the network

unsigned int	_note_count
	a counter for all of the notes that have been added to the table

std::ostringstream	_table_str
	the string stream that is used to created the summary


std::map< std::string, unsigned int >	_note_numbers
	helper mappings between notes and their corrisponding numbering

std::map< unsigned int, std::string >	_inverse_note_numbers

Member Function Documentation

◆ addFunctionalReaction()

void prism::DefaultTableWriter::addFunctionalReaction ( const std::shared_ptr< const Reaction > & r )

overridevirtual

Specification for how to format a row for a single reaction which has data that can be sampled via a function.

Implements prism::TableWriterBase.

◆ addNotes()

void prism::DefaultTableWriter::addNotes ( const std::vector< std::string > & notes )

overridevirtual

Method for adding notes to the end of a single reaction additionally this method should be used to help store all of the unique notes that exist in a reaction mechanism.

Implements prism::TableWriterBase.