COutputInterface Class Reference

#include <COutputHandler.h>

Inheritance diagram for COutputInterface:

Collaboration diagram for COutputInterface:

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

enum COutputInterface::Activity

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.

  {
    BEFORE = 0x01,
    DURING = 0x02,
    AFTER = 0x04
  };

Constructor & Destructor Documentation

COutputInterface::COutputInterface ( )

inline

Default constructor

Definition at line 47 of file COutputHandler.h.

                    :
    mObjects()
  {};

COutputInterface::COutputInterface ( const COutputInterface &  src )

inline

Copy constructor

Parameters

const

COutputInterface & src

Definition at line 55 of file COutputHandler.h.

                                                :
    mObjects(src.mObjects)
  {};

virtual COutputInterface::~COutputInterface ( )

inlinevirtual

Destructor

Definition at line 62 of file COutputHandler.h.

{};

Member Function Documentation

virtual void COutputInterface::close ( )

inlinevirtual

Close the stream if applicable

Reimplemented in CReport.

Definition at line 92 of file COutputHandler.h.

{};

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.

  {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.

{};

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

  {return mObjects;}

virtual void COutputInterface::output ( const Activity &  )

inlinevirtual

Perform an output event for the current activity

Parameters

const

Activity & activity

Reimplemented in COutputHandler, CReport, PlotWindow, and CTimeSeries.

Definition at line 76 of file COutputHandler.h.

{};

virtual void COutputInterface::separate ( const Activity &  )

inlinevirtual

Introduce an additional separator into the output

Parameters

const

Activity & activity

Reimplemented in COutputHandler, CReport, PlotWindow, and CTimeSeries.

Definition at line 82 of file COutputHandler.h.

{};

Member Data Documentation

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

protected

All the objects which are output.

Definition at line 106 of file COutputHandler.h.

Referenced by CTimeSeries::clear(), CopasiPlot::clearBuffers(), CTimeSeries::compile(), PlotWindow::compile(), CReport::compile(), COutputHandler::compile(), CopasiPlot::compile(), CReport::compileChildReport(), COutputHandler::compileRefresh(), CReport::generateObjectsFromName(), getObjects(), PlotWindow::getObjects(), and CopasiPlot::saveData().

---

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

• COutputHandler.h