The class BOPDS_CommonBlock is to store the information about pave blocks that have geometrical coincidence (in terms of a tolerance) with:
a) other pave block(s);
b) face(s).
First pave block in the common block (real pave block) is always a pave block with the minimal index of the original edge. More...

#include <BOPDS_CommonBlock.hxx>

Inheritance diagram for BOPDS_CommonBlock:

[legend]

Public Member Functions
	BOPDS_CommonBlock ()
	Empty constructor.

	BOPDS_CommonBlock (const Handle< NCollection_BaseAllocator > &theAllocator)
	Constructor.

void	AddPaveBlock (const Handle< BOPDS_PaveBlock > &aPB)
	Modifier Adds the pave block <aPB> to the list of pave blocks of the common block.

void	SetPaveBlocks (const BOPDS_ListOfPaveBlock &aLPB)
	Modifier Sets the list of pave blocks for the common block.

void	AddFace (const Standard_Integer aF)
	Modifier Adds the index of the face <aF> to the list of indices of faces of the common block.

void	SetFaces (const TColStd_ListOfInteger &aLF)
	Modifier Sets the list of indices of faces <aLF> of the common block.

void	AppendFaces (TColStd_ListOfInteger &aLF)
	Modifier Appends the list of indices of faces <aLF> to the list of indices of faces of the common block (the input list is emptied)

const BOPDS_ListOfPaveBlock &	PaveBlocks () const
	Selector Returns the list of pave blocks of the common block.

const TColStd_ListOfInteger &	Faces () const
	Selector Returns the list of indices of faces of the common block.

const Handle< BOPDS_PaveBlock > &	PaveBlock1 () const
	Selector Returns the first pave block of the common block.

Handle< BOPDS_PaveBlock > &	PaveBlockOnEdge (const Standard_Integer theIndex)
	Selector Returns the pave block that belongs to the edge with index <theIx>

Standard_Boolean	IsPaveBlockOnFace (const Standard_Integer theIndex) const
	Query Returns true if the common block contains a pave block that belongs to the face with index <theIx>

Standard_Boolean	IsPaveBlockOnEdge (const Standard_Integer theIndex) const
	Query Returns true if the common block contains a pave block that belongs to the edge with index <theIx>

Standard_Boolean	Contains (const Handle< BOPDS_PaveBlock > &thePB) const
	Query Returns true if the common block contains a pave block that is equal to <thePB>

Standard_Boolean	Contains (const Standard_Integer theF) const
	Query Returns true if the common block contains the face with index equal to <theF>

void	SetEdge (const Standard_Integer theEdge)
	Modifier Assign the index <theEdge> as the edge index to all pave blocks of the common block.

Standard_Integer	Edge () const
	Selector Returns the index of the edge of all pave blocks of the common block.

void	Dump () const

void	SetRealPaveBlock (const Handle< BOPDS_PaveBlock > &thePB)
	Moves the pave blocks in the list to make the given pave block to be the first. It will be representative for the whole group.

void	SetTolerance (const Standard_Real theTol)
	Sets the tolerance for the common block.

Standard_Real	Tolerance () const
	Return the tolerance of common block.

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Attributes
BOPDS_ListOfPaveBlock	myPaveBlocks
	Pave blocks of the common block.

TColStd_ListOfInteger	myFaces
	Faces on which the pave blocks are lying.

Standard_Real	myTolerance
	Tolerance of the common block.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Detailed Description

The class BOPDS_CommonBlock is to store the information about pave blocks that have geometrical coincidence (in terms of a tolerance) with:
a) other pave block(s);
b) face(s).
First pave block in the common block (real pave block) is always a pave block with the minimal index of the original edge.

Constructor & Destructor Documentation

◆ BOPDS_CommonBlock() [1/2]

BOPDS_CommonBlock::BOPDS_CommonBlock ( )

Empty constructor.

◆ BOPDS_CommonBlock() [2/2]

BOPDS_CommonBlock::BOPDS_CommonBlock ( const Handle< NCollection_BaseAllocator > & theAllocator )

Constructor.

Parameters

theAllocator the allocator to manage the memory

Member Function Documentation

◆ AddFace()

void BOPDS_CommonBlock::AddFace ( const Standard_Integer aF )

Modifier Adds the index of the face <aF> to the list of indices of faces of the common block.

◆ AddPaveBlock()

void BOPDS_CommonBlock::AddPaveBlock ( const Handle< BOPDS_PaveBlock > & aPB )

Modifier Adds the pave block <aPB> to the list of pave blocks of the common block.

◆ AppendFaces()

void BOPDS_CommonBlock::AppendFaces ( TColStd_ListOfInteger & aLF )

Modifier Appends the list of indices of faces <aLF> to the list of indices of faces of the common block (the input list is emptied)

◆ Contains() [1/2]

Standard_Boolean BOPDS_CommonBlock::Contains ( const Handle< BOPDS_PaveBlock > & thePB ) const

Query Returns true if the common block contains a pave block that is equal to <thePB>

◆ Contains() [2/2]

Standard_Boolean BOPDS_CommonBlock::Contains ( const Standard_Integer theF ) const

Query Returns true if the common block contains the face with index equal to <theF>

◆ Dump()

void BOPDS_CommonBlock::Dump ( ) const

◆ Edge()

Standard_Integer BOPDS_CommonBlock::Edge ( ) const

Selector Returns the index of the edge of all pave blocks of the common block.

◆ Faces()

const TColStd_ListOfInteger & BOPDS_CommonBlock::Faces ( ) const

Selector Returns the list of indices of faces of the common block.

◆ IsPaveBlockOnEdge()

Standard_Boolean BOPDS_CommonBlock::IsPaveBlockOnEdge ( const Standard_Integer theIndex ) const

Query Returns true if the common block contains a pave block that belongs to the edge with index <theIx>

◆ IsPaveBlockOnFace()

Standard_Boolean BOPDS_CommonBlock::IsPaveBlockOnFace ( const Standard_Integer theIndex ) const

Query Returns true if the common block contains a pave block that belongs to the face with index <theIx>

◆ PaveBlock1()

const Handle< BOPDS_PaveBlock > & BOPDS_CommonBlock::PaveBlock1 ( ) const

Selector Returns the first pave block of the common block.

◆ PaveBlockOnEdge()

Handle< BOPDS_PaveBlock > & BOPDS_CommonBlock::PaveBlockOnEdge ( const Standard_Integer theIndex )

Selector Returns the pave block that belongs to the edge with index <theIx>

◆ PaveBlocks()

const BOPDS_ListOfPaveBlock & BOPDS_CommonBlock::PaveBlocks ( ) const

Selector Returns the list of pave blocks of the common block.

◆ SetEdge()

void BOPDS_CommonBlock::SetEdge ( const Standard_Integer theEdge )

Modifier Assign the index <theEdge> as the edge index to all pave blocks of the common block.

◆ SetFaces()

void BOPDS_CommonBlock::SetFaces ( const TColStd_ListOfInteger & aLF )

Modifier Sets the list of indices of faces <aLF> of the common block.

◆ SetPaveBlocks()

void BOPDS_CommonBlock::SetPaveBlocks ( const BOPDS_ListOfPaveBlock & aLPB )

Modifier Sets the list of pave blocks for the common block.

◆ SetRealPaveBlock()

void BOPDS_CommonBlock::SetRealPaveBlock ( const Handle< BOPDS_PaveBlock > & thePB )

Moves the pave blocks in the list to make the given pave block to be the first. It will be representative for the whole group.

◆ SetTolerance()

void BOPDS_CommonBlock::SetTolerance ( const Standard_Real theTol )

inline

Sets the tolerance for the common block.

◆ Tolerance()

Standard_Real BOPDS_CommonBlock::Tolerance ( ) const

inline

Return the tolerance of common block.

Field Documentation

◆ myFaces

TColStd_ListOfInteger BOPDS_CommonBlock::myFaces

protected

Faces on which the pave blocks are lying.

◆ myPaveBlocks

BOPDS_ListOfPaveBlock BOPDS_CommonBlock::myPaveBlocks

protected

Pave blocks of the common block.

◆ myTolerance

Standard_Real BOPDS_CommonBlock::myTolerance

protected

Tolerance of the common block.

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

BOPDS_CommonBlock.hxx

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BOPDS_CommonBlock() [1/2]

◆ BOPDS_CommonBlock() [2/2]

Member Function Documentation

◆ AddFace()

◆ AddPaveBlock()

◆ AppendFaces()

◆ Contains() [1/2]

◆ Contains() [2/2]

◆ Dump()

◆ Edge()

◆ Faces()

◆ IsPaveBlockOnEdge()

◆ IsPaveBlockOnFace()

◆ PaveBlock1()

◆ PaveBlockOnEdge()

◆ PaveBlocks()

◆ SetEdge()

◆ SetFaces()

◆ SetPaveBlocks()

◆ SetRealPaveBlock()

◆ SetTolerance()

◆ Tolerance()

Field Documentation

◆ myFaces

◆ myPaveBlocks

◆ myTolerance