YACS::ENGINE::PyOptimizerAlgBase Class Reference

Base class factorizing common methods for python algorithms interfaces. More...

#include <PyOptimizerAlg.hxx>

Inheritance diagram for YACS::ENGINE::PyOptimizerAlgBase:

Collaboration diagram for YACS::ENGINE::PyOptimizerAlgBase:

Public Member Functions
virtual	~PyOptimizerAlgBase ()
virtual TypeCode *	getTCForInProxy () const
virtual TypeCode *	getTCForOutProxy () const
virtual TypeCode *	getTCForAlgoInitProxy () const
virtual TypeCode *	getTCForAlgoResultProxy () const
virtual void	initializeProxy (const Any *input)
virtual void	startProxy ()
virtual void	takeDecisionProxy ()
virtual void	finishProxy ()
virtual Any *	getAlgoResultProxy ()
Public Member Functions inherited from YACS::ENGINE::OptimizerAlgBase
virtual void	setPool (Pool *pool)
virtual void	setProc (Proc *proc)
virtual Proc *	getProc ()
virtual bool	hasError () const
virtual const std::string &	getError () const
virtual void	setError (const std::string &message)
void	setNbOfBranches (int nbOfBranches)
int	getNbOfBranches () const
Public Member Functions inherited from YACS::ENGINE::RefCounter
unsigned int	getRefCnt () const
void	incrRef () const
bool	decrRef () const

Protected Member Functions
	PyOptimizerAlgBase (Pool *pool)
Protected Member Functions inherited from YACS::ENGINE::OptimizerAlgBase
	OptimizerAlgBase (Pool *pool)
virtual	~OptimizerAlgBase ()
virtual TypeCode *	getTCForIn () const =0
	returns typecode of type expected as Input. OwnerShip of returned pointer is held by this. More...
virtual TypeCode *	getTCForOut () const =0
	returns typecode of type expected as Output. OwnerShip of returned pointer is held by this. More...
virtual TypeCode *	getTCForAlgoInit () const
	returns typecode of type expected for algo initialization. OwnerShip of returned pointer is held by this. More...
virtual TypeCode *	getTCForAlgoResult () const
	returns typecode of type expected as algo result. OwnerShip of returned pointer is held by this. More...
virtual void	initialize (const Any *input)
virtual void	start ()=0
virtual void	takeDecision ()=0
	Update _pool attribute before performing anything. More...
virtual void	finish ()
virtual Any *	getAlgoResult ()
	Called when optimization has succeed. More...
Protected Member Functions inherited from YACS::ENGINE::RefCounter
	RefCounter ()
	RefCounter (const RefCounter &other)
virtual	~RefCounter ()

Additional Inherited Members
Static Public Attributes inherited from YACS::ENGINE::RefCounter
static unsigned int	_totalCnt =0
Protected Attributes inherited from YACS::ENGINE::OptimizerAlgBase
Pool *	_pool
Proc *	_proc
std::string	_errorMessage
int	_nbOfBranches
Protected Attributes inherited from YACS::ENGINE::RefCounter
unsigned int	_cnt

Detailed Description

Base class factorizing common methods for python algorithms interfaces.

Definition at line 32 of file PyOptimizerAlg.hxx.

Constructor & Destructor Documentation

~PyOptimizerAlgBase()

PyOptimizerAlgBase::~PyOptimizerAlgBase ( )

virtual

Definition at line 50 of file PyOptimizerAlg.cxx.

{
}

PyOptimizerAlgBase()

PyOptimizerAlgBase::PyOptimizerAlgBase ( Pool *  pool )

protected

Definition at line 45 of file PyOptimizerAlg.cxx.

  : OptimizerAlgBase(pool)
{
}

Member Function Documentation

finishProxy()

void PyOptimizerAlgBase::finishProxy ( )

virtual

Reimplemented from YACS::ENGINE::OptimizerAlgBase.

Reimplemented in YACS::ENGINE::PyOptimizerAlgASync.

Definition at line 66 of file PyOptimizerAlg.cxx.

{
  GILState gs;
  OptimizerAlgBase::finishProxy();
}

References YACS::ENGINE::OptimizerAlgBase::finishProxy().

Referenced by YACS::ENGINE::PyOptimizerAlgASync::finishProxy().

getAlgoResultProxy()

Any * PyOptimizerAlgBase::getAlgoResultProxy ( )

virtual

Reimplemented from YACS::ENGINE::OptimizerAlgBase.

Definition at line 102 of file PyOptimizerAlg.cxx.

{
  GILState gs;
  return OptimizerAlgBase::getAlgoResultProxy();
}

References YACS::ENGINE::OptimizerAlgBase::getAlgoResultProxy().

getTCForAlgoInitProxy()

TypeCode * PyOptimizerAlgBase::getTCForAlgoInitProxy ( ) const

virtual

Reimplemented from YACS::ENGINE::OptimizerAlgBase.

Definition at line 90 of file PyOptimizerAlg.cxx.

{
  GILState gs;
  return OptimizerAlgBase::getTCForAlgoInitProxy();
}

References YACS::ENGINE::OptimizerAlgBase::getTCForAlgoInitProxy().

getTCForAlgoResultProxy()

TypeCode * PyOptimizerAlgBase::getTCForAlgoResultProxy ( ) const

virtual

Reimplemented from YACS::ENGINE::OptimizerAlgBase.

Definition at line 96 of file PyOptimizerAlg.cxx.

{
  GILState gs;
  return OptimizerAlgBase::getTCForAlgoResultProxy();
}

References YACS::ENGINE::OptimizerAlgBase::getTCForAlgoResultProxy().

getTCForInProxy()

TypeCode * PyOptimizerAlgBase::getTCForInProxy ( ) const

virtual

Reimplemented from YACS::ENGINE::OptimizerAlgBase.

Definition at line 78 of file PyOptimizerAlg.cxx.

{
  GILState gs;
  return OptimizerAlgBase::getTCForInProxy();
}

References YACS::ENGINE::OptimizerAlgBase::getTCForInProxy().

getTCForOutProxy()

TypeCode * PyOptimizerAlgBase::getTCForOutProxy ( ) const

virtual

Reimplemented from YACS::ENGINE::OptimizerAlgBase.

Definition at line 84 of file PyOptimizerAlg.cxx.

{
  GILState gs;
  return OptimizerAlgBase::getTCForOutProxy();
}

References YACS::ENGINE::OptimizerAlgBase::getTCForOutProxy().

initializeProxy()

void PyOptimizerAlgBase::initializeProxy ( const Any *  input )

virtual

Reimplemented from YACS::ENGINE::OptimizerAlgBase.

Definition at line 72 of file PyOptimizerAlg.cxx.

{
  GILState gs;
  OptimizerAlgBase::initializeProxy(input);
}

References YACS::ENGINE::OptimizerAlgBase::initializeProxy().

startProxy()

void PyOptimizerAlgBase::startProxy ( )

virtual

Reimplemented from YACS::ENGINE::OptimizerAlgBase.

Reimplemented in YACS::ENGINE::PyOptimizerAlgASync.

Definition at line 54 of file PyOptimizerAlg.cxx.

{
  GILState gs;
  OptimizerAlgBase::startProxy();
}

References YACS::ENGINE::OptimizerAlgBase::startProxy().

takeDecisionProxy()

void PyOptimizerAlgBase::takeDecisionProxy ( )

virtual

Reimplemented from YACS::ENGINE::OptimizerAlgBase.

Reimplemented in YACS::ENGINE::PyOptimizerAlgASync.

Definition at line 60 of file PyOptimizerAlg.cxx.

{
  GILState gs;
  OptimizerAlgBase::takeDecisionProxy();
}

References YACS::ENGINE::OptimizerAlgBase::takeDecisionProxy().

---

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

• src/runtime/PyOptimizerAlg.hxx
• src/runtime/PyOptimizerAlg.cxx