Root class for algorithms that has shape as result. More...

#include <BOPAlgo_BuilderShape.hxx>

Inheritance diagram for BOPAlgo_BuilderShape:

[legend]

Public Member Functions
Getting the result
Returns the result of algorithm
const TopoDS_Shape &	Shape () const

History methods
Returns the list of shapes Modified from the shape theS.
const NCollection_List< TopoDS_Shape > &	Modified (const TopoDS_Shape &theS)
	Returns the list of shapes Generated from the shape theS.

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

bool	IsDeleted (const TopoDS_Shape &theS)
	Returns true if the shape theS has been deleted. In this case the shape will have no Modified elements, but can have Generated elements.

bool	HasModified () const
	Returns true if any of the input shapes has been modified during operation.

bool	HasGenerated () const
	Returns true if any of the input shapes has generated shapes during operation.

bool	HasDeleted () const
	Returns true if any of the input shapes has been deleted during operation.

occ::handle< BRepTools_History >	History ()
	History Tool.

Enabling/Disabling the history collection.
Allows disabling the history collection
void	SetToFillHistory (const bool theHistFlag)
	Returns flag of history availability.

bool	HasHistory () const
	Returns flag of history availability.

Public Member Functions inherited from BOPAlgo_Algo
virtual void	Perform (const Message_ProgressRange &theRange=Message_ProgressRange())=0
	The main method to implement the operation Providing the range allows to enable Progress indicator User break functionalities.

Public Member Functions inherited from BOPAlgo_Options
	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.

Protected Member Functions
Constructors
Empty constructor
	BOPAlgo_BuilderShape ()
	Constructor with allocator.

	BOPAlgo_BuilderShape (const occ::handle< NCollection_BaseAllocator > &theAllocator)
	Constructor with allocator.

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

Protected Member Functions inherited from BOPAlgo_Algo
	BOPAlgo_Algo ()
	Default constructor.

	~BOPAlgo_Algo () override

	BOPAlgo_Algo (const occ::handle< NCollection_BaseAllocator > &theAllocator)

virtual void	CheckData ()
	Checks input data.

virtual void	CheckResult ()
	Checks the obtained result.

void	analyzeProgress (const double theWhole, BOPAlgo_PISteps &theSteps) const
	Fills the values for constant operations - the operations having constant relative running time.

virtual void	fillPIConstants (const double theWhole, BOPAlgo_PISteps &theSteps) const
	Fills the values for constant operations - the operations having constant relative running time.

virtual void	fillPISteps (BOPAlgo_PISteps &theSteps) const
	Fills the values for the operations dependent on the inputs. Filled values may not be normalized to represent percentage of total running time. The values should just correlate to each other. E.g. if progress depends on the number of input shapes, the values may look like this: step1 = number_of_input_vertices; step2 = 2 * number_of_input_edges; step3 = 10 * number_of_input_faces. Normalization of these values will be done automatically in analyzeProgress() method.

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.

Protected Attributes
Fields
TopoDS_Shape	myShape
	Result of the operation.

NCollection_List< TopoDS_Shape >	myHistShapes
	Storer for the history shapes.

NCollection_Map< TopoDS_Shape, TopTools_ShapeMapHasher >	myMapShape
	cached map of all arguments shapes

bool	myFillHistory
	Controls the history filling.

occ::handle< BRepTools_History >	myHistory
	History tool.

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.

Additional Inherited Members
Static Public 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.

Detailed Description

Root class for algorithms that has shape as result.

The class provides the History mechanism, which allows tracking the modification of the input shapes during the operation. It uses the BRepTools_History tool as a storer for history objects.

Constructor & Destructor Documentation

◆ BOPAlgo_BuilderShape() [1/2]

BOPAlgo_BuilderShape::BOPAlgo_BuilderShape ( )

inlineprotected

Constructor with allocator.

◆ BOPAlgo_BuilderShape() [2/2]

BOPAlgo_BuilderShape::BOPAlgo_BuilderShape ( const occ::handle< NCollection_BaseAllocator > & theAllocator )

inlineprotected

Constructor with allocator.

Member Function Documentation

◆ Clear()

void BOPAlgo_BuilderShape::Clear ( )

inlineoverrideprotectedvirtual

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

Reimplemented from BOPAlgo_Options.

Reimplemented in BOPAlgo_CellsBuilder, BOPAlgo_MakerVolume, BOPAlgo_RemoveFeatures, BOPAlgo_ToolsProvider, and BRepFeat_Builder.

◆ Generated()

const NCollection_List< TopoDS_Shape > & BOPAlgo_BuilderShape::Generated ( const TopoDS_Shape & theS )

inline

Returns the list of shapes Generated from the shape theS.

◆ HasDeleted()

bool BOPAlgo_BuilderShape::HasDeleted ( ) const

inline

Returns true if any of the input shapes has been deleted during operation.

◆ HasGenerated()

bool BOPAlgo_BuilderShape::HasGenerated ( ) const

inline

Returns true if any of the input shapes has generated shapes during operation.

◆ HasHistory()

bool BOPAlgo_BuilderShape::HasHistory ( ) const

inline

Returns flag of history availability.

◆ HasModified()

bool BOPAlgo_BuilderShape::HasModified ( ) const

inline

Returns true if any of the input shapes has been modified during operation.

◆ History()

occ::handle< BRepTools_History > BOPAlgo_BuilderShape::History ( )

inline

History Tool.

◆ IsDeleted()

bool BOPAlgo_BuilderShape::IsDeleted ( const TopoDS_Shape & theS )

inline

Returns true if the shape theS has been deleted. In this case the shape will have no Modified elements, but can have Generated elements.

◆ Modified()

const NCollection_List< TopoDS_Shape > & BOPAlgo_BuilderShape::Modified ( const TopoDS_Shape & theS )

inline

Returns the list of shapes Generated from the shape theS.

◆ SetToFillHistory()

void BOPAlgo_BuilderShape::SetToFillHistory ( const bool theHistFlag )

inline

Returns flag of history availability.

◆ Shape()

const TopoDS_Shape & BOPAlgo_BuilderShape::Shape ( ) const

inline

Field Documentation

◆ myFillHistory

bool BOPAlgo_BuilderShape::myFillHistory

protected

Controls the history filling.

◆ myHistory

occ::handle<BRepTools_History> BOPAlgo_BuilderShape::myHistory

protected

History tool.

◆ myHistShapes

NCollection_List<TopoDS_Shape> BOPAlgo_BuilderShape::myHistShapes

protected

Storer for the history shapes.

◆ myMapShape

NCollection_Map<TopoDS_Shape, TopTools_ShapeMapHasher> BOPAlgo_BuilderShape::myMapShape

protected

cached map of all arguments shapes

◆ myShape

TopoDS_Shape BOPAlgo_BuilderShape::myShape

protected

Result of the operation.

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

BOPAlgo_BuilderShape.hxx

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BOPAlgo_BuilderShape() [1/2]

◆ BOPAlgo_BuilderShape() [2/2]

Member Function Documentation

◆ Clear()

◆ Generated()

◆ HasDeleted()

◆ HasGenerated()

◆ HasHistory()

◆ HasModified()

◆ History()

◆ IsDeleted()

◆ Modified()

◆ SetToFillHistory()

◆ Shape()

Field Documentation

◆ myFillHistory

◆ myHistory

◆ myHistShapes

◆ myMapShape

◆ myShape