Open CASCADE Technology
7.7.0
|
The class provides the following options for the algorithms in Boolean Component: More...
#include <BOPAlgo_Options.hxx>
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... | |
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_BaseAllocator > | myAllocator |
Enables/Disables the usage of OBB. More... | |
Handle< Message_Report > | myReport |
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... | |
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... | |
Standard_Boolean | UserBreak (const Message_ProgressScope &thePS) |
Adds error to the report if the break signal was caught. Returns true in this case, false otherwise. More... | |
The class provides the following options for the algorithms in Boolean Component:
BOPAlgo_Options::BOPAlgo_Options | ( | ) |
Empty constructor.
BOPAlgo_Options::BOPAlgo_Options | ( | const Handle< NCollection_BaseAllocator > & | theAllocator | ) |
Constructor with allocator.
|
virtual |
Destructor.
|
inline |
Adds the alert as error (fail)
|
inline |
Adds the alert as warning.
|
inline |
Returns allocator.
|
inlinevirtual |
Clears all warnings and errors, and any data cached by the algorithm. User defined options are not cleared.
Reimplemented in BOPAlgo_MakePeriodic, BOPAlgo_MakeConnected, BRepAlgoAPI_BuilderAlgo, BOPAlgo_RemoveFeatures, BOPAlgo_PaveFiller, BRepAlgoAPI_Defeaturing, BOPAlgo_CellsBuilder, BOPAlgo_BuilderShape, BOPAlgo_MakerVolume, BOPAlgo_Builder, BOPAlgo_BOP, BRepFeat_Builder, and BOPAlgo_ToolsProvider.
|
inline |
Clears the warnings of the algorithm.
void BOPAlgo_Options::DumpErrors | ( | Standard_OStream & | theOS | ) | const |
Dumps the error status into the given stream.
void BOPAlgo_Options::DumpWarnings | ( | Standard_OStream & | theOS | ) | const |
Dumps the warning statuses into the given stream.
|
inline |
Returns the additional tolerance.
|
static |
Gets the global parallel mode.
|
inline |
Returns report collecting all errors and warnings.
|
inline |
Returns true if algorithm has generated error of specified type.
|
inline |
Returns true if algorithm has failed.
|
inline |
Returns true if algorithm has generated warning of specified type.
|
inline |
Returns true if algorithm has generated some warning alerts.
|
inline |
Returns the flag of parallel processing.
void BOPAlgo_Options::SetFuzzyValue | ( | const Standard_Real | theFuzz | ) |
Sets the additional tolerance.
|
static |
Sets the global parallel mode.
|
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.
|
inline |
Enables/Disables the usage of OBB.
|
inline |
Returns the flag defining usage of OBB.
|
protected |
Adds error to the report if the break signal was caught. Returns true in this case, false otherwise.
|
protected |
Enables/Disables the usage of OBB.
|
protected |
Enables/Disables the usage of OBB.
|
protected |
Enables/Disables the usage of OBB.
|
protected |
Enables/Disables the usage of OBB.
|
protected |
Enables/Disables the usage of OBB.