Open CASCADE Technology  7.2.0
Public Member Functions | Protected Member Functions | Protected Attributes

BOPDS_PassKey Class Reference

The class BOPDS_PassKey is to provide possibility to map objects that have a set of integer IDs as a base. More...

#include <BOPDS_PassKey.hxx>

Inheritance diagram for BOPDS_PassKey:
Inheritance graph
[legend]

Public Member Functions

 BOPDS_PassKey ()
 Empty contructor. More...
 
virtual ~BOPDS_PassKey ()
 
 BOPDS_PassKey (const BOPCol_BaseAllocator &theAllocator)
 Contructor theAllocator - the allocator to manage the memory. More...
 
 BOPDS_PassKey (const BOPDS_PassKey &Other)
 Copy Contructor. More...
 
BOPDS_PassKeyoperator= (const BOPDS_PassKey &Other)
 
void Clear ()
 Clear the contents. More...
 
void SetIds (const Standard_Integer theI1)
 Modifier Sets one Id <theI1> More...
 
void SetIds (const Standard_Integer theI1, const Standard_Integer theI2)
 Modifier Sets two Id <theI1>,<theI2> More...
 
void SetIds (const Standard_Integer theI1, const Standard_Integer theI2, const Standard_Integer theI3)
 Modifier Sets three Id <theI1>,<theI2>,<theI3> More...
 
void SetIds (const Standard_Integer theI1, const Standard_Integer theI2, const Standard_Integer theI3, const Standard_Integer theI4)
 Modifier Sets four Id <theI1>,<theI2>,<theI3>,<theI4> More...
 
void SetIds (const BOPCol_ListOfInteger &theLI)
 Modifier Sets the list of Id <theLI> More...
 
Standard_Integer NbIds () const
 Selector Returns the number of Ids> More...
 
Standard_Boolean IsEqual (const BOPDS_PassKey &theOther) const
 Query Returns true if the PassKey is equal to <the theother>=""> More...
 
Standard_Integer HashCode (const Standard_Integer theUpper) const
 Query Returns hash code. More...
 
Standard_Integer Id (const Standard_Integer theIndex) const
 Selector Returns Id of index <theIndex> More...
 
void Ids (Standard_Integer &theI1, Standard_Integer &theI2) const
 Selector Returns the first two Ids <theI1>,<theI2> More...
 
void Dump (const Standard_Integer aHex=0) const
 

Protected Member Functions

BOPCol_PInteger Allocate (const Standard_Integer theSize)
 

Protected Attributes

BOPCol_BaseAllocator myAllocator
 
Standard_Integer myNbIds
 
Standard_Integer mySum
 
BOPCol_PInteger myPtr
 

Detailed Description

The class BOPDS_PassKey is to provide possibility to map objects that have a set of integer IDs as a base.

Constructor & Destructor Documentation

◆ BOPDS_PassKey() [1/3]

BOPDS_PassKey::BOPDS_PassKey ( )

Empty contructor.

◆ ~BOPDS_PassKey()

virtual BOPDS_PassKey::~BOPDS_PassKey ( )
virtual

◆ BOPDS_PassKey() [2/3]

BOPDS_PassKey::BOPDS_PassKey ( const BOPCol_BaseAllocator theAllocator)

Contructor theAllocator - the allocator to manage the memory.

◆ BOPDS_PassKey() [3/3]

BOPDS_PassKey::BOPDS_PassKey ( const BOPDS_PassKey Other)

Copy Contructor.

Member Function Documentation

◆ Allocate()

BOPCol_PInteger BOPDS_PassKey::Allocate ( const Standard_Integer  theSize)
protected

◆ Clear()

void BOPDS_PassKey::Clear ( )

Clear the contents.

◆ Dump()

void BOPDS_PassKey::Dump ( const Standard_Integer  aHex = 0) const

◆ HashCode()

Standard_Integer BOPDS_PassKey::HashCode ( const Standard_Integer  theUpper) const

Query Returns hash code.

◆ Id()

Standard_Integer BOPDS_PassKey::Id ( const Standard_Integer  theIndex) const

Selector Returns Id of index <theIndex>

◆ Ids()

void BOPDS_PassKey::Ids ( Standard_Integer theI1,
Standard_Integer theI2 
) const

Selector Returns the first two Ids <theI1>,<theI2>

◆ IsEqual()

Standard_Boolean BOPDS_PassKey::IsEqual ( const BOPDS_PassKey theOther) const

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

◆ NbIds()

Standard_Integer BOPDS_PassKey::NbIds ( ) const

Selector Returns the number of Ids>

◆ operator=()

BOPDS_PassKey& BOPDS_PassKey::operator= ( const BOPDS_PassKey Other)

◆ SetIds() [1/5]

void BOPDS_PassKey::SetIds ( const Standard_Integer  theI1)

Modifier Sets one Id <theI1>

◆ SetIds() [2/5]

void BOPDS_PassKey::SetIds ( const Standard_Integer  theI1,
const Standard_Integer  theI2 
)

Modifier Sets two Id <theI1>,<theI2>

◆ SetIds() [3/5]

void BOPDS_PassKey::SetIds ( const Standard_Integer  theI1,
const Standard_Integer  theI2,
const Standard_Integer  theI3 
)

Modifier Sets three Id <theI1>,<theI2>,<theI3>

◆ SetIds() [4/5]

void BOPDS_PassKey::SetIds ( const Standard_Integer  theI1,
const Standard_Integer  theI2,
const Standard_Integer  theI3,
const Standard_Integer  theI4 
)

Modifier Sets four Id <theI1>,<theI2>,<theI3>,<theI4>

◆ SetIds() [5/5]

void BOPDS_PassKey::SetIds ( const BOPCol_ListOfInteger theLI)

Modifier Sets the list of Id <theLI>

Field Documentation

◆ myAllocator

BOPCol_BaseAllocator BOPDS_PassKey::myAllocator
protected

◆ myNbIds

Standard_Integer BOPDS_PassKey::myNbIds
protected

◆ myPtr

BOPCol_PInteger BOPDS_PassKey::myPtr
protected

◆ mySum

Standard_Integer BOPDS_PassKey::mySum
protected

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