Open CASCADE Technology  7.6.0
Public Member Functions | Protected Member Functions

BRepAlgoAPI_Algo Class Reference

Provides the root interface for the API algorithms. More...

#include <BRepAlgoAPI_Algo.hxx>

Inheritance diagram for BRepAlgoAPI_Algo:
Inheritance graph
[legend]

Public Member Functions

virtual const TopoDS_ShapeShape () override
 Returns a shape built by the shape construction algorithm. Raises exception StdFail_NotDone if the shape was not built. More...
 
virtual void Clear ()
 Clears all warnings and errors, and any data cached by the algorithm. User defined options are not cleared. 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...
 
void SetFuzzyValue (const Standard_Real theFuzz)
 Sets the additional tolerance. More...
 
Standard_Real FuzzyValue () const
 Returns the additional tolerance. More...
 
Standard_Boolean HasErrors () const
 Returns true if algorithm has failed. More...
 
Standard_Boolean HasWarnings () const
 Returns true if algorithm has generated some warning alerts. More...
 
Standard_Boolean HasError (const Handle< Standard_Type > &theType) const
 Returns true if algorithm has generated error of specified type. More...
 
Standard_Boolean HasWarning (const Handle< Standard_Type > &theType) const
 Returns true if algorithm has generated warning of specified type. 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...
 
const Handle< Message_Report > & GetReport () const
 Returns report collecting all errors and warnings. More...
 
void SetUseOBB (const Standard_Boolean theUseOBB)
 Enables/Disables the usage of OBB. More...
 
- Public Member Functions inherited from BRepBuilderAPI_MakeShape
virtual void Build (const Message_ProgressRange &theRange=Message_ProgressRange())
 This is called by Shape(). It does nothing but may be redefined. More...
 
 operator TopoDS_Shape ()
 
virtual const TopTools_ListOfShapeGenerated (const TopoDS_Shape &S)
 Returns the list of shapes generated from the shape . More...
 
virtual const TopTools_ListOfShapeModified (const TopoDS_Shape &S)
 Returns the list of shapes modified from the shape . More...
 
virtual Standard_Boolean IsDeleted (const TopoDS_Shape &S)
 Returns true if the shape S has been deleted. More...
 
- Public Member Functions inherited from BRepBuilderAPI_Command
virtual ~BRepBuilderAPI_Command ()
 
virtual Standard_Boolean IsDone () const
 
void Check () const
 Raises NotDone if done is false. More...
 

Protected Member Functions

 BRepAlgoAPI_Algo ()
 Empty constructor. More...
 
virtual ~BRepAlgoAPI_Algo ()
 Destructor. More...
 
 BRepAlgoAPI_Algo (const Handle< NCollection_BaseAllocator > &theAllocator)
 Empty constructor. More...
 
- Protected Member Functions inherited from BRepBuilderAPI_MakeShape
 BRepBuilderAPI_MakeShape ()
 
- Protected Member Functions inherited from BRepBuilderAPI_Command
 BRepBuilderAPI_Command ()
 Set done to False. More...
 
void Done ()
 Set done to true. More...
 
void NotDone ()
 Set done to false. More...
 
- Protected Member Functions inherited from BOPAlgo_Options
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...
 
 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...
 
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 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...
 

Additional Inherited Members

- Static Protected 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 BRepBuilderAPI_MakeShape
TopoDS_Shape myShape
 
TopTools_ListOfShape myGenerated
 
- Protected Attributes inherited from BOPAlgo_Options
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...
 
Standard_Boolean myUseOBB
 Enables/Disables the usage of OBB. More...
 

Detailed Description

Provides the root interface for the API algorithms.

Constructor & Destructor Documentation

◆ BRepAlgoAPI_Algo() [1/2]

BRepAlgoAPI_Algo::BRepAlgoAPI_Algo ( )
protected

Empty constructor.

◆ ~BRepAlgoAPI_Algo()

virtual BRepAlgoAPI_Algo::~BRepAlgoAPI_Algo ( )
protectedvirtual

Destructor.

◆ BRepAlgoAPI_Algo() [2/2]

BRepAlgoAPI_Algo::BRepAlgoAPI_Algo ( const Handle< NCollection_BaseAllocator > &  theAllocator)
protected

Empty constructor.

Member Function Documentation

◆ 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 from BOPAlgo_Options.

◆ ClearWarnings()

void BOPAlgo_Options::ClearWarnings
inline

Clears the warnings of the algorithm.

◆ DumpErrors()

void BOPAlgo_Options::DumpErrors

Dumps the error status into the given stream.

◆ DumpWarnings()

void BOPAlgo_Options::DumpWarnings

Dumps the warning statuses into the given stream.

◆ FuzzyValue()

Standard_Real BOPAlgo_Options::FuzzyValue
inline

Returns the additional tolerance.

◆ GetReport()

const Handle< Message_Report >& BOPAlgo_Options::GetReport
inline

Returns report collecting all errors and warnings.

◆ HasError()

Standard_Boolean BOPAlgo_Options::HasError
inline

Returns true if algorithm has generated error of specified type.

◆ HasErrors()

Standard_Boolean BOPAlgo_Options::HasErrors
inline

Returns true if algorithm has failed.

◆ HasWarning()

Standard_Boolean BOPAlgo_Options::HasWarning
inline

Returns true if algorithm has generated warning of specified type.

◆ HasWarnings()

Standard_Boolean BOPAlgo_Options::HasWarnings
inline

Returns true if algorithm has generated some warning alerts.

◆ RunParallel()

Standard_Boolean BOPAlgo_Options::RunParallel
inline

Returns the flag of parallel processing.

◆ SetFuzzyValue()

void BOPAlgo_Options::SetFuzzyValue

Sets the additional tolerance.

◆ SetRunParallel()

void BOPAlgo_Options::SetRunParallel
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
inline

Enables/Disables the usage of OBB.

◆ Shape()

virtual const TopoDS_Shape& BRepAlgoAPI_Algo::Shape ( )
overridevirtual

Returns a shape built by the shape construction algorithm. Raises exception StdFail_NotDone if the shape was not built.

Reimplemented from BRepBuilderAPI_MakeShape.


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