cpsp::HCoreDatabase Class Reference
#include <HCoreDatabase.hh>
Detailed Description
An HCoreDatabase handles the access to stored HCore objects.Definition at line 32 of file HCoreDatabase.hh.
Public Member Functions | |
| virtual unsigned int | getActCoreSize ()=0 |
| virtual unsigned int | getActMaxHHcontacts ()=0 |
| virtual unsigned int | getActMinHHcontacts ()=0 |
| virtual bool | getNextCore (HCore &toFill)=0 |
| HCoreDatabase () | |
| virtual bool | initCoreAccess (const biu::LatticeDescriptor &latDescr, const unsigned int size, const unsigned int minContacts=0, const unsigned int maxContacts=UINT_MAX-2)=0 |
| virtual bool | isConnected () const =0 |
| virtual void | setActMinHHcontacts (const unsigned int minContacts)=0 |
| virtual | ~HCoreDatabase () |
Constructor & Destructor Documentation
| cpsp::HCoreDatabase::HCoreDatabase | ( | ) | [inline] |
Definition at line 35 of file HCoreDatabase.hh.
| virtual cpsp::HCoreDatabase::~HCoreDatabase | ( | ) | [inline, virtual] |
Definition at line 36 of file HCoreDatabase.hh.
Member Function Documentation
| virtual unsigned int cpsp::HCoreDatabase::getActCoreSize | ( | ) | [pure virtual] |
Returns the core size of the HCore objects returned by getNextCore().
Implemented in cpsp::HCoreDatabaseFILE, and cpsp::HCoreDatabasePGSQL.
| virtual unsigned int cpsp::HCoreDatabase::getActMaxHHcontacts | ( | ) | [pure virtual] |
Returns the maximal number of contacts of the HCore objects returned by getNextCore().
Implemented in cpsp::HCoreDatabaseFILE, and cpsp::HCoreDatabasePGSQL.
| virtual unsigned int cpsp::HCoreDatabase::getActMinHHcontacts | ( | ) | [pure virtual] |
Returns the minimal number of contacts of the HCore objects returned by getNextCore().
Implemented in cpsp::HCoreDatabaseFILE, and cpsp::HCoreDatabasePGSQL.
| virtual bool cpsp::HCoreDatabase::getNextCore | ( | HCore & | toFill | ) | [pure virtual] |
Fills succesively all HCore objects in the ranges given by initAccess(...) in descending order according to the number of contacts.
- Returns:
- returns whether or not filling was successfull and if the filled HCore toFill is valid or not.
Implemented in cpsp::HCoreDatabaseFILE, and cpsp::HCoreDatabasePGSQL.
| virtual bool cpsp::HCoreDatabase::initCoreAccess | ( | const biu::LatticeDescriptor & | latDescr, | |
| const unsigned int | size, | |||
| const unsigned int | minContacts = 0, |
|||
| const unsigned int | maxContacts = UINT_MAX-2 | |||
| ) | [pure virtual] |
Initializes the database access to control the HCore objects returned by getNextCore()
- Returns:
- == true if the initialization was successfull
Implemented in cpsp::HCoreDatabaseFILE, and cpsp::HCoreDatabasePGSQL.
| virtual bool cpsp::HCoreDatabase::isConnected | ( | ) | const [pure virtual] |
Returns whether or not the database is connected and open for access.
Implemented in cpsp::HCoreDatabaseFILE, and cpsp::HCoreDatabasePGSQL.
| virtual void cpsp::HCoreDatabase::setActMinHHcontacts | ( | const unsigned int | minContacts | ) | [pure virtual] |
Sets the minimal number of contacts of the HCore objects returned by getNextCore().
Implemented in cpsp::HCoreDatabaseFILE, and cpsp::HCoreDatabasePGSQL.
The documentation for this class was generated from the following file:
- src/cpsp/HCoreDatabase.hh