CReport Class Reference

#include <CReport.h>

Inheritance diagram for CReport:

Collaboration diagram for CReport:

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 ()
Public Member Functions inherited from COutputInterface
	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
Public Types inherited from COutputInterface
enum	Activity { BEFORE = 0x01, DURING = 0x02, AFTER = 0x04 }
Protected Attributes inherited from COutputInterface
std::set< const CCopasiObject * >	mObjects

Detailed Description

Definition at line 38 of file CReport.h.

Member Enumeration Documentation

enum CReport::State

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.

  {
    Invalid = -1,
    Compiled = 0,
    HeaderHeader,
    HeaderBody,
    HeaderFooter,
    BodyHeader,
    BodyBody,
    BodyFooter,
    FooterHeader,
    FooterBody,
    FooterFooter
  };

Constructor & Destructor Documentation

CReport::CReport

(

)

Default constructor.

Definition at line 34 of file CReport.cpp.

Referenced by generateObjectsFromName().

                :
  COutputInterface(),
  mpDataModel(NULL),
  mpOstream(NULL),
  mStreamOwner(false),
  mpReportDef(NULL),
  mTarget(""),
  mAppend(true),
  mConfirmOverwrite(true),
  mFooterObjectList(),
  mBodyObjectList(),
  mHeaderObjectList(),
  mpHeader(NULL),
  mpBody(NULL),
  mpFooter(NULL),
  mState(Invalid)
{}

CReport::CReport

(

const CReport &

src

)

Copy constructor.

Parameters

const

CReport & src

Definition at line 52 of file CReport.cpp.

                                   :
  COutputInterface(src),
  mpDataModel(src.mpDataModel),
  mpOstream(src.mpOstream),
  mStreamOwner(false),
  mpReportDef(src.mpReportDef),
  mTarget(src.mTarget),
  mAppend(src.mAppend),
  mConfirmOverwrite(src.mConfirmOverwrite),
  mFooterObjectList(src.mFooterObjectList),
  mBodyObjectList(src.mBodyObjectList),
  mHeaderObjectList(src.mHeaderObjectList),
  mpHeader(src.mpHeader),
  mpBody(src.mpBody),
  mpFooter(src.mpFooter),
  mState(Invalid)
{}

CReport::~CReport

(

)

Destructor.

Definition at line 70 of file CReport.cpp.

References cleanup().

{cleanup();}

Member Function Documentation

const bool & CReport::append

(

)

const

Returns whether the Report Tag is appended or not

Returns

const bool & append

Definition at line 95 of file CReport.cpp.

References mAppend.

Referenced by CQReportDefinitionSelect::loadReportDefinitionVector(), CCopasiXML::saveTaskList(), and setAppend().

{return mAppend;}

void CReport::cleanup

(

)

cleanup

Definition at line 73 of file CReport.cpp.

References close(), finish(), mBodyObjectList, mFooterObjectList, and mHeaderObjectList.

Referenced by ~CReport().

{
  mHeaderObjectList.clear();
  mBodyObjectList.clear();
  mFooterObjectList.clear();

  finish();
  close();
}

void CReport::close ( )

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().

{
  if (mStreamOwner) pdelete(mpOstream);

  mpOstream = NULL;
  mStreamOwner = false;
}

bool CReport::compile ( std::vector< CCopasiContainer * >  listOfContainer, const CCopasiDataModel *  pDataModel  )

virtual

compile the object list from name vector

Parameters

std::vector<	CCopasiContainer * > listOfContainer
const	CCopasiDataModel* pDataModel

Returns

bool success

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().

{
  assert(mpDataModel == pDataModel);

  bool success = true;
  COutputInterface::mObjects.clear();

  // check if there is a Report Definition Defined
  if (!mpReportDef) return false;

  if (mpReportDef->isTable())
    if (!mpReportDef->preCompileTable(listOfContainer)) success = false;

  generateObjectsFromName(&listOfContainer, mHeaderObjectList, mpHeader,
                          mpReportDef->getHeaderAddr());

  if (mpHeader)
    success &= compileChildReport(mpHeader, listOfContainer);

  generateObjectsFromName(&listOfContainer, mBodyObjectList, mpBody,
                          mpReportDef->getBodyAddr());

  if (mpBody)
    success &= compileChildReport(mpBody, listOfContainer);

  generateObjectsFromName(&listOfContainer, mFooterObjectList, mpFooter,
                          mpReportDef->getFooterAddr());

  if (mpFooter)
    success &= compileChildReport(mpFooter, listOfContainer);

  mState = Compiled;

  return success;
}

bool CReport::compileChildReport ( CReport *  pReport, std::vector< CCopasiContainer * >  listOfContainer  )

private

Compile the child report

Parameters

CReport	* pReport
std::vector<	CCopasiContainer * > listOfContainer

Returns

bool success

Definition at line 429 of file CReport.cpp.

References compile(), COutputInterface::mObjects, mpDataModel, mpOstream, and open().

Referenced by compile().

{
  pReport->open(mpDataModel, mpOstream);
  bool success = pReport->compile(listOfContainer, mpDataModel);

  const std::set< const CCopasiObject * > & Objects = pReport->COutputInterface::getObjects();
  std::set< const CCopasiObject * >::const_iterator it = Objects.begin();
  std::set< const CCopasiObject * >::const_iterator end = Objects.end();

  for (; it != end; ++it)
    COutputInterface::mObjects.insert(*it);

  return success;
}

const bool & CReport::confirmOverwrite

(

)

const

Returns whether a confirmation should be issued when overwriting a report

Returns

const bool & confirmOverwite

Definition at line 101 of file CReport.cpp.

References mConfirmOverwrite.

Referenced by TaskWidget::commonBeforeRunTask(), CQReportDefinitionSelect::loadReportDefinitionVector(), CCopasiXML::saveTaskList(), and setConfirmOverwrite().

{return mConfirmOverwrite;}

void CReport::finish ( )

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().

{
  mState = FooterFooter;

  printFooter();

  pdelete(mpHeader);
  pdelete(mpBody);
  pdelete(mpFooter);

  mState = Invalid;
}

void CReport::generateObjectsFromName ( const std::vector< CCopasiContainer * > *  pListOfContainer, std::vector< CCopasiObject * > &  objectList, CReport *&  pReport, const std::vector< CRegisteredObjectName > *  nameVector  )

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().

{
  objectList.clear();

  unsigned C_INT32 i;
  CCopasiObject * pSelected;
  CReportDefinition * pReportDefinition;

  for (i = 0; i < nameVector->size(); i++)
    {
      pSelected = mpDataModel->ObjectFromName(*pListOfContainer, (*nameVector)[i]);

      if (!pSelected)
        {
          CCopasiMessage(CCopasiMessage::WARNING, MCCopasiTask + 6, (*nameVector)[i].c_str());
          continue;
        }

      if (!i && (pReportDefinition = dynamic_cast< CReportDefinition * >(pSelected)) != NULL)
        {
          pReport = new CReport();
          pReport->setReportDefinition(pReportDefinition);

          return;
        }

      COutputInterface::mObjects.insert(pSelected);
      objectList.push_back(pSelected);
    }
}

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().

{return mpReportDef;}

std::ostream * CReport::getStream

(

)

const

Retrieve a pointer to the ostream

Returns

std::ostream * pOstream

Definition at line 392 of file CReport.cpp.

References mpOstream.

Referenced by CLNATask::initialize(), CScanTask::initialize(), COptProblem::initialize(), and CMCATask::initialize().

{return mpOstream;}

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().

{return mTarget;}

std::ostream * CReport::open	(	const CCopasiDataModel *	pDataModel,
		std::ostream *	pOstream = NULL
	)

Open the defined target stream or use the given argument

Parameters

const	CCopasiDataModel * pDataModel,
std::ostream	* pOstream (default: NULL)

Returns

std::ostream * mpOstream

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().

{
  mpDataModel = pDataModel;
  assert(mpDataModel != NULL);

  // If an ostream is given and it is the currently assigned one
  // we do nothing.
  if (pOstream != NULL &&
      pOstream == mpOstream)
    return mpOstream;

  if (mStreamOwner)
    pdelete(mpOstream);

  mpOstream = pOstream;

  if (pOstream)
    {
      mStreamOwner = false;
    }
  else if (mTarget != "" && mpReportDef != NULL)
    {
      if (CDirEntry::isRelativePath(mTarget) &&
          !CDirEntry::makePathAbsolute(mTarget, mpDataModel->getFileName()))
        mTarget = CDirEntry::fileName(mTarget);

      mpOstream = new std::ofstream;
      mStreamOwner = true;

      if (mAppend)
        {
          ((std::ofstream *) mpOstream)->
          open(CLocaleString::fromUtf8(mTarget).c_str(), std::ios_base::out | std::ios_base::app);
        }
      else
        {
          ((std::ofstream *) mpOstream)->
          open(CLocaleString::fromUtf8(mTarget).c_str(), std::ios_base::out);
        }

      if (!((std::ofstream *) mpOstream)->is_open())
        {
          CCopasiMessage(CCopasiMessage::ERROR, MCDirEntry + 3, mTarget.c_str());
          pdelete(mpOstream);
        }

      if (mpOstream)
        {
          mpOstream->precision(mpReportDef->getPrecision());
        }
    }

  return mpOstream;
}

void CReport::output ( const Activity &  activity )

virtual

Perform an output event for the current activity

Parameters

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().

{
  switch (activity)
    {
      case COutputInterface::BEFORE:
        printHeader();
        break;

      case COutputInterface::DURING:
        printBody();
        break;

      case COutputInterface::AFTER:
        printFooter();
        break;
    }
}

void CReport::printBody ( )

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().

{
  if (!mpOstream) return;

  // Close the header part
  if (mState < HeaderFooter)
    {
      mState = HeaderFooter;

      if (mpHeader) mpHeader->printFooter();
    }

  if (mpBody)
    switch (mState)
      {
        case HeaderFooter:
          mpBody->printHeader();
          mState = BodyHeader;
          return;

        case BodyHeader:
          mpBody->printBody();
          mState = BodyBody;
          return;

        case BodyBody:
          mpBody->printBody();
          return;

        case BodyFooter:
          mpBody->printFooter();
          return;

        default:
          return;
      }

  if (mState == BodyFooter) return;

  mState = BodyBody;

  std::vector< CCopasiObject * >::iterator it = mBodyObjectList.begin();
  std::vector< CCopasiObject * >::iterator end = mBodyObjectList.end();

  if (it == end) return;

  for (; it != end; ++it)(*it)->print(mpOstream);

  (*mpOstream) << std::endl;
}

void CReport::printFooter ( )

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().

{
  if (!mpOstream) return;

  // Close the body part
  if (mState < BodyFooter)
    {
      mState = BodyFooter;

      if (mpBody) mpBody->printFooter();
    }

  if (mpFooter)
    switch (mState)
      {
        case BodyFooter:
          mpFooter->printHeader();
          mState = FooterHeader;
          return;

        case FooterHeader:
          mpFooter->printBody();
          mState = FooterBody;
          return;

        case FooterBody:
          mpFooter->printBody();
          return;

        case FooterFooter:
          mpFooter->printFooter();
          return;

        default:
          return;
      }

  if (mState != FooterFooter) return;

  std::vector< CCopasiObject * >::iterator it = mFooterObjectList.begin();
  std::vector< CCopasiObject * >::iterator end = mFooterObjectList.end();

  if (it == end) return;

  for (; it != end; ++it)(*it)->print(mpOstream);

  (*mpOstream) << std::endl;
}

void CReport::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().

{
  if (!mpOstream) return;

  if (mpHeader)
    switch (mState)
      {
        case Compiled:
          mpHeader->printHeader();
          mState = HeaderHeader;
          return;

        case HeaderHeader:
          mpHeader->printBody();
          mState = HeaderBody;
          return;

        case HeaderBody:
          mpHeader->printBody();
          return;

        case HeaderFooter:
          mpHeader->printFooter();
          return;

        default:
          return;
      }

  if (mState == HeaderFooter) return;

  mState = HeaderFooter;

  std::vector< CCopasiObject * >::iterator it = mHeaderObjectList.begin();
  std::vector< CCopasiObject * >::iterator end = mHeaderObjectList.end();

  if (it == end) return;

  for (; it != end; ++it)(*it)->print(mpOstream);

  (*mpOstream) << std::endl;
}

void CReport::separate ( const Activity &  )

virtual

Introduce an additional separator into the output

Parameters

const

Activity & activity

Reimplemented from COutputInterface.

Definition at line 125 of file CReport.cpp.

References mpOstream.

{
  if (!mpOstream) return;

  (*mpOstream) << std::endl;
}

void CReport::setAppend

(

const bool &

append

)

sets the append attribute if the report tag

Parameters

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().

{mAppend = append;}

void CReport::setConfirmOverwrite

(

const bool &

confirmOverwrite

)

sets the confirmOverwrite attribute if the report tag

Parameters

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().

{mConfirmOverwrite = confirmOverwrite;}

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().

{mpReportDef = reportDef;}

void CReport::setTarget

(

const std::string &

target

)

sets the reference to the report

Parameters

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().

{mTarget = target;}

Member Data Documentation

bool CReport::mAppend

private

Definition at line 65 of file CReport.h.

Referenced by append(), open(), and setAppend().

std::vector< CCopasiObject * > CReport::mBodyObjectList

private

Definition at line 69 of file CReport.h.

Referenced by cleanup(), compile(), and printBody().

bool CReport::mConfirmOverwrite

private

Definition at line 66 of file CReport.h.

Referenced by confirmOverwrite(), and setConfirmOverwrite().

std::vector< CCopasiObject * > CReport::mFooterObjectList

private

Definition at line 68 of file CReport.h.

Referenced by cleanup(), compile(), and printFooter().

std::vector< CCopasiObject * > CReport::mHeaderObjectList

private

Definition at line 70 of file CReport.h.

Referenced by cleanup(), compile(), and printHeader().

CReport* CReport::mpBody

private

Definition at line 73 of file CReport.h.

Referenced by compile(), finish(), printBody(), and printFooter().

const CCopasiDataModel* CReport::mpDataModel

private

Definition at line 59 of file CReport.h.

Referenced by compile(), compileChildReport(), generateObjectsFromName(), and open().

CReport* CReport::mpFooter

private

Definition at line 74 of file CReport.h.

Referenced by compile(), finish(), and printFooter().

CReport* CReport::mpHeader

private

Definition at line 72 of file CReport.h.

Referenced by compile(), finish(), printBody(), and printHeader().

std::ostream* CReport::mpOstream

private

Definition at line 60 of file CReport.h.

Referenced by close(), compileChildReport(), getStream(), open(), printBody(), printFooter(), printHeader(), and separate().

CReportDefinition* CReport::mpReportDef

private

Definition at line 63 of file CReport.h.

Referenced by compile(), getReportDefinition(), open(), and setReportDefinition().

State CReport::mState

private

Definition at line 76 of file CReport.h.

Referenced by compile(), finish(), printBody(), printFooter(), and printHeader().

bool CReport::mStreamOwner

private

Definition at line 61 of file CReport.h.

Referenced by close(), and open().

std::string CReport::mTarget

private

Definition at line 64 of file CReport.h.

Referenced by getTarget(), open(), and setTarget().

---

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

• CReport.h
• CReport.cpp