copasi API  0.1
Public Member Functions | Protected Member Functions | Protected Attributes
COutputHandler Class Reference

#include <COutputHandler.h>

Inheritance diagram for COutputHandler:
COutputInterface CCopasiDataModel COutputHandlerPlot

List of all members.

Public Member Functions

 COutputHandler ()
 COutputHandler (const COutputHandler &src)
virtual ~COutputHandler ()
virtual bool compile (std::vector< CCopasiContainer * > listOfContainer, const CCopasiDataModel *pDataModel)
virtual void output (const Activity &activity)
virtual void separate (const Activity &activity)
virtual void finish ()
virtual void addInterface (COutputInterface *pInterface)
virtual void removeInterface (COutputInterface *pInterface)
void setMaster (COutputHandler *pMaster)
bool isMaster () const
std::set< COutputInterface * > getInterfaces () const

Protected Member Functions

void refresh ()
bool compileRefresh (const std::vector< CCopasiContainer * > &listOfContainer, const CCopasiDataModel *pDataModel)

Protected Attributes

std::set< COutputInterface * > mInterfaces
COutputHandlermpMaster
std::vector< Refresh * > mObjectRefreshes

Detailed Description

This is the lass which drives all output of COPASI.


Constructor & Destructor Documentation

COutputHandler::COutputHandler ( )

Default Constructor

COutputHandler::COutputHandler ( const COutputHandler src)

Copy constructor

Parameters:
constCOutputInterface & src
COutputHandler::~COutputHandler ( ) [virtual]

Destructor


Member Function Documentation

void COutputHandler::addInterface ( COutputInterface pInterface) [virtual]

Add an interface

Parameters:
COutputInterface* pInterface;
bool COutputHandler::compile ( std::vector< CCopasiContainer * >  listOfContainer,
const CCopasiDataModel pDataModel 
) [virtual]

compile the object list from name vector

Parameters:
std::vector<CCopasiContainer * > listOfContainer
constCCopasiDataModel* pDataModel
Returns:
bool success

Reimplemented from COutputInterface.

Reimplemented in COutputHandlerPlot.

bool COutputHandler::compileRefresh ( const std::vector< CCopasiContainer * > &  listOfContainer,
const CCopasiDataModel pDataModel 
) [protected]

Compile the object refresh list

Parameters:
conststd::vector< CCopasiContainer * > & listOfContainer
Returns:
bool success
void COutputHandler::finish ( ) [virtual]

Finish the output

Reimplemented from COutputInterface.

std::set< COutputInterface * > COutputHandler::getInterfaces ( ) const
bool COutputHandler::isMaster ( ) const

Check whether the handler is a master

Returns:
bool isMaster
void COutputHandler::output ( const Activity activity) [virtual]

Perform an output event for the current activity

Parameters:
constActivity & activity

Reimplemented from COutputInterface.

void COutputHandler::refresh ( ) [protected]

Refresh all objects

void COutputHandler::removeInterface ( COutputInterface pInterface) [virtual]

Remove an interface

Parameters:
COutputInterface* pInterface;

Reimplemented in COutputHandlerPlot.

void COutputHandler::separate ( const Activity activity) [virtual]

Introduce an additional separator into the output

Parameters:
constActivity & activity

Reimplemented from COutputInterface.

void COutputHandler::setMaster ( COutputHandler pMaster)

Set whether the handler is the master handler

Parameters:
COutputHandler* pMaster

Member Data Documentation

A list of all active output interfaces.

std::vector< Refresh * > COutputHandler::mObjectRefreshes [protected]

An ordered list of refresh methods needed by the master

Points to the master handler. The master handler is responsible for the and object updates and all the output.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines