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

#include <BRepAlgoAPI_Algo.hxx>

Inheritance diagram for BRepAlgoAPI_Algo:

[legend]

Public Member Functions
const TopoDS_Shape &	Shape () override
	Returns a shape built by the shape construction algorithm. Does not check if the shape is built.

virtual void	Clear ()
	Clears all warnings and errors, and any data cached by the algorithm. User defined options are not cleared.

void	ClearWarnings ()
	Clears the warnings of the algorithm.

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.

double	FuzzyValue () const
	Returns the additional tolerance.

const occ::handle< Message_Report > &	GetReport () const
	Returns report collecting all errors and warnings.

bool	HasError (const occ::handle< Standard_Type > &theType) const
	Returns true if algorithm has generated error of specified type.

bool	HasErrors () const
	Returns true if algorithm has failed.

bool	HasWarning (const occ::handle< Standard_Type > &theType) const
	Returns true if algorithm has generated warning of specified type.

bool	HasWarnings () const
	Returns true if algorithm has generated some warning alerts.

bool	RunParallel () const
	Returns the flag of parallel processing.

void	SetFuzzyValue (const double theFuzz)
	Sets the additional tolerance.

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.

void	SetUseOBB (const bool theUseOBB)
	Enables/Disables the usage of OBB.

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.

	operator TopoDS_Shape ()

virtual const NCollection_List< TopoDS_Shape > &	Generated (const TopoDS_Shape &S)
	Returns the list of shapes generated from the shape .

virtual const NCollection_List< TopoDS_Shape > &	Modified (const TopoDS_Shape &S)
	Returns the list of shapes modified from the shape .

virtual bool	IsDeleted (const TopoDS_Shape &S)
	Returns true if the shape S has been deleted.

Public Member Functions inherited from BRepBuilderAPI_Command
virtual	~BRepBuilderAPI_Command ()

virtual bool	IsDone () const

void	Check () const
	Raises NotDone if done is false.

Protected Member Functions
	BRepAlgoAPI_Algo ()
	Empty constructor.

	~BRepAlgoAPI_Algo () override
	Destructor.

	BRepAlgoAPI_Algo (const occ::handle< NCollection_BaseAllocator > &theAllocator)
	Empty constructor.

Protected Member Functions inherited from BRepBuilderAPI_MakeShape
	BRepBuilderAPI_MakeShape ()

Protected Member Functions inherited from BRepBuilderAPI_Command
	BRepBuilderAPI_Command ()
	Set done to False.

void	Done ()
	Set done to true.

void	NotDone ()
	Set done to false.

Protected Member Functions inherited from BOPAlgo_Options
bool	UserBreak (const Message_ProgressScope &thePS)
	Adds error to the report if the break signal was caught. Returns true in this case, false otherwise.

	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.

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.

void	SetFuzzyValue (const double theFuzz)
	Sets the additional tolerance.

double	FuzzyValue () const
	Returns the additional tolerance.

void	SetUseOBB (const bool theUseOBB)
	Enables/Disables the usage of OBB.

bool	UseOBB () const
	Returns the flag defining usage of OBB.

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.

Additional Inherited Members
Static Protected Member Functions inherited from BOPAlgo_Options
static bool	GetParallelMode ()
	Gets the global parallel mode.

static void	SetParallelMode (const bool theNewMode)
	Sets the global parallel mode.

Protected Attributes inherited from BRepBuilderAPI_MakeShape
TopoDS_Shape	myShape

NCollection_List< TopoDS_Shape >	myGenerated

Protected Attributes inherited from BOPAlgo_Options
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.

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

BRepAlgoAPI_Algo::~BRepAlgoAPI_Algo ( )

overrideprotected

Destructor.

◆ BRepAlgoAPI_Algo() [2/2]

BRepAlgoAPI_Algo::BRepAlgoAPI_Algo ( const occ::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.

Reimplemented in BRepAlgoAPI_BuilderAlgo, and BRepAlgoAPI_Defeaturing.

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

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

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

◆ Shape()

const TopoDS_Shape & BRepAlgoAPI_Algo::Shape ( )

overridevirtual

Returns a shape built by the shape construction algorithm. Does not check if the shape is built.

Reimplemented from BRepBuilderAPI_MakeShape.

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

BRepAlgoAPI_Algo.hxx

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BRepAlgoAPI_Algo() [1/2]

◆ ~BRepAlgoAPI_Algo()

◆ BRepAlgoAPI_Algo() [2/2]

Member Function Documentation

◆ Clear()

◆ ClearWarnings()

◆ DumpErrors()

◆ DumpWarnings()

◆ FuzzyValue()

◆ GetReport()

◆ HasError()

◆ HasErrors()

◆ HasWarning()

◆ HasWarnings()

◆ RunParallel()

◆ SetFuzzyValue()

◆ SetRunParallel()

◆ SetUseOBB()

◆ Shape()