COutputInterface Class Reference

#include <COutputHandler.h>

Inheritance diagram for COutputInterface:

List of all members.

Public Types
enum	Activity { BEFORE = 0x01, DURING = 0x02, AFTER = 0x04 }
Public Member Functions
	COutputInterface ()
	COutputInterface (const COutputInterface &src)
virtual	~COutputInterface ()
virtual bool	compile (std::vector< CCopasiContainer * >, const CCopasiDataModel *)
virtual void	output (const Activity &)
virtual void	separate (const Activity &)
virtual void	finish ()
virtual const std::set< const CCopasiObject * > &	getObjects () const
Protected Attributes
std::set< const CCopasiObject * >	mObjects

---

Detailed Description

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

---

Member Enumeration Documentation

enum COutputInterface::Activity

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

Enumerator:

BEFORE
DURING
AFTER

---

Constructor & Destructor Documentation

COutputInterface::COutputInterface

(

)

[inline]

Default constructor

COutputInterface::COutputInterface

(

const COutputInterface &

src

)

[inline]

Copy constructor

Parameters:

const

COutputInterface & src

virtual COutputInterface::~COutputInterface

(

)

[inline, virtual]

Destructor

---

Member Function Documentation

virtual bool COutputInterface::compile	(	std::vector< CCopasiContainer * >	,
		const CCopasiDataModel *
	)		[inline, virtual]

compile the object list from name vector

Parameters:

std::vector<

CCopasiContainer * > listOfContainer

Returns:

bool success

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

virtual void COutputInterface::finish

(

)

[inline, virtual]

Finish the output

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

virtual const std::set< const CCopasiObject * >& COutputInterface::getObjects

(

)

const [inline, virtual]

Retrieve the list of objects handled by the interface

Returns:

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

Reimplemented in PlotWindow.

virtual void COutputInterface::output

(

const Activity &

)

[inline, virtual]

Perform an output event for the current activity

Parameters:

const

Activity & activity

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

virtual void COutputInterface::separate

(

const Activity &

)

[inline, virtual]

Introduce an additional separator into the output

Parameters:

const

Activity & activity

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

---

Member Data Documentation

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

All the objects which are output.

---

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

• copasi/utilities/COutputHandler.h