COutputInterface Class Reference

#include <COutputHandler.h>

Inheritance diagram for COutputInterface:

Public Types
enum	Activity { BEFORE = 0x01 , DURING = 0x02 , AFTER = 0x04 , MONITORING = 0x08 }

Public Member Functions
virtual void	close ()
virtual bool	compile (CObjectInterface::ContainerList)=0
	COutputInterface ()
	COutputInterface (const COutputInterface &src)
virtual void	finish ()=0
virtual const CObjectInterface::ObjectSet &	getObjects () const
virtual void	output (const Activity &)=0
virtual void	separate (const Activity &)=0
virtual	~COutputInterface ()

Protected Attributes
CObjectInterface::ObjectSet	mObjects

Detailed Description

This is just the interface that is used to all output provided by COPASI.

Member Enumeration Documentation

Activity

enum COutputInterface::Activity

The output activity, indicating the status of the current operations performed by a task.

Enumerator
BEFORE
DURING
AFTER
MONITORING

Constructor & Destructor Documentation

COutputInterface() [1/2]

COutputInterface::COutputInterface

(

)

Default constructor

COutputInterface() [2/2]

COutputInterface::COutputInterface

(

const COutputInterface &

src

)

Copy constructor

Parameters

const

COutputInterface & src

~COutputInterface()

COutputInterface::~COutputInterface ( )

virtual

Destructor

Member Function Documentation

close()

void COutputInterface::close ( )

virtual

Close the stream if applicable

Reimplemented in CReport.

Referenced by CDataHandler::cleanup().

compile()

virtual bool COutputInterface::compile ( CObjectInterface::ContainerList  )

pure virtual

compile the object list from name vector

Parameters

CObjectInterface::ContainerList

listOfContainer

Returns

bool success

Implemented in CTimeSeries, CReport, CDataHandler, and COutputHandler.

finish()

virtual void COutputInterface::finish ( )

pure virtual

Finish the output

Implemented in CTimeSeries, CReport, CDataHandler, and COutputHandler.

getObjects()

const CObjectInterface::ObjectSet & COutputInterface::getObjects ( ) const

virtual

Retrieve the list of objects handled by the interface

Returns

const CObjectInterface::ObjectSet & objects

References mObjects.

output()

virtual void COutputInterface::output ( const Activity &  )

pure virtual

Perform an output event for the current activity

Parameters

const

Activity & activity

Implemented in CTimeSeries, CReport, CDataHandler, and COutputHandler.

separate()

virtual void COutputInterface::separate ( const Activity &  )

pure virtual

Introduce an additional separator into the output

Parameters

const

Activity & activity

Implemented in CTimeSeries, COutputHandler, CReport, and CDataHandler.

Member Data Documentation

mObjects

CObjectInterface::ObjectSet COutputInterface::mObjects

protected

All the objects which are output.

Referenced by CTimeSeries::clear(), COutputHandler::compile(), CDataHandler::compile(), CReport::compile(), CTimeSeries::compile(), CReport::compileChildReport(), COutputHandler::compileUpdateSequence(), CDataHandler::generateObjectsFromName(), CReport::generateObjectsFromName(), and getObjects().

---

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

• COutputHandler.h
• COutputHandler.cpp