COPASI API
4.16.103
|
#include <CReport.h>
Public Member Functions | |
const bool & | append () const |
void | cleanup () |
virtual void | close () |
virtual bool | compile (std::vector< CCopasiContainer * > listOfContainer, const CCopasiDataModel *pDataModel) |
const bool & | confirmOverwrite () const |
CReport () | |
CReport (const CReport &src) | |
virtual void | finish () |
CReportDefinition * | getReportDefinition () |
std::ostream * | getStream () const |
const std::string & | getTarget () const |
std::ostream * | open (const CCopasiDataModel *pDataModel, std::ostream *pOstream=NULL) |
virtual void | output (const Activity &activity) |
virtual void | separate (const Activity &) |
void | setAppend (const bool &append) |
void | setConfirmOverwrite (const bool &confirmOverwrite) |
void | setReportDefinition (CReportDefinition *reportDef) |
void | setTarget (const std::string &target) |
~CReport () | |
![]() | |
COutputInterface () | |
COutputInterface (const COutputInterface &src) | |
virtual const std::set< const CCopasiObject * > & | getObjects () const |
virtual | ~COutputInterface () |
Private Types | |
enum | State { Invalid = -1, Compiled = 0, HeaderHeader, HeaderBody, HeaderFooter, BodyHeader, BodyBody, BodyFooter, FooterHeader, FooterBody, FooterFooter } |
Private Member Functions | |
bool | compileChildReport (CReport *pReport, std::vector< CCopasiContainer * > listOfContainer) |
void | generateObjectsFromName (const std::vector< CCopasiContainer * > *pListOfContainer, std::vector< CCopasiObject * > &objectList, CReport *&pReport, const std::vector< CRegisteredObjectName > *nameVector) |
void | printBody () |
void | printFooter () |
void | printHeader () |
Private Attributes | |
bool | mAppend |
std::vector< CCopasiObject * > | mBodyObjectList |
bool | mConfirmOverwrite |
std::vector< CCopasiObject * > | mFooterObjectList |
std::vector< CCopasiObject * > | mHeaderObjectList |
CReport * | mpBody |
const CCopasiDataModel * | mpDataModel |
CReport * | mpFooter |
CReport * | mpHeader |
std::ostream * | mpOstream |
CReportDefinition * | mpReportDef |
State | mState |
bool | mStreamOwner |
std::string | mTarget |
Additional Inherited Members | |
![]() | |
enum | Activity { BEFORE = 0x01, DURING = 0x02, AFTER = 0x04 } |
![]() | |
std::set< const CCopasiObject * > | mObjects |
|
private |
Enumeration of the report states.
Enumerator | |
---|---|
Invalid | |
Compiled | |
HeaderHeader | |
HeaderBody | |
HeaderFooter | |
BodyHeader | |
BodyBody | |
BodyFooter | |
FooterHeader | |
FooterBody | |
FooterFooter |
Definition at line 43 of file CReport.h.
CReport::CReport | ( | ) |
Default constructor.
Definition at line 34 of file CReport.cpp.
Referenced by generateObjectsFromName().
CReport::CReport | ( | const CReport & | src | ) |
Copy constructor.
const | CReport & src |
Definition at line 52 of file CReport.cpp.
CReport::~CReport | ( | ) |
const bool & CReport::append | ( | ) | const |
Returns whether the Report Tag is appended or not
Definition at line 95 of file CReport.cpp.
References mAppend.
Referenced by CQReportDefinitionSelect::loadReportDefinitionVector(), CCopasiXML::saveTaskList(), and setAppend().
void CReport::cleanup | ( | ) |
cleanup
Definition at line 73 of file CReport.cpp.
References close(), finish(), mBodyObjectList, mFooterObjectList, and mHeaderObjectList.
Referenced by ~CReport().
|
virtual |
Close the stream if applicable
Reimplemented from COutputInterface.
Definition at line 145 of file CReport.cpp.
References mpOstream, mStreamOwner, and pdelete.
Referenced by cleanup().
|
virtual |
compile the object list from name vector
std::vector< | CCopasiContainer * > listOfContainer |
const | CCopasiDataModel* pDataModel |
Reimplemented from COutputInterface.
Definition at line 299 of file CReport.cpp.
References compileChildReport(), Compiled, generateObjectsFromName(), CReportDefinition::getBodyAddr(), CReportDefinition::getFooterAddr(), CReportDefinition::getHeaderAddr(), CReportDefinition::isTable(), mBodyObjectList, mFooterObjectList, mHeaderObjectList, COutputInterface::mObjects, mpBody, mpDataModel, mpFooter, mpHeader, mpReportDef, mState, and CReportDefinition::preCompileTable().
Referenced by compileChildReport().
|
private |
Compile the child report
CReport | * pReport |
std::vector< | CCopasiContainer * > listOfContainer |
Definition at line 429 of file CReport.cpp.
References compile(), COutputInterface::mObjects, mpDataModel, mpOstream, and open().
Referenced by compile().
const bool & CReport::confirmOverwrite | ( | ) | const |
Returns whether a confirmation should be issued when overwriting a report
Definition at line 101 of file CReport.cpp.
References mConfirmOverwrite.
Referenced by TaskWidget::commonBeforeRunTask(), CQReportDefinitionSelect::loadReportDefinitionVector(), CCopasiXML::saveTaskList(), and setConfirmOverwrite().
|
virtual |
Finish the output
Reimplemented from COutputInterface.
Definition at line 132 of file CReport.cpp.
References FooterFooter, Invalid, mpBody, mpFooter, mpHeader, mState, pdelete, and printFooter().
Referenced by cleanup().
|
private |
transfer every individual object list from name vector
Definition at line 395 of file CReport.cpp.
References C_INT32, CReport(), MCCopasiTask, COutputInterface::mObjects, mpDataModel, CCopasiDataModel::ObjectFromName(), setReportDefinition(), and CCopasiMessage::WARNING.
Referenced by compile().
CReportDefinition * CReport::getReportDefinition | ( | ) |
returns the reference of the Report Tag
Definition at line 83 of file CReport.cpp.
References mpReportDef.
Referenced by CCopasiDataModel::addDefaultReports(), CSEDMLExporter::createDataGenerators(), CQReportDefinitionSelect::loadReportDefinitionVector(), and CCopasiXML::saveTaskList().
std::ostream * CReport::getStream | ( | ) | const |
Retrieve a pointer to the ostream
Definition at line 392 of file CReport.cpp.
References mpOstream.
Referenced by CLNATask::initialize(), CScanTask::initialize(), COptProblem::initialize(), and CMCATask::initialize().
const std::string & CReport::getTarget | ( | ) | const |
returns the target of the Report Tag
Definition at line 89 of file CReport.cpp.
References mTarget.
Referenced by TaskWidget::commonBeforeRunTask(), CSEDMLExporter::createDataGenerators(), CCopasiTask::initialize(), CQReportDefinitionSelect::loadReportDefinitionVector(), and CCopasiXML::saveTaskList().
std::ostream * CReport::open | ( | const CCopasiDataModel * | pDataModel, |
std::ostream * | pOstream = NULL |
||
) |
Open the defined target stream or use the given argument
const | CCopasiDataModel * pDataModel, |
std::ostream | * pOstream (default: NULL) |
Definition at line 336 of file CReport.cpp.
References CCopasiMessage::ERROR, CDirEntry::fileName(), CLocaleString::fromUtf8(), CCopasiDataModel::getFileName(), CReportDefinition::getPrecision(), CDirEntry::isRelativePath(), CDirEntry::makePathAbsolute(), mAppend, MCDirEntry, mpDataModel, mpOstream, mpReportDef, mStreamOwner, mTarget, and pdelete.
Referenced by compileChildReport(), CScanTask::initialize(), and CCopasiTask::initialize().
Perform an output event for the current activity
const | Activity & activity |
Reimplemented from COutputInterface.
Definition at line 107 of file CReport.cpp.
References COutputInterface::AFTER, COutputInterface::BEFORE, COutputInterface::DURING, printBody(), printFooter(), and printHeader().
Referenced by CSensTask::process().
|
private |
to print body
Definition at line 196 of file CReport.cpp.
References BodyBody, BodyFooter, BodyHeader, HeaderFooter, mBodyObjectList, mpBody, mpHeader, mpOstream, mState, printBody(), printFooter(), and printHeader().
Referenced by output(), printBody(), printFooter(), and printHeader().
|
private |
to print footer
Definition at line 247 of file CReport.cpp.
References BodyFooter, FooterBody, FooterFooter, FooterHeader, mFooterObjectList, mpBody, mpFooter, mpOstream, mState, printBody(), printFooter(), and printHeader().
Referenced by finish(), output(), printBody(), printFooter(), and printHeader().
|
private |
to print header
Definition at line 153 of file CReport.cpp.
References Compiled, HeaderBody, HeaderFooter, HeaderHeader, mHeaderObjectList, mpHeader, mpOstream, mState, printBody(), printFooter(), and printHeader().
Referenced by output(), printBody(), printFooter(), and printHeader().
Introduce an additional separator into the output
const | Activity & activity |
Reimplemented from COutputInterface.
Definition at line 125 of file CReport.cpp.
References mpOstream.
void CReport::setAppend | ( | const bool & | append | ) |
sets the append attribute if the report tag
const | bool & append |
Definition at line 98 of file CReport.cpp.
References append(), and mAppend.
Referenced by CQReportDefinitionSelect::accept(), SEDMLImporter::importTasks(), CQReportDefinitionSelect::loadReportDefinitionVector(), and CCopasiXMLParser::ReportInstanceElement::start().
void CReport::setConfirmOverwrite | ( | const bool & | confirmOverwrite | ) |
sets the confirmOverwrite attribute if the report tag
const | bool & confirmOverwrite |
Definition at line 104 of file CReport.cpp.
References confirmOverwrite(), and mConfirmOverwrite.
Referenced by CQReportDefinitionSelect::accept(), SEDMLImporter::importTasks(), CQReportDefinitionSelect::loadReportDefinitionVector(), and CCopasiXMLParser::ReportInstanceElement::start().
void CReport::setReportDefinition | ( | CReportDefinition * | reportDef | ) |
sets the reference to the report
Definition at line 86 of file CReport.cpp.
References mpReportDef.
Referenced by CQReportDefinitionSelect::accept(), CCopasiDataModel::addDefaultReports(), generateObjectsFromName(), SEDMLImporter::importTasks(), CQReportDefinitionSelect::loadReportDefinitionVector(), and test000087::test_simulate_reaction_flux_reference_1().
void CReport::setTarget | ( | const std::string & | target | ) |
sets the reference to the report
const | std::string & target |
Definition at line 92 of file CReport.cpp.
References mTarget.
Referenced by CQReportDefinitionSelect::accept(), SEDMLImporter::importTasks(), CQReportDefinitionSelect::loadReportDefinitionVector(), Arguments::prepareModel(), CCopasiXMLParser::ReportInstanceElement::start(), and test000087::test_simulate_reaction_flux_reference_1().
|
private |
Definition at line 65 of file CReport.h.
Referenced by append(), open(), and setAppend().
|
private |
Definition at line 69 of file CReport.h.
Referenced by cleanup(), compile(), and printBody().
|
private |
Definition at line 66 of file CReport.h.
Referenced by confirmOverwrite(), and setConfirmOverwrite().
|
private |
Definition at line 68 of file CReport.h.
Referenced by cleanup(), compile(), and printFooter().
|
private |
Definition at line 70 of file CReport.h.
Referenced by cleanup(), compile(), and printHeader().
|
private |
Definition at line 73 of file CReport.h.
Referenced by compile(), finish(), printBody(), and printFooter().
|
private |
Definition at line 59 of file CReport.h.
Referenced by compile(), compileChildReport(), generateObjectsFromName(), and open().
|
private |
Definition at line 74 of file CReport.h.
Referenced by compile(), finish(), and printFooter().
|
private |
Definition at line 72 of file CReport.h.
Referenced by compile(), finish(), printBody(), and printHeader().
|
private |
Definition at line 60 of file CReport.h.
Referenced by close(), compileChildReport(), getStream(), open(), printBody(), printFooter(), printHeader(), and separate().
|
private |
Definition at line 63 of file CReport.h.
Referenced by compile(), getReportDefinition(), open(), and setReportDefinition().
|
private |
Definition at line 76 of file CReport.h.
Referenced by compile(), finish(), printBody(), printFooter(), and printHeader().
|
private |
|
private |
Definition at line 64 of file CReport.h.
Referenced by getTarget(), open(), and setTarget().