BOPDS_Interf Class Reference

#include <BOPDS_Interf.hxx>

Inheritance diagram for BOPDS_Interf:

Public Member Functions
void	SetIndices (const int theIndex1, const int theIndex2)
void	Indices (int &theIndex1, int &theIndex2) const
void	SetIndex1 (const int theIndex)
void	SetIndex2 (const int theIndex)
int	Index1 () const
int	Index2 () const
int	OppositeIndex (const int theI) const
bool	Contains (const int theIndex) const
void	SetIndexNew (const int theIndex)
int	IndexNew () const
bool	HasIndexNew (int &theIndex) const
bool	HasIndexNew () const
std::optional< int >	GetIndexNew () const
	Returns the index of new shape. If the index is not set, returns std::nullopt.

Protected Member Functions
	BOPDS_Interf ()
	BOPDS_Interf (const occ::handle< NCollection_BaseAllocator > &theAllocator)
virtual	~BOPDS_Interf ()=default

Protected Attributes
int	myIndex1
int	myIndex2
int	myIndexNew
occ::handle< NCollection_BaseAllocator >	myAllocator

Detailed Description

The class BOPDS_Interf stores the information about the interference between two shapes. The class BOPDS_Interf is root class

Constructor & Destructor Documentation

BOPDS_Interf() [1/2]

BOPDS_Interf::BOPDS_Interf ( )

inlineprotected

BOPDS_Interf() [2/2]

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

inlineprotected

~BOPDS_Interf()

virtual BOPDS_Interf::~BOPDS_Interf ( )

protectedvirtualdefault

Member Function Documentation

Contains()

bool BOPDS_Interf::Contains ( const int theIndex ) const

inline

Returns true if the interference contains given index

Parameters

theIndex

the index

Returns

true if the interference contains given index

GetIndexNew()

std::optional< int > BOPDS_Interf::GetIndexNew ( ) const

inline

Returns the index of new shape. If the index is not set, returns std::nullopt.

HasIndexNew() [1/2]

bool BOPDS_Interf::HasIndexNew ( ) const

inline

Returns true if the interference has index of new shape the index

Returns

true if the interference has index of new shape

HasIndexNew() [2/2]

bool BOPDS_Interf::HasIndexNew ( int & theIndex ) const

inline

Returns true if the interference has index of new shape that is equal to the given index

Parameters

theIndex

the index

Returns

true if the interference has index of new shape that is equal to the given index

Index1()

int BOPDS_Interf::Index1 ( ) const

inline

Returns the index of the first interferred shape

Returns

index of the first shape

Index2()

int BOPDS_Interf::Index2 ( ) const

inline

Returns the index of the second interferred shape

Returns

index of the second shape

IndexNew()

int BOPDS_Interf::IndexNew ( ) const

inline

Returns the index of new shape

Returns

theIndex the index of new shape

Indices()

void BOPDS_Interf::Indices ( int & theIndex1, int & theIndex2 ) const

inline

Returns the indices of interferred shapes

Parameters

theIndex1	index of the first shape
theIndex2	index of the second shape

OppositeIndex()

int BOPDS_Interf::OppositeIndex ( const int theI ) const

inline

Returns the index of that are opposite to the given index

Parameters

theI

the index

Returns

index of opposite shape

SetIndex1()

void BOPDS_Interf::SetIndex1 ( const int theIndex )

inline

Sets the index of the first interferred shape

Parameters

theIndex

index of the first shape

SetIndex2()

void BOPDS_Interf::SetIndex2 ( const int theIndex )

inline

Sets the index of the second interferred shape

Parameters

theIndex

index of the second shape

SetIndexNew()

void BOPDS_Interf::SetIndexNew ( const int theIndex )

inline

Sets the index of new shape

Parameters

theIndex

the index

SetIndices()

void BOPDS_Interf::SetIndices ( const int theIndex1, const int theIndex2 )

inline

Sets the indices of interferred shapes

Parameters

theIndex1	index of the first shape
theIndex2	index of the second shape

Field Documentation

myAllocator

occ::handle<NCollection_BaseAllocator> BOPDS_Interf::myAllocator

protected

myIndex1

int BOPDS_Interf::myIndex1

protected

myIndex2

int BOPDS_Interf::myIndex2

protected

myIndexNew

int BOPDS_Interf::myIndexNew

protected

---

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

• BOPDS_Interf.hxx