Inheritance diagram for prism::TableWriterBase:

Public Member Functions
	TableWriterBase (unsigned int max_rows=32)
	Helper for generating a latex table based on the 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::stringstream &	tableString ()
	Getter method for the stream to actually write the summary to file.

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

virtual void	endDocument ()=0
	Adds the end of the document.

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

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

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

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

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

virtual void	endTabulatedTable ()=0
	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)=0
	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)=0
	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)=0
	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.

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::stringstream	_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

Constructor & Destructor Documentation

◆ TableWriterBase()

prism::TableWriterBase::TableWriterBase ( unsigned int max_rows = 32 )

inline

Helper for generating a latex table based on the reaction mechanism.

Parameters

max_rows the maximum number of reactions that are allowed in a table if this number is exceeded a new table is started

Member Function Documentation

◆ addFunctionalReaction()

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

pure virtual

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

Implemented in prism::DefaultTableWriter.

◆ addNotes()

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

pure virtual

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.

Implemented in prism::DefaultTableWriter.