class dataEntry

In file dataEntry.h:

class dataEntry

class for holding data entries

Public Methods

Documentation

class for holding data entries.
Each dataEntry object holds one data record.
All fields are private, they are accessed via Java-style (getX/setX/isX etc) methods.
There are operators <, > and == for sorting the vector of dataEntry objects and for finding duplicate entries.
Note that mening of operators < and > is somewhat counter-intuitive, RTFM carefully before using them.

dataEntry( dataEntries *d, blastConfig *b )

constructor.

Initialize member variables, set up pointers to blastConfig and dataEntries objects.

Parameters:: d - pointer to dataEntries vector.
b - pointer to blastConfig object.
See Also:: dataEntries
blastConfig

~dataEntry()

destructor.

Erase string fields, just in case.

bool operator< ( const dataEntry &entry )

used by STL sort algorithm.

Since we want entries sorted in descending order of Id, with pdb on top, this operator returns true if
this.fId > other.fId or
this.fId == other.fId and this.fName < other.fName.
See blastConfig class for fName ordering (blastConfig::pdb etc.)

Returns:: true or false
See Also:: blastConfig

bool operator> ( const dataEntry &entry )

This operator is not used.

operator > returns true if
this.fId < other.fId or
this.fId == other.fId and this.fName > other.fName
(IOW it's a complement to <, see operator < for explanation).

Returns:: true or false

bool operator== ( const dataEntry &entry )

used to search for duplicate entries by dataEntries::add().

operator == returns true if
this.fName == other.fName and this.fCode == other.fCode.

Returns:: true or false
See Also:: dataEntries

dataEntries* getParent() const

return pointer to dataEntries vector.

See Also:: dataEntries

void setParent( dataEntries *parent )

Set up the pointer to dataEntries vector. Note use constructor instead.

blastConfig* getConfig() const

return pointer to blastConfig object.

See Also:: blastConfig

void setConfig( blastConfig *config )

Set up the pointer to blastConfig object. Note use constructor instead.

int getLength() const

return length (eg. 104)

void setLength( const int& len )

set length

int getSeqLen() const

return sequence length (eg. 101)

void setSeqLen( const int& len )

set sequence length

int getComp() const

return sequence completeness (calculated from identities and residue count)

void setComp( const int& comp )

set sequence completeness

int getId() const

return id (eg. 98%)

void setId( const int& id )

set id

int getPos() const

return positives (eg. 98%)

void setPos( const int& pos )

set positives

int getIdCount() const

return count of "Identities" lines

void setIdCount( const int& cnt )

set count of "Identities" lines

string getExp() const

return "Expect" value

void setExp( const char *expect )

set "Expect" value. Overloaded to accept a string or char * parameter.

string getName() const

return database name (eg. PDB)

void setName( const char *name )

set database name. Overloaded to accept a string or char * parameter.

string getCode() const

return accession code

void setCode( const char *code )

set database accession code. Overloaded to accept a string or char * parameter.

string getMolName() const

return molecular system description

void setMolName( const char *mol )

set molecular system description. Overloaded to accept a string or char * parameter.

string getDetails() const

return sequence details

void setDetails( const char *details )

set sequence details. Overloaded to accept a string or char * parameter.

bool getPullOut()

return pull-out flag: true or false.

void setPullOut( bool b )

set pull-out flag.

void print()

print object to cout.
Used for debugging.

This class has no child classes.

Alphabetic index Hierarchy of classes

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

	dataEntry ( dataEntries d, blastConfig b ) constructor
	~dataEntry () destructor
bool	operator< ( const dataEntry &entry ) used by STL `sort` algorithm
bool	operator> ( const dataEntry &entry ) This operator is not used
bool	operator== ( const dataEntry &entry ) used to search for duplicate entries by `dataEntries::add()`
dataEntries*	getParent () const return pointer to `dataEntries` vector
void	setParent ( dataEntries parent ) Set up the pointer to `dataEntries` vector*
blastConfig*	getConfig () const return pointer to `blastConfig` object
void	setConfig ( blastConfig config ) Set up the pointer to `blastConfig` object*
int	getLength () const return length (eg. 104)
void	setLength ( const int& len ) set length
int	getSeqLen () const return sequence length (eg. 101)
void	setSeqLen ( const int& len ) set sequence length
int	getComp () const return sequence completeness (calculated from identities and residue count)
void	setComp ( const int& comp ) set sequence completeness
int	getId () const return id (eg. 98%)
void	setId ( const int& id ) set id
int	getPos () const return positives (eg. 98%)
void	setPos ( const int& pos ) set positives
int	getIdCount () const return count of "Identities" lines
void	setIdCount ( const int& cnt ) set count of "Identities" lines
string	getExp () const return "Expect" value
void	setExp ( const char expect ) set "Expect" value*
string	getName () const return database name (eg. PDB)
void	setName ( const char name ) set database name*
string	getCode () const return accession code
void	setCode ( const char code ) set database accession code*
string	getMolName () const return molecular system description
void	setMolName ( const char mol ) set molecular system description*
string	getDetails () const return sequence details
void	setDetails ( const char details ) set sequence details*
bool	getPullOut () return pull-out flag: true or false.
void	setPullOut ( bool b ) set pull-out flag.
void	print () print object to `cout`

class dataEntry

Public Methods

Documentation