BOPDS_Pair Class Reference

The class is to provide the pair of indices of interfering shapes. More...

#include <BOPDS_Pair.hxx>

Public Member Functions
	BOPDS_Pair ()
	BOPDS_Pair (const Standard_Integer theIndex1, const Standard_Integer theIndex2)
	~BOPDS_Pair ()
void	SetIndices (const Standard_Integer theIndex1, const Standard_Integer theIndex2)
	Sets the indices. More...
void	Indices (Standard_Integer &theIndex1, Standard_Integer &theIndex2) const
	Gets the indices. More...
Standard_Boolean	operator< (const BOPDS_Pair &theOther) const
	Operator less. More...
Standard_Boolean	IsEqual (const BOPDS_Pair &theOther) const
	Returns true if the Pair is equal to <the theother>=""> More...
Standard_Integer	HashCode (const Standard_Integer theUpperBound) const
	Computes a hash code for this pair, in the range [1, theUpperBound]. More...

Protected Attributes
Standard_Integer	myIndex1
Standard_Integer	myIndex2

Detailed Description

The class is to provide the pair of indices of interfering shapes.

Constructor & Destructor Documentation

BOPDS_Pair() [1/2]

BOPDS_Pair::BOPDS_Pair ( )

inline

BOPDS_Pair() [2/2]

BOPDS_Pair::BOPDS_Pair ( const Standard_Integer  theIndex1, const Standard_Integer  theIndex2  )

inline

~BOPDS_Pair()

BOPDS_Pair::~BOPDS_Pair ( )

inline

Member Function Documentation

HashCode()

Standard_Integer BOPDS_Pair::HashCode ( const Standard_Integer  theUpperBound ) const

inline

Computes a hash code for this pair, in the range [1, theUpperBound].

Parameters

theUpperBound

the upper bound of the range a computing hash code must be within

Returns

a computed hash code, in the range [1, theUpperBound]

Indices()

void BOPDS_Pair::Indices ( Standard_Integer &  theIndex1, Standard_Integer &  theIndex2  ) const

inline

Gets the indices.

IsEqual()

Standard_Boolean BOPDS_Pair::IsEqual ( const BOPDS_Pair &  theOther ) const

inline

Returns true if the Pair is equal to <the theother>="">

operator<()

Standard_Boolean BOPDS_Pair::operator< ( const BOPDS_Pair &  theOther ) const

inline

Operator less.

SetIndices()

void BOPDS_Pair::SetIndices ( const Standard_Integer  theIndex1, const Standard_Integer  theIndex2  )

inline

Sets the indices.

Field Documentation

myIndex1

Standard_Integer BOPDS_Pair::myIndex1

protected

myIndex2

Standard_Integer BOPDS_Pair::myIndex2

protected

---

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

• BOPDS_Pair.hxx