The class provides the root interface for the algorithms in Boolean Component.
More...
#include <BOPAlgo_Algo.hxx>
Inheritance diagram for BOPAlgo_Algo:
Public Member Functions | |
| virtual void | Perform ()=0 |
 Public Member Functions inherited from BOPAlgo_Options | |
| 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... | |
| 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... | |
| void | SetFuzzyValue (const Standard_Real theFuzz) |
| Sets the additional tolerance. More... | |
| Standard_Real | FuzzyValue () const |
| Returns the additional tolerance. More... | |
| void | SetProgressIndicator (const Message_ProgressScope &theProgress) |
| Set the Progress Indicator object. 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 | 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... | |
Protected Member Functions | |
| BOPAlgo_Algo () | |
| Default constructor. More... | |
| virtual | ~BOPAlgo_Algo () |
| BOPAlgo_Algo (const Handle< NCollection_BaseAllocator > &theAllocator) | |
| virtual void | CheckData () |
| Checks input data. More... | |
| virtual void | CheckResult () |
| Checks the obtained result. More... | |
| Protected Member Functions inherited from BOPAlgo_Options | |
| void | UserBreak () const |
| Breaks the execution if the break signal is indicated by myProgressIndicator. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from BOPAlgo_Options | |
| static Standard_Boolean | GetParallelMode () |
| Gets the global parallel mode. More... | |
| static void | SetParallelMode (const Standard_Boolean theNewMode) |
| Sets the global parallel mode. More... | |
| Protected Attributes inherited from BOPAlgo_Options | |
| 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... | |
| const Message_ProgressScope * | myProgressScope |
| Enables/Disables the usage of OBB. More... | |
| Standard_Boolean | myUseOBB |
| Enables/Disables the usage of OBB. More... | |
Detailed Description
The class provides the root interface for the algorithms in Boolean Component.
Constructor & Destructor Documentation
◆ BOPAlgo_Algo() [1/2]
|
protected |
Default constructor.
◆ ~BOPAlgo_Algo()
|
protectedvirtual |
◆ BOPAlgo_Algo() [2/2]
|
protected |
Member Function Documentation
◆ CheckData()
|
protectedvirtual |
Checks input data.
Reimplemented in BOPAlgo_Builder, BOPAlgo_RemoveFeatures, BOPAlgo_MakerVolume, BOPAlgo_BOP, BOPAlgo_BuilderFace, BOPAlgo_WireSplitter, BOPAlgo_Splitter, and BOPAlgo_Section.
◆ CheckResult()
|
protectedvirtual |
Checks the obtained result.
◆ Perform()
|
pure virtual |
The documentation for this class was generated from the following file:
