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:

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

Usage of Oriented Bounding boxes
occ::handle< NCollection_BaseAllocator >	myAllocator
	Enables/Disables the usage of OBB.
occ::handle< Message_Report >	myReport
	Enables/Disables the usage of OBB.
bool	myRunParallel
	Enables/Disables the usage of OBB.
double	myFuzzyValue
	Enables/Disables the usage of OBB.
bool	myUseOBB
	Enables/Disables the usage of OBB.
void	SetUseOBB (const bool theUseOBB)
	Enables/Disables the usage of OBB.
bool	UseOBB () const
	Returns the flag defining usage of OBB.
bool	UserBreak (const Message_ProgressScope &thePS)
	Adds error to the report if the break signal was caught. Returns true in this case, false otherwise.

Parallel processing mode
void	SetRunParallel (const bool 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.
bool	RunParallel () const
	Returns the flag of parallel processing.
static bool	GetParallelMode ()
	Gets the global parallel mode.
static void	SetParallelMode (const bool theNewMode)
	Sets the global parallel mode.

Detailed Description

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

• Memory allocation tool - tool for memory allocations;
• Error and warning reporting - allows recording warnings and errors occurred during the operation. Error means that the algorithm has failed.
• Parallel processing mode - provides the possibility to perform operation in parallel mode;
• Fuzzy tolerance - additional tolerance for the operation to detect touching or coinciding cases;
• Using the Oriented Bounding Boxes - Allows using the Oriented Bounding Boxes of the shapes for filtering the intersections.

Constructor & Destructor Documentation

BOPAlgo_Options() [1/2]

BOPAlgo_Options::BOPAlgo_Options

(

)

Empty constructor.

BOPAlgo_Options() [2/2]

BOPAlgo_Options::BOPAlgo_Options

(

const occ::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 occ::handle< Message_Alert > & theAlert )

inline

Adds the alert as error (fail)

AddWarning()

void BOPAlgo_Options::AddWarning ( const occ::handle< Message_Alert > & theAlert )

inline

Adds the alert as warning.

Allocator()

const occ::handle< NCollection_BaseAllocator > & BOPAlgo_Options::Allocator ( ) const

inline

Returns allocator.

Clear()

virtual void BOPAlgo_Options::Clear ( )

inlinevirtual

Clears all warnings and errors, and any data cached by the algorithm. User defined options are not cleared.

Reimplemented in BRepAlgoAPI_Algo, BOPAlgo_BOP, BOPAlgo_Builder, BOPAlgo_BuilderShape, BOPAlgo_CellsBuilder, BOPAlgo_MakeConnected, BOPAlgo_MakePeriodic, BOPAlgo_MakerVolume, BOPAlgo_PaveFiller, BOPAlgo_RemoveFeatures, BOPAlgo_ToolsProvider, BRepAlgoAPI_BuilderAlgo, BRepAlgoAPI_Defeaturing, and BRepFeat_Builder.

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()

double BOPAlgo_Options::FuzzyValue ( ) const

inline

Returns the additional tolerance.

GetParallelMode()

static bool BOPAlgo_Options::GetParallelMode ( )

static

Gets the global parallel mode.

GetReport()

const occ::handle< Message_Report > & BOPAlgo_Options::GetReport ( ) const

inline

Returns report collecting all errors and warnings.

HasError()

bool BOPAlgo_Options::HasError ( const occ::handle< Standard_Type > & theType ) const

inline

Returns true if algorithm has generated error of specified type.

HasErrors()

bool BOPAlgo_Options::HasErrors ( ) const

inline

Returns true if algorithm has failed.

HasWarning()

bool BOPAlgo_Options::HasWarning ( const occ::handle< Standard_Type > & theType ) const

inline

Returns true if algorithm has generated warning of specified type.

HasWarnings()

bool BOPAlgo_Options::HasWarnings ( ) const

inline

Returns true if algorithm has generated some warning alerts.

RunParallel()

bool BOPAlgo_Options::RunParallel ( ) const

inline

Returns the flag of parallel processing.

SetFuzzyValue()

void BOPAlgo_Options::SetFuzzyValue

(

const double

theFuzz

)

Sets the additional tolerance.

SetParallelMode()

static void BOPAlgo_Options::SetParallelMode ( const bool theNewMode )

static

Sets the global parallel mode.

SetRunParallel()

void BOPAlgo_Options::SetRunParallel ( const bool 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 bool theUseOBB )

inline

Enables/Disables the usage of OBB.

UseOBB()

bool BOPAlgo_Options::UseOBB ( ) const

inline

Returns the flag defining usage of OBB.

UserBreak()

bool BOPAlgo_Options::UserBreak ( const Message_ProgressScope & thePS )

protected

Adds error to the report if the break signal was caught. Returns true in this case, false otherwise.

Field Documentation

myAllocator

occ::handle<NCollection_BaseAllocator> BOPAlgo_Options::myAllocator

protected

Enables/Disables the usage of OBB.

myFuzzyValue

double BOPAlgo_Options::myFuzzyValue

protected

Enables/Disables the usage of OBB.

myReport

occ::handle<Message_Report> BOPAlgo_Options::myReport

protected

Enables/Disables the usage of OBB.

myRunParallel

bool BOPAlgo_Options::myRunParallel

protected

Enables/Disables the usage of OBB.

myUseOBB

bool BOPAlgo_Options::myUseOBB

protected

Enables/Disables the usage of OBB.

---

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

• BOPAlgo_Options.hxx