PRISM
 v0.0.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
prism::SpeciesSummaryWriterBase Class Referenceabstract
Inheritance diagram for prism::SpeciesSummaryWriterBase:
prism::DefaultSpeciesSummaryWriter

Public Member Functions

 SpeciesSummaryWriterBase ()
 Helper method for writing species summary for the reaction mechanism several methods of this type get called when NetworkParser::writeSpeciesSummary() gets called.
 
void clear ()
 clears the state of the writer to begin a new file
 
std::stringstream & summaryString ()
 
virtual void addMiscSummary ()=0
 Method for adding any random summaries to the top of the summary file.
 
virtual void addLumpedSummary (std::map< std::string, std::vector< std::string > > lumped_map)=0
 Method for summarizing which species have been lumped into which others.
 
virtual void addSpeciesSummary ()=0
 Method for summarizing the reactions that each species is involved in.
 

Protected Attributes

std::stringstream _summary_str
 the stream that is used to construct the summary
 

Member Function Documentation

◆ addLumpedSummary()

virtual void prism::SpeciesSummaryWriterBase::addLumpedSummary ( std::map< std::string, std::vector< std::string > > lumped_map)
pure virtual

Method for summarizing which species have been lumped into which others.

Implemented in prism::DefaultSpeciesSummaryWriter.

◆ addMiscSummary()

virtual void prism::SpeciesSummaryWriterBase::addMiscSummary ( )
pure virtual

Method for adding any random summaries to the top of the summary file.

Implemented in prism::DefaultSpeciesSummaryWriter.

◆ addSpeciesSummary()

virtual void prism::SpeciesSummaryWriterBase::addSpeciesSummary ( )
pure virtual

Method for summarizing the reactions that each species is involved in.

Implemented in prism::DefaultSpeciesSummaryWriter.


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