Open CASCADE Technology  7.3.1.dev
Public Member Functions
BOPAlgo_Options Class Reference

The class provides the following options for the algorithms in Boolean Component: More...

#include <BOPAlgo_Options.hxx>

Inheritance diagram for BOPAlgo_Options:
Inheritance graph
[legend]

Public Member Functions

 BOPAlgo_Options ()
 Empty constructor. More...
 
 BOPAlgo_Options (const Handle< NCollection_BaseAllocator > &theAllocator)
 Constructor with allocator. More...
 
virtual ~BOPAlgo_Options ()
 Destructor. More...
 
const Handle< NCollection_BaseAllocator > & Allocator () const
 Returns allocator. More...
 
virtual void Clear ()
 Clears all warnings and errors, and any data cached by the algorithm. User defined options are not cleared. More...
 
Error reporting mechanism
void AddError (const Handle< Message_Alert > &theAlert)
 Adds the alert as error (fail) More...
 
void AddWarning (const Handle< Message_Alert > &theAlert)
 Adds the alert as warning. More...
 
Standard_Boolean HasErrors () const
 Returns true if algorithm has failed. More...
 
Standard_Boolean HasError (const Handle< Standard_Type > &theType) const
 Returns true if algorithm has generated error of specified type. More...
 
Standard_Boolean HasWarnings () const
 Returns true if algorithm has generated some warning alerts. More...
 
Standard_Boolean HasWarning (const Handle< Standard_Type > &theType) const
 Returns true if algorithm has generated warning of specified type. More...
 
const Handle< Message_Report > & GetReport () const
 Returns report collecting all errors and warnings. More...
 
void DumpErrors (Standard_OStream &theOS) const
 Dumps the error status into the given stream. More...
 
void DumpWarnings (Standard_OStream &theOS) const
 Dumps the warning statuses into the given stream. More...
 
void ClearWarnings ()
 Clears the warnings of the algorithm. More...
 
Fuzzy tolerance
void SetFuzzyValue (const Standard_Real theFuzz)
 Sets the additional tolerance. More...
 
Standard_Real FuzzyValue () const
 Returns the additional tolerance. More...
 
Progress indicator
void SetProgressIndicator (const Handle< Message_ProgressIndicator > &theObj)
 Set the Progress Indicator object. More...
 

Parallel processing mode

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...
 
static Standard_Boolean GetParallelMode ()
 Gets the global parallel mode. More...
 
static void SetParallelMode (const Standard_Boolean theNewMode)
 Sets the global parallel mode. More...
 

Usage of Oriented Bounding boxes

Handle< NCollection_BaseAllocatormyAllocator
 Enables/Disables the usage of OBB. More...
 
Handle< Message_ReportmyReport
 Enables/Disables the usage of OBB. More...
 
Standard_Boolean myRunParallel
 Enables/Disables the usage of OBB. More...
 
Standard_Real myFuzzyValue
 Enables/Disables the usage of OBB. More...
 
Handle< Message_ProgressIndicatormyProgressIndicator
 Enables/Disables the usage of OBB. More...
 
Standard_Boolean myUseOBB
 Enables/Disables the usage of OBB. More...
 
void SetUseOBB (const Standard_Boolean theUseOBB)
 Enables/Disables the usage of OBB. More...
 
Standard_Boolean UseOBB () const
 Returns the flag defining usage of OBB. More...
 
void UserBreak () const
 Breaks the execution if the break signal is indicated by myProgressIndicator. More...
 

Detailed Description

The class provides the following options for the algorithms in Boolean Component:

Constructor & Destructor Documentation

◆ BOPAlgo_Options() [1/2]

BOPAlgo_Options::BOPAlgo_Options ( )

Empty constructor.

◆ BOPAlgo_Options() [2/2]

BOPAlgo_Options::BOPAlgo_Options ( const Handle< NCollection_BaseAllocator > &  theAllocator)

Constructor with allocator.

◆ ~BOPAlgo_Options()

virtual BOPAlgo_Options::~BOPAlgo_Options ( )
virtual

Destructor.

Member Function Documentation

◆ AddError()

void BOPAlgo_Options::AddError ( const Handle< Message_Alert > &  theAlert)
inline

Adds the alert as error (fail)

◆ AddWarning()

void BOPAlgo_Options::AddWarning ( const Handle< Message_Alert > &  theAlert)
inline

Adds the alert as warning.

◆ Allocator()

const Handle< NCollection_BaseAllocator >& BOPAlgo_Options::Allocator ( ) const
inline

Returns allocator.

◆ Clear()

virtual void BOPAlgo_Options::Clear ( )
inlinevirtual

◆ ClearWarnings()

void BOPAlgo_Options::ClearWarnings ( )
inline

Clears the warnings of the algorithm.

◆ DumpErrors()

void BOPAlgo_Options::DumpErrors ( Standard_OStream theOS) const

Dumps the error status into the given stream.

◆ DumpWarnings()

void BOPAlgo_Options::DumpWarnings ( Standard_OStream theOS) const

Dumps the warning statuses into the given stream.

◆ FuzzyValue()

Standard_Real BOPAlgo_Options::FuzzyValue ( ) const
inline

Returns the additional tolerance.

◆ GetParallelMode()

static Standard_Boolean BOPAlgo_Options::GetParallelMode ( )
static

Gets the global parallel mode.

◆ GetReport()

const Handle< Message_Report >& BOPAlgo_Options::GetReport ( ) const
inline

Returns report collecting all errors and warnings.

◆ HasError()

Standard_Boolean BOPAlgo_Options::HasError ( const Handle< Standard_Type > &  theType) const
inline

Returns true if algorithm has generated error of specified type.

◆ HasErrors()

Standard_Boolean BOPAlgo_Options::HasErrors ( ) const
inline

Returns true if algorithm has failed.

◆ HasWarning()

Standard_Boolean BOPAlgo_Options::HasWarning ( const Handle< Standard_Type > &  theType) const
inline

Returns true if algorithm has generated warning of specified type.

◆ HasWarnings()

Standard_Boolean BOPAlgo_Options::HasWarnings ( ) const
inline

Returns true if algorithm has generated some warning alerts.

◆ RunParallel()

Standard_Boolean BOPAlgo_Options::RunParallel ( ) const
inline

Returns the flag of parallel processing.

◆ SetFuzzyValue()

void BOPAlgo_Options::SetFuzzyValue ( const Standard_Real  theFuzz)

Sets the additional tolerance.

◆ SetParallelMode()

static void BOPAlgo_Options::SetParallelMode ( const Standard_Boolean  theNewMode)
static

Sets the global parallel mode.

◆ SetProgressIndicator()

void BOPAlgo_Options::SetProgressIndicator ( const Handle< Message_ProgressIndicator > &  theObj)

Set the Progress Indicator object.

◆ SetRunParallel()

void BOPAlgo_Options::SetRunParallel ( const Standard_Boolean  theFlag)
inline

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.

◆ SetUseOBB()

void BOPAlgo_Options::SetUseOBB ( const Standard_Boolean  theUseOBB)
inline

Enables/Disables the usage of OBB.

◆ UseOBB()

Standard_Boolean BOPAlgo_Options::UseOBB ( ) const
inline

Returns the flag defining usage of OBB.

◆ UserBreak()

void BOPAlgo_Options::UserBreak ( ) const
protected

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

Field Documentation

◆ myAllocator

Handle< NCollection_BaseAllocator > BOPAlgo_Options::myAllocator
protected

Enables/Disables the usage of OBB.

◆ myFuzzyValue

Standard_Real BOPAlgo_Options::myFuzzyValue
protected

Enables/Disables the usage of OBB.

◆ myProgressIndicator

Handle< Message_ProgressIndicator > BOPAlgo_Options::myProgressIndicator
protected

Enables/Disables the usage of OBB.

◆ myReport

Handle< Message_Report > BOPAlgo_Options::myReport
protected

Enables/Disables the usage of OBB.

◆ myRunParallel

Standard_Boolean BOPAlgo_Options::myRunParallel
protected

Enables/Disables the usage of OBB.

◆ myUseOBB

Standard_Boolean BOPAlgo_Options::myUseOBB
protected

Enables/Disables the usage of OBB.


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