Open CASCADE Technology Reference Manual 8.0.0
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
BOPAlgo_WireSplitter Class Reference

The class is to build loops from the given set of edges. More...

#include <BOPAlgo_WireSplitter.hxx>

Inheritance diagram for BOPAlgo_WireSplitter:
Inheritance graph
[legend]

Public Member Functions

 BOPAlgo_WireSplitter ()
 
 ~BOPAlgo_WireSplitter () override
 
 BOPAlgo_WireSplitter (const occ::handle< NCollection_BaseAllocator > &theAllocator)
 
void SetWES (const BOPAlgo_WireEdgeSet &theWES)
 
BOPAlgo_WireEdgeSetWES ()
 
void SetContext (const occ::handle< IntTools_Context > &theContext)
 Sets the context for the algorithm.
 
const occ::handle< IntTools_Context > & Context ()
 Returns the context.
 
void Perform (const Message_ProgressRange &theRange=Message_ProgressRange()) override
 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.
 
virtual void Clear ()
 Clears all warnings and errors, and any data cached by the algorithm. User defined options are not cleared.
 
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.
 

Static Public Member Functions

static void MakeWire (NCollection_List< TopoDS_Shape > &theLE, TopoDS_Wire &theW)
 
static void SplitBlock (const TopoDS_Face &theF, BOPTools_ConnexityBlock &theCB, const occ::handle< IntTools_Context > &theContext)
 
- 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.
 

Protected Member Functions

void CheckData () override
 Checks input data.
 
void MakeWires (const Message_ProgressRange &theRange)
 
- Protected Member Functions inherited from BOPAlgo_Algo
 BOPAlgo_Algo ()
 Default constructor.
 
 ~BOPAlgo_Algo () override
 
 BOPAlgo_Algo (const occ::handle< NCollection_BaseAllocator > &theAllocator)
 
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

BOPAlgo_PWireEdgeSet myWES
 
NCollection_List< BOPTools_ConnexityBlockmyLCB
 
occ::handle< IntTools_ContextmyContext
 
- Protected Attributes inherited from BOPAlgo_Options
occ::handle< NCollection_BaseAllocatormyAllocator
 Enables/Disables the usage of OBB.
 
occ::handle< Message_ReportmyReport
 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

The class is to build loops from the given set of edges.

It returns the following Error statuses

Constructor & Destructor Documentation

◆ BOPAlgo_WireSplitter() [1/2]

BOPAlgo_WireSplitter::BOPAlgo_WireSplitter ( )

◆ ~BOPAlgo_WireSplitter()

BOPAlgo_WireSplitter::~BOPAlgo_WireSplitter ( )
override

◆ BOPAlgo_WireSplitter() [2/2]

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

Member Function Documentation

◆ CheckData()

void BOPAlgo_WireSplitter::CheckData ( )
overrideprotectedvirtual

Checks input data.

Reimplemented from BOPAlgo_Algo.

◆ Context()

const occ::handle< IntTools_Context > & BOPAlgo_WireSplitter::Context ( )

Returns the context.

◆ MakeWire()

static void BOPAlgo_WireSplitter::MakeWire ( NCollection_List< TopoDS_Shape > & theLE,
TopoDS_Wire & theW )
static

◆ MakeWires()

void BOPAlgo_WireSplitter::MakeWires ( const Message_ProgressRange & theRange)
protected

◆ Perform()

void BOPAlgo_WireSplitter::Perform ( const Message_ProgressRange & theRange = Message_ProgressRange())
overridevirtual

The main method to implement the operation Providing the range allows to enable Progress indicator User break functionalities.

Implements BOPAlgo_Algo.

◆ SetContext()

void BOPAlgo_WireSplitter::SetContext ( const occ::handle< IntTools_Context > & theContext)

Sets the context for the algorithm.

◆ SetWES()

void BOPAlgo_WireSplitter::SetWES ( const BOPAlgo_WireEdgeSet & theWES)

◆ SplitBlock()

static void BOPAlgo_WireSplitter::SplitBlock ( const TopoDS_Face & theF,
BOPTools_ConnexityBlock & theCB,
const occ::handle< IntTools_Context > & theContext )
static

◆ WES()

BOPAlgo_WireEdgeSet & BOPAlgo_WireSplitter::WES ( )

Field Documentation

◆ myContext

occ::handle<IntTools_Context> BOPAlgo_WireSplitter::myContext
protected

◆ myLCB

NCollection_List<BOPTools_ConnexityBlock> BOPAlgo_WireSplitter::myLCB
protected

◆ myWES

BOPAlgo_PWireEdgeSet BOPAlgo_WireSplitter::myWES
protected

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