mobius::core_IAlgorithm Class Reference

#include <core_IAlgorithm.h>

Inheritance diagram for mobius::core_IAlgorithm:

Collaboration diagram for mobius::core_IAlgorithm:

Public Member Functions
core_ProgressEntry &	GetProgress () const
core_PlotterEntry &	GetPlotter () const
void	SetStatusCode (const int status)
int	GetStatusCode () const
void	AddStatusCode (const int statBit)
bool	HasStatusCode (const int statBit) const
Public Member Functions inherited from mobius::core_OBJECT
mobiusCore_EXPORT void	IncRef ()
mobiusCore_EXPORT void	DecRef ()
mobiusCore_EXPORT int	NbRefs () const
virtual mobiusCore_EXPORT void	Dump (std::ostream *out) const
const mobiusCore_EXPORT std::string &	GetName () const
mobiusCore_EXPORT void	SetName (const std::string &name)
mobiusCore_EXPORT bool	HasName () const

Protected Member Functions
mobiusCore_EXPORT	core_IAlgorithm (core_ProgressEntry progress, core_PlotterEntry plotter)

Protected Attributes
core_ProgressEntry	m_progress
	Progress Notifier.
core_PlotterEntry	m_plotter
	Imperative Plotter.
int	m_iStatusCode

Detailed Description

Interface for algorithms.

Member Function Documentation

AddStatusCode()

void mobius::core_IAlgorithm::AddStatusCode ( const int  statBit )

inline

Adds status to the currently stored one. The derived classes take responsibility to implement status codes as bitmasks like 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, etc. This may we can store several statuses in one integer variable.

Parameters

[in]

statBit

status bit to add to the current status.

GetStatusCode()

int mobius::core_IAlgorithm::GetStatusCode ( ) const

inline

Returns

integer status code.

HasStatusCode()

bool mobius::core_IAlgorithm::HasStatusCode ( const int  statBit ) const

inline

Checks whether the stored status code contains bits for the passed status.

Parameters

[in]

statBit

bits to check.

Returns

true/false.

SetStatusCode()

void mobius::core_IAlgorithm::SetStatusCode ( const int  status )

inline

Sets status code as an integer.

Parameters

[in]

status

code to set.

Member Data Documentation

m_iStatusCode

int mobius::core_IAlgorithm::m_iStatusCode

protected

Status code which can be an error code, warning code or any other status which gives more detalisation on algorithm's execution state.

---

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

• C:/work/Mobius/src/core/base/core_IAlgorithm.h