BOPAlgo_BuilderShape Class Reference

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

#include <BOPAlgo_BuilderShape.hxx>

Inheritance diagram for BOPAlgo_BuilderShape:

Public Member Functions
const TopoDS_Shape &	Shape () const
	Returns the result of algorithm. More...
virtual const TopTools_ListOfShape &	Generated (const TopoDS_Shape &theS)
	Returns the list of shapes generated from the shape theS. More...
virtual const TopTools_ListOfShape &	Modified (const TopoDS_Shape &theS)
	Returns the list of shapes modified from the shape theS. More...
virtual Standard_Boolean	IsDeleted (const TopoDS_Shape &theS)
	Returns true if the shape theS has been deleted. More...
Standard_Boolean	HasDeleted () const
	Returns true if the at least one shape(or subshape) of arguments has been deleted. More...
Standard_Boolean	HasGenerated () const
	Returns true if the at least one shape(or subshape) of arguments has generated shapes. More...
Standard_Boolean	HasModified () const
	Returns true if the at least one shape(or subshape) of arguments has modified shapes. More...
const BOPCol_IndexedDataMapOfShapeListOfShape &	ImagesResult () const
Public Member Functions inherited from BOPAlgo_Algo
virtual void	Perform ()=0
Public Member Functions inherited from BOPAlgo_Options
	BOPAlgo_Options ()
	Empty constructor. More...
	BOPAlgo_Options (const BOPCol_BaseAllocator &theAllocator)
	Constructor with allocator. More...
virtual	~BOPAlgo_Options ()
	Destructor. More...
const BOPCol_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 Handle< Message_ProgressIndicator > &theObj)
	Set the Progress Indicator object. 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_BuilderShape ()
virtual	~BOPAlgo_BuilderShape ()
	BOPAlgo_BuilderShape (const BOPCol_BaseAllocator &theAllocator)
virtual void	PrepareHistory ()
	Prepare information for history support. More...
Protected Member Functions inherited from BOPAlgo_Algo
	BOPAlgo_Algo ()
	Default constructor. More...
virtual	~BOPAlgo_Algo ()
	BOPAlgo_Algo (const BOPCol_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...

Protected Attributes
TopoDS_Shape	myShape
TopTools_ListOfShape	myHistShapes
BOPCol_MapOfShape	myMapShape
Standard_Boolean	myHasDeleted
Standard_Boolean	myHasGenerated
Standard_Boolean	myHasModified
BOPCol_IndexedDataMapOfShapeListOfShape	myImagesResult
Standard_Boolean	myFlagHistory
Protected Attributes inherited from BOPAlgo_Options
BOPCol_BaseAllocator	myAllocator
	Set the Progress Indicator object. More...
Handle< Message_Report >	myReport
	Set the Progress Indicator object. More...
Standard_Boolean	myRunParallel
	Set the Progress Indicator object. More...
Standard_Real	myFuzzyValue
	Set the Progress Indicator object. More...
Handle< Message_ProgressIndicator >	myProgressIndicator
	Set the Progress Indicator object. 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...

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.

Constructor & Destructor Documentation

BOPAlgo_BuilderShape() [1/2]

BOPAlgo_BuilderShape::BOPAlgo_BuilderShape ( )

protected

~BOPAlgo_BuilderShape()

virtual BOPAlgo_BuilderShape::~BOPAlgo_BuilderShape ( )

protectedvirtual

BOPAlgo_BuilderShape() [2/2]

BOPAlgo_BuilderShape::BOPAlgo_BuilderShape ( const BOPCol_BaseAllocator &  theAllocator )

protected

Member Function Documentation

Generated()

virtual const TopTools_ListOfShape& BOPAlgo_BuilderShape::Generated ( const TopoDS_Shape &  theS )

virtual

Returns the list of shapes generated from the shape theS.

Reimplemented in BOPAlgo_Builder, and BOPAlgo_Section.

HasDeleted()

Standard_Boolean BOPAlgo_BuilderShape::HasDeleted

(

)

const

Returns true if the at least one shape(or subshape) of arguments has been deleted.

HasGenerated()

Standard_Boolean BOPAlgo_BuilderShape::HasGenerated

(

)

const

Returns true if the at least one shape(or subshape) of arguments has generated shapes.

HasModified()

Standard_Boolean BOPAlgo_BuilderShape::HasModified

(

)

const

Returns true if the at least one shape(or subshape) of arguments has modified shapes.

ImagesResult()

const BOPCol_IndexedDataMapOfShapeListOfShape& BOPAlgo_BuilderShape::ImagesResult

(

)

const

IsDeleted()

virtual Standard_Boolean BOPAlgo_BuilderShape::IsDeleted ( const TopoDS_Shape &  theS )

virtual

Returns true if the shape theS has been deleted.

Reimplemented in BOPAlgo_CellsBuilder, and BOPAlgo_Builder.

Modified()

virtual const TopTools_ListOfShape& BOPAlgo_BuilderShape::Modified ( const TopoDS_Shape &  theS )

virtual

Returns the list of shapes modified from the shape theS.

Reimplemented in BOPAlgo_CellsBuilder, and BOPAlgo_Builder.

PrepareHistory()

virtual void BOPAlgo_BuilderShape::PrepareHistory ( )

protectedvirtual

Prepare information for history support.

Reimplemented in BOPAlgo_Builder.

Shape()

const TopoDS_Shape& BOPAlgo_BuilderShape::Shape

(

)

const

Returns the result of algorithm.

Field Documentation

myFlagHistory

Standard_Boolean BOPAlgo_BuilderShape::myFlagHistory

protected

myHasDeleted

Standard_Boolean BOPAlgo_BuilderShape::myHasDeleted

protected

myHasGenerated

Standard_Boolean BOPAlgo_BuilderShape::myHasGenerated

protected

myHasModified

Standard_Boolean BOPAlgo_BuilderShape::myHasModified

protected

myHistShapes

TopTools_ListOfShape BOPAlgo_BuilderShape::myHistShapes

protected

myImagesResult

BOPCol_IndexedDataMapOfShapeListOfShape BOPAlgo_BuilderShape::myImagesResult

protected

myMapShape

BOPCol_MapOfShape BOPAlgo_BuilderShape::myMapShape

protected

myShape

TopoDS_Shape BOPAlgo_BuilderShape::myShape

protected

---

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

• BOPAlgo_BuilderShape.hxx