UNIVERS  15.3
UNIVERS base processing software API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
dcf::CalcBlock Class Reference

#include <calc_block.hpp>

Inheritance diagram for dcf::CalcBlock:
dcf::CFFT2DCalcBlock dcf::CUBPFCalcBlock dcf::ThreadCalcBlock

Public Member Functions

 CalcBlock (const dcf::Manager &manager)
 
 CalcBlock (const dcf::CalcBlock &cb)
 
virtual ~CalcBlock ()
 
virtual void start ()
 
virtual void stop ()
 
virtual void wait ()
 
virtual bool running () const
 
const dcf::Managermanager () const
 
dcf::error_t resultCode ()
 

Protected Member Functions

virtual void run ()
 

Protected Attributes

dcf::Managerm_manager
 
dcf::error_t m_result_code
 

Detailed Description

Interface for abstract calculation on distributed system.

Constructor & Destructor Documentation

dcf::CalcBlock::CalcBlock ( const dcf::Manager manager)

Default constructor with DCF Manager provided.

dcf::CalcBlock::CalcBlock ( const dcf::CalcBlock cb)

Copy constructor.

virtual dcf::CalcBlock::~CalcBlock ( )
virtual

Destructs object.

Member Function Documentation

const dcf::Manager* dcf::CalcBlock::manager ( ) const
inline

Gets current manager pointer.

dcf::error_t dcf::CalcBlock::resultCode ( )
inline

Gets result code. dcf::ErrSuccess by default.

virtual void dcf::CalcBlock::run ( )
protectedvirtual
Polymorfic calculations method which has to be redefined 

in derived objects. Should provide result code.

Reimplemented in dcf::CFFT2DCalcBlock, dcf::ThreadCalcBlock, and dcf::CUBPFCalcBlock.

virtual bool dcf::CalcBlock::running ( ) const
inlinevirtual

Is calculations running.

virtual void dcf::CalcBlock::start ( )
virtual

Sart calculations by executing run() method. Should provide result code.

Reimplemented in dcf::CUBPFCalcBlock, dcf::CFFT2DCalcBlock, and dcf::ThreadCalcBlock.

virtual void dcf::CalcBlock::stop ( )
virtual

Stop calculations. Should provide result code.

Reimplemented in dcf::ThreadCalcBlock.

virtual void dcf::CalcBlock::wait ( )
virtual

Waits while calculations will complete. Should provide result code.

Reimplemented in dcf::ThreadCalcBlock.

Member Data Documentation

dcf::Manager* dcf::CalcBlock::m_manager
protected

Resource manager.

dcf::error_t dcf::CalcBlock::m_result_code
protected

Current result code.


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