The class Check provides a diagnostic tool for checking single shape or couple of shapes. Single shape is checking on topological validity, small edges and self-interference. For couple of shapes added check on validity for boolean operation of given type. More...

#include <BRepAlgoAPI_Check.hxx>

Inheritance diagram for BRepAlgoAPI_Check:

[legend]

Public Member Functions
	BRepAlgoAPI_Check ()
	Empty constructor. More...

virtual	~BRepAlgoAPI_Check ()

	BRepAlgoAPI_Check (const TopoDS_Shape &theS, const Standard_Boolean bTestSE=Standard_True, const Standard_Boolean bTestSI=Standard_True)
	Constructor for checking single shape. It calls methods Init(theS, TopoDS_Shape(), BOPAlgo_UNKNOWN, bTestSE, bTestSI) and Perform(). Params: theS - the shape that should be checked; bTestSE - flag that specifies whether check on small edges should be performed; by default it is set to TRUE; bTestSI - flag that specifies whether check on self-interference should be performed; by default it is set to TRUE;. More...

	BRepAlgoAPI_Check (const TopoDS_Shape &theS1, const TopoDS_Shape &theS2, const BOPAlgo_Operation theOp=BOPAlgo_UNKNOWN, const Standard_Boolean bTestSE=Standard_True, const Standard_Boolean bTestSI=Standard_True)
	Constructor for couple of shapes. It calls methods Init(theS1, theS2, theOp, bTestSE, bTestSI) and Perform(). Params: theS1, theS2 - the initial shapes. theOp - the type of Boolean Operation; if it is not defined (set to UNKNOWN) for each shape performed check as for single shape. bTestSE - flag that specifies whether check on small edges should be performed; by default it is set to TRUE; bTestSI - flag that specifies whether check on self-interference should be performed; by default it is set to TRUE;. More...

void	SetData (const TopoDS_Shape &theS, const Standard_Boolean bTestSE=Standard_True, const Standard_Boolean bTestSI=Standard_True)
	Sets data for check by Init method. The method provides alternative way for checking single shape. More...

void	SetData (const TopoDS_Shape &theS1, const TopoDS_Shape &theS2, const BOPAlgo_Operation theOp=BOPAlgo_UNKNOWN, const Standard_Boolean bTestSE=Standard_True, const Standard_Boolean bTestSI=Standard_True)
	Sets data for check by Init method. The method provides alternative way for checking couple of shapes. More...

void	Perform ()
	Performs the check. More...

Standard_Boolean	IsValid ()
	Shows whether shape(s) valid or not. More...

const BOPAlgo_ListOfCheckResult &	Result ()
	Returns faulty shapes. More...

void	SetFuzzyValue (const Standard_Real theFuzz)
	Sets the additional tolerance. More...

Standard_Real	FuzzyValue () const
	Returns the additional tolerance. More...

Public Member Functions inherited from BRepAlgoAPI_Algo
Standard_Integer	ErrorStatus () const
	Returns error status of the algorithm ==0 - no errors occured !=0 - is in the event of various error conditions. More...

Standard_Integer	WarningStatus () const
	Returns warning status of the algorithm ==0 - no warning occured !=0 - is in the event of various warning conditions. More...

const BOPCol_BaseAllocator &	Allocator () const

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	SetProgressIndicator (const Handle< Message_ProgressIndicator > &theObj)
	Set the Progress Indicator object. More...

virtual const TopoDS_Shape &	Shape () override
	Returns a shape built by the shape construction algorithm. Raises exception StdFail_NotDone if the shape was not built. More...

Public Member Functions inherited from BRepBuilderAPI_MakeShape
virtual void	Build ()
	This is called by Shape(). It does nothing but may be redefined. More...

	operator TopoDS_Shape ()

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

virtual const TopTools_ListOfShape &	Modified (const TopoDS_Shape &S)
	Returns the list of shapes modified from the shape <S>. 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
void	Init (const TopoDS_Shape &theS1, const TopoDS_Shape &theS2, const BOPAlgo_Operation theOp, const Standard_Boolean bTestSE, const Standard_Boolean bTestSI)
	Initialyzes data. More...

Protected Member Functions inherited from BRepAlgoAPI_Algo
	BRepAlgoAPI_Algo ()
	Empty constructor. More...

virtual	~BRepAlgoAPI_Algo ()

	BRepAlgoAPI_Algo (const BOPCol_BaseAllocator &theAllocator)
	Empty constructor. More...

void	UserBreak () const
	Breaks the execution if the break signal is indicated by myProgressIndicator. More...

virtual void	Clear ()

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 Attributes
TopoDS_Shape	myS1

TopoDS_Shape	myS2

BOPAlgo_PArgumentAnalyzer	myAnalyzer

BOPAlgo_ListOfCheckResult	myResult

Standard_Real	myFuzzyValue

Protected Attributes inherited from BRepAlgoAPI_Algo
BOPCol_BaseAllocator	myAllocator

Standard_Integer	myErrorStatus

Standard_Integer	myWarningStatus

Standard_Boolean	myRunParallel

Handle< Message_ProgressIndicator >	myProgressIndicator

Protected Attributes inherited from BRepBuilderAPI_MakeShape
TopoDS_Shape	myShape

TopTools_ListOfShape	myGenerated

Detailed Description

The class Check provides a diagnostic tool for checking single shape or couple of shapes. Single shape is checking on topological validity, small edges and self-interference. For couple of shapes added check on validity for boolean operation of given type.

The class provides two ways of checking shape(-s)

Constructors BRepAlgoAPI_Check aCh(theS); Standard_Boolean bV=aCh.IsValid();
Methods SetData and Perform BRepAlgoAPI_Check aCh; aCh.SetData(theS1, theS2, BOPAlgo_FUSE, Standard_False); aCh.Perform(); Standard_Boolean bV=aCh.IsValid();

Constructor & Destructor Documentation

BRepAlgoAPI_Check::BRepAlgoAPI_Check ( )

Empty constructor.

virtual BRepAlgoAPI_Check::~BRepAlgoAPI_Check ( )

virtual

BRepAlgoAPI_Check::BRepAlgoAPI_Check	(	const TopoDS_Shape &	theS,
		const Standard_Boolean	bTestSE = `Standard_True`,
		const Standard_Boolean	bTestSI = `Standard_True`
	)

Constructor for checking single shape. It calls methods Init(theS, TopoDS_Shape(), BOPAlgo_UNKNOWN, bTestSE, bTestSI) and Perform(). Params: theS - the shape that should be checked; bTestSE - flag that specifies whether check on small edges should be performed; by default it is set to TRUE; bTestSI - flag that specifies whether check on self-interference should be performed; by default it is set to TRUE;.

BRepAlgoAPI_Check::BRepAlgoAPI_Check	(	const TopoDS_Shape &	theS1,
		const TopoDS_Shape &	theS2,
		const BOPAlgo_Operation	theOp = `BOPAlgo_UNKNOWN`,
		const Standard_Boolean	bTestSE = `Standard_True`,
		const Standard_Boolean	bTestSI = `Standard_True`
	)

Constructor for couple of shapes. It calls methods Init(theS1, theS2, theOp, bTestSE, bTestSI) and Perform(). Params: theS1, theS2 - the initial shapes. theOp - the type of Boolean Operation; if it is not defined (set to UNKNOWN) for each shape performed check as for single shape. bTestSE - flag that specifies whether check on small edges should be performed; by default it is set to TRUE; bTestSI - flag that specifies whether check on self-interference should be performed; by default it is set to TRUE;.

Member Function Documentation

Standard_Real BRepAlgoAPI_Check::FuzzyValue ( ) const

Returns the additional tolerance.

void BRepAlgoAPI_Check::Init	(	const TopoDS_Shape &	theS1,
		const TopoDS_Shape &	theS2,
		const BOPAlgo_Operation	theOp,
		const Standard_Boolean	bTestSE,
		const Standard_Boolean	bTestSI
	)

protected

Initialyzes data.

Standard_Boolean BRepAlgoAPI_Check::IsValid ( )

Shows whether shape(s) valid or not.

void BRepAlgoAPI_Check::Perform ( )

Performs the check.

const BOPAlgo_ListOfCheckResult& BRepAlgoAPI_Check::Result ( )

Returns faulty shapes.

void BRepAlgoAPI_Check::SetData	(	const TopoDS_Shape &	theS,
		const Standard_Boolean	bTestSE = `Standard_True`,
		const Standard_Boolean	bTestSI = `Standard_True`
	)

Sets data for check by Init method. The method provides alternative way for checking single shape.

void BRepAlgoAPI_Check::SetData	(	const TopoDS_Shape &	theS1,
		const TopoDS_Shape &	theS2,
		const BOPAlgo_Operation	theOp = `BOPAlgo_UNKNOWN`,
		const Standard_Boolean	bTestSE = `Standard_True`,
		const Standard_Boolean	bTestSI = `Standard_True`
	)

Sets data for check by Init method. The method provides alternative way for checking couple of shapes.

void BRepAlgoAPI_Check::SetFuzzyValue ( const Standard_Real theFuzz )

Sets the additional tolerance.

Field Documentation

BOPAlgo_PArgumentAnalyzer BRepAlgoAPI_Check::myAnalyzer

protected

Standard_Real BRepAlgoAPI_Check::myFuzzyValue

protected

BOPAlgo_ListOfCheckResult BRepAlgoAPI_Check::myResult

protected

TopoDS_Shape BRepAlgoAPI_Check::myS1

protected

TopoDS_Shape BRepAlgoAPI_Check::myS2

protected

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

BRepAlgoAPI_Check.hxx

BRepAlgoAPI_Check Class Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation