Open CASCADE Technology  6.9.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes

BOPAlgo_Algo Class Referenceabstract

provides the root interface for algorithms More...

#include <BOPAlgo_Algo.hxx>

Inheritance diagram for BOPAlgo_Algo:
Inheritance graph
[legend]

Public Member Functions

virtual void Perform ()=0
 
Standard_Integer ErrorStatus () const
 
Standard_Integer WarningStatus () const
 
const BOPCol_BaseAllocatorAllocator () const
 
void SetRunParallel (const Standard_Boolean theFlag)
 Set the flag of parallel processing if <theFlag> is true the parallel processing is switched on if <theFlag> is false the parallel processing is switched off. More...
 
Standard_Boolean RunParallel () const
 Returns the flag of parallel processing. More...
 
void SetProgressIndicator (const Handle< Message_ProgressIndicator > &theObj)
 Set the Progress Indicator object. More...
 

Static Public Member Functions

static Standard_Boolean GetParallelMode ()
 
static void SetParallelMode (const Standard_Boolean theNewMode)
 

Protected Member Functions

 BOPAlgo_Algo ()
 
virtual ~BOPAlgo_Algo ()
 
 BOPAlgo_Algo (const BOPCol_BaseAllocator &theAllocator)
 
virtual void CheckData ()
 
virtual void CheckResult ()
 
void UserBreak () const
 Breaks the execution if the break signal is indicated by myProgressIndicator. More...
 

Protected Attributes

BOPCol_BaseAllocator myAllocator
 
Standard_Integer myErrorStatus
 
Standard_Integer myWarningStatus
 
Standard_Boolean myRunParallel
 
Handle< Message_ProgressIndicatormyProgressIndicator
 

Detailed Description

provides the root interface for algorithms

Constructor & Destructor Documentation

BOPAlgo_Algo::BOPAlgo_Algo ( )
protected
virtual BOPAlgo_Algo::~BOPAlgo_Algo ( )
protectedvirtual
BOPAlgo_Algo::BOPAlgo_Algo ( const BOPCol_BaseAllocator theAllocator)
protected

Member Function Documentation

const BOPCol_BaseAllocator& BOPAlgo_Algo::Allocator ( ) const
virtual void BOPAlgo_Algo::CheckData ( )
protectedvirtual
virtual void BOPAlgo_Algo::CheckResult ( )
protectedvirtual
Standard_Integer BOPAlgo_Algo::ErrorStatus ( ) const
static Standard_Boolean BOPAlgo_Algo::GetParallelMode ( )
static
virtual void BOPAlgo_Algo::Perform ( )
pure virtual
Standard_Boolean BOPAlgo_Algo::RunParallel ( ) const

Returns the flag of parallel processing.

static void BOPAlgo_Algo::SetParallelMode ( const Standard_Boolean  theNewMode)
static
void BOPAlgo_Algo::SetProgressIndicator ( const Handle< Message_ProgressIndicator > &  theObj)

Set the Progress Indicator object.

void BOPAlgo_Algo::SetRunParallel ( const Standard_Boolean  theFlag)

Set the flag of parallel processing if <theFlag> is true the parallel processing is switched on if <theFlag> is false the parallel processing is switched off.

void BOPAlgo_Algo::UserBreak ( ) const
protected

Breaks the execution if the break signal is indicated by myProgressIndicator.

Standard_Integer BOPAlgo_Algo::WarningStatus ( ) const

Field Documentation

BOPCol_BaseAllocator BOPAlgo_Algo::myAllocator
protected
Standard_Integer BOPAlgo_Algo::myErrorStatus
protected
Handle< Message_ProgressIndicator > BOPAlgo_Algo::myProgressIndicator
protected
Standard_Boolean BOPAlgo_Algo::myRunParallel
protected
Standard_Integer BOPAlgo_Algo::myWarningStatus
protected

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