COPASI API  4.16.103
Public Types | Public Member Functions | Protected Attributes | List of all members
COutputInterface Class Reference

#include <COutputHandler.h>

Inheritance diagram for COutputInterface:
Inheritance graph
[legend]
Collaboration diagram for COutputInterface:
Collaboration graph
[legend]

Public Types

enum  Activity { BEFORE = 0x01, DURING = 0x02, AFTER = 0x04 }
 

Public Member Functions

virtual void close ()
 
virtual bool compile (std::vector< CCopasiContainer * >, const CCopasiDataModel *)
 
 COutputInterface ()
 
 COutputInterface (const COutputInterface &src)
 
virtual void finish ()
 
virtual const std::set< const
CCopasiObject * > & 
getObjects () const
 
virtual void output (const Activity &)
 
virtual void separate (const Activity &)
 
virtual ~COutputInterface ()
 

Protected Attributes

std::set< const CCopasiObject * > mObjects
 

Detailed Description

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

Definition at line 30 of file COutputHandler.h.

Member Enumeration Documentation

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

Enumerator
BEFORE 
DURING 
AFTER 

Definition at line 37 of file COutputHandler.h.

Constructor & Destructor Documentation

COutputInterface::COutputInterface ( )
inline

Default constructor

Definition at line 47 of file COutputHandler.h.

47  :
48  mObjects()
49  {};
std::set< const CCopasiObject * > mObjects
COutputInterface::COutputInterface ( const COutputInterface src)
inline

Copy constructor

Parameters
constCOutputInterface & src

Definition at line 55 of file COutputHandler.h.

55  :
56  mObjects(src.mObjects)
57  {};
std::set< const CCopasiObject * > mObjects
virtual COutputInterface::~COutputInterface ( )
inlinevirtual

Destructor

Definition at line 62 of file COutputHandler.h.

62 {};

Member Function Documentation

virtual void COutputInterface::close ( )
inlinevirtual

Close the stream if applicable

Reimplemented in CReport.

Definition at line 92 of file COutputHandler.h.

92 {};
virtual bool COutputInterface::compile ( std::vector< CCopasiContainer * >  ,
const CCopasiDataModel  
)
inlinevirtual

compile the object list from name vector

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

Reimplemented in CopasiPlot, COutputHandler, CReport, PlotWindow, CTimeSeries, and COutputHandlerPlot.

Definition at line 69 of file COutputHandler.h.

70  {return false;};
virtual void COutputInterface::finish ( )
inlinevirtual

Finish the output

Reimplemented in CopasiPlot, COutputHandler, CReport, PlotWindow, and CTimeSeries.

Definition at line 87 of file COutputHandler.h.

87 {};
virtual const std::set< const CCopasiObject * >& COutputInterface::getObjects ( ) const
inlinevirtual

Retrieve the list of objects handled by the interface

Returns
const std::set< const CCopasiObject * > & objects

Reimplemented in PlotWindow.

Definition at line 98 of file COutputHandler.h.

References mObjects.

Referenced by PlotWindow::getObjects().

99  {return mObjects;}
std::set< const CCopasiObject * > mObjects
virtual void COutputInterface::output ( const Activity )
inlinevirtual

Perform an output event for the current activity

Parameters
constActivity & activity

Reimplemented in COutputHandler, CReport, PlotWindow, and CTimeSeries.

Definition at line 76 of file COutputHandler.h.

76 {};
virtual void COutputInterface::separate ( const Activity )
inlinevirtual

Introduce an additional separator into the output

Parameters
constActivity & activity

Reimplemented in COutputHandler, CReport, PlotWindow, and CTimeSeries.

Definition at line 82 of file COutputHandler.h.

82 {};

Member Data Documentation

std::set< const CCopasiObject * > COutputInterface::mObjects
protected

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