Open CASCADE Technology  7.5.0.beta
BRepAlgoAPI_Check Class Reference

The class Check provides a diagnostic tool for checking the validity of the single shape or couple of shapes. The shapes are checked on: More...

#include <BRepAlgoAPI_Check.hxx>

Inheritance diagram for BRepAlgoAPI_Check:
Inheritance graph
[legend]

Public Member Functions

Constructors
 BRepAlgoAPI_Check ()
 Empty constructor. More...
 
virtual ~BRepAlgoAPI_Check ()
 Empty constructor. More...
 
 BRepAlgoAPI_Check (const TopoDS_Shape &theS, const Standard_Boolean bTestSE=Standard_True, const Standard_Boolean bTestSI=Standard_True)
 Constructor for checking single shape. 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 checking the couple of shapes. Additionally to the validity checks of each given shape, the types of the given shapes will be checked on validity for Boolean operation of given type. More...
 
Initializing the algorithm
void SetData (const TopoDS_Shape &theS, const Standard_Boolean bTestSE=Standard_True, const Standard_Boolean bTestSI=Standard_True)
 Initializes the algorithm with 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)
 Initializes the algorithm with couple of shapes. Additionally to the validity checks of each given shape, the types of the given shapes will be checked on validity for Boolean operation of given type. More...
 
Performing the operation
void Perform ()
 Performs the check. More...
 
Getting the results.
Standard_Boolean IsValid ()
 Shows whether shape(s) valid or not. More...
 
const BOPAlgo_ListOfCheckResultResult ()
 Returns faulty shapes. More...
 
- Public Member Functions inherited from BOPAlgo_Options
 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...
 
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 Message_ProgressScope &theProgress)
 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...
 
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...
 

Protected Attributes

Fields
TopoDS_Shape myS1
 The first shape. More...
 
TopoDS_Shape myS2
 The second shape. More...
 
Standard_Boolean myTestSE
 Flag defining whether to look for small edges in the given shapes or not. More...
 
Standard_Boolean myTestSI
 Flag defining whether to check the input edges on self-interference or not. More...
 
BOPAlgo_Operation myOperation
 Type of Boolean operation for which the validity of input shapes should be checked. More...
 
BOPAlgo_ListOfCheckResult myFaultyShapes
 Found faulty shapes. More...
 
- 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...
 
const Message_ProgressScopemyProgressScope
 Enables/Disables the usage of OBB. More...
 
Standard_Boolean myUseOBB
 Enables/Disables the usage of OBB. 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...
 
- Protected Member Functions inherited from BOPAlgo_Options
void UserBreak () const
 Breaks the execution if the break signal is indicated by myProgressIndicator. More...
 

Detailed Description

The class Check provides a diagnostic tool for checking the validity of the single shape or couple of shapes. The shapes are checked on:

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

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

Constructor & Destructor Documentation

◆ BRepAlgoAPI_Check() [1/3]

BRepAlgoAPI_Check::BRepAlgoAPI_Check ( )

Empty constructor.

◆ ~BRepAlgoAPI_Check()

virtual BRepAlgoAPI_Check::~BRepAlgoAPI_Check ( )
virtual

Empty constructor.

◆ BRepAlgoAPI_Check() [2/3]

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.

Parameters
theS[in] - the shape to check;
bTestSE[in] - flag which specifies whether to check the shape on small edges or not; by default it is set to TRUE;
bTestSI[in] - flag which specifies whether to check the shape on self-interference or not; by default it is set to TRUE;

◆ BRepAlgoAPI_Check() [3/3]

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 checking the couple of shapes. Additionally to the validity checks of each given shape, the types of the given shapes will be checked on validity for Boolean operation of given type.

Parameters
theS1[in] - the first shape to check;
theS2[in] - the second shape to check;
theOp[in] - the type of Boolean Operation for which the validity of given shapes should be checked.
bTestSE[in] - flag which specifies whether to check the shape on small edges or not; by default it is set to TRUE;
bTestSI[in] - flag which specifies whether to check the shape on self-interference or not; by default it is set to TRUE;

Member Function Documentation

◆ IsValid()

Standard_Boolean BRepAlgoAPI_Check::IsValid ( )
inline

Shows whether shape(s) valid or not.

◆ Perform()

void BRepAlgoAPI_Check::Perform ( )

Performs the check.

◆ Result()

const BOPAlgo_ListOfCheckResult& BRepAlgoAPI_Check::Result ( )
inline

Returns faulty shapes.

◆ SetData() [1/2]

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

Initializes the algorithm with single shape.

Parameters
theS[in] - the shape to check;
bTestSE[in] - flag which specifies whether to check the shape on small edges or not; by default it is set to TRUE;
bTestSI[in] - flag which specifies whether to check the shape on self-interference or not; by default it is set to TRUE;

◆ SetData() [2/2]

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

Initializes the algorithm with couple of shapes. Additionally to the validity checks of each given shape, the types of the given shapes will be checked on validity for Boolean operation of given type.

Parameters
theS1[in] - the first shape to check;
theS2[in] - the second shape to check;
theOp[in] - the type of Boolean Operation for which the validity of given shapes should be checked.
bTestSE[in] - flag which specifies whether to check the shape on small edges or not; by default it is set to TRUE;
bTestSI[in] - flag which specifies whether to check the shape on self-interference or not; by default it is set to TRUE;

Field Documentation

◆ myFaultyShapes

BOPAlgo_ListOfCheckResult BRepAlgoAPI_Check::myFaultyShapes
protected

Found faulty shapes.

◆ myOperation

BOPAlgo_Operation BRepAlgoAPI_Check::myOperation
protected

Type of Boolean operation for which the validity of input shapes should be checked.

◆ myS1

TopoDS_Shape BRepAlgoAPI_Check::myS1
protected

The first shape.

◆ myS2

TopoDS_Shape BRepAlgoAPI_Check::myS2
protected

The second shape.

◆ myTestSE

Standard_Boolean BRepAlgoAPI_Check::myTestSE
protected

Flag defining whether to look for small edges in the given shapes or not.

◆ myTestSI

Standard_Boolean BRepAlgoAPI_Check::myTestSI
protected

Flag defining whether to check the input edges on self-interference or not.


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