In file dataEntries.h:

class dataEntries: public vector<dataEntry>

vector of dataEntry objects with a few extra members and methods

Inheritance:

dataEntries


Public Methods

[more] dataEntries ()
constructor
[more] ~dataEntries ()
destructor
[more]int add ( dataEntry entry )
add an entry to the vector
[more]void sort ()
sort the vector
[more]int getCount ( int db_index )
returns count of entries from a particular database


Documentation

vector of dataEntry objects with a few extra members and methods.

This class is a vector, all standard members of vector are available.
In addition dataEntries
keeps count of how many entries from each database it has, so that we can limit the number of entries to deposit on a per-database basis, and
has methods to get those counts and to sort the vector.

o dataEntries()
constructor.

Initializes counters to 0.

o ~dataEntries()
destructor.

Erases vector's contents.

oint add( dataEntry entry )
add an entry to the vector.

All PDB entries except duplicates are added to the vector. For non-pdb entries add() checks the corresponding counter against MaxXEntries constant declared in blastConfig. If counter is less than MaxXEntries, or it's a PDB entry, the entry is compared to all other entries in the vector. If it is not already in the vector, it is added and corresp. counter is incremented.

Returns:
negative value on error, 0 otherwise
Parameters:
entry - dataEntry to add.
See Also:
dataEntry
blastConfig

ovoid sort()
sort the vector.

Sort() uses the standard algorithm to sort the vector. See operator < in dataEntry class.

See Also:
dataEntry

oint getCount( int db_index )
returns count of entries from a particular database.

getCount() is used mainly for debugging/diagnostic.

Returns:
number of entries from that database.
Parameters:
db_index - database index (one of the database index constans declared in blastConfig class).
See Also:
blastConfig


This class has no child classes.
See Also:
dataEntry

Alphabetic index Hierarchy of classes



This page was generated with the help of DOC++.