In file dataEntry.h:

class dataEntry

class for holding data entries

Public Methods

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


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.

o 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

o ~dataEntry()
destructor.

Erase string fields, just in case.

obool 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

obool 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

obool 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

odataEntries* getParent() const
return pointer to dataEntries vector.
See Also:
dataEntries

ovoid setParent( dataEntries *parent )
Set up the pointer to dataEntries vector. Note use constructor instead.

oblastConfig* getConfig() const
return pointer to blastConfig object.
See Also:
blastConfig

ovoid setConfig( blastConfig *config )
Set up the pointer to blastConfig object. Note use constructor instead.

oint getLength() const
return length (eg. 104)

ovoid setLength( const int& len )
set length

oint getSeqLen() const
return sequence length (eg. 101)

ovoid setSeqLen( const int& len )
set sequence length

oint getComp() const
return sequence completeness (calculated from identities and residue count)

ovoid setComp( const int& comp )
set sequence completeness

oint getId() const
return id (eg. 98%)

ovoid setId( const int& id )
set id

oint getPos() const
return positives (eg. 98%)

ovoid setPos( const int& pos )
set positives

oint getIdCount() const
return count of "Identities" lines

ovoid setIdCount( const int& cnt )
set count of "Identities" lines

ostring getExp() const
return "Expect" value

ovoid setExp( const char *expect )
set "Expect" value. Overloaded to accept a string or char * parameter.

ostring getName() const
return database name (eg. PDB)

ovoid setName( const char *name )
set database name. Overloaded to accept a string or char * parameter.

ostring getCode() const
return accession code

ovoid setCode( const char *code )
set database accession code. Overloaded to accept a string or char * parameter.

ostring getMolName() const
return molecular system description

ovoid setMolName( const char *mol )
set molecular system description. Overloaded to accept a string or char * parameter.

ostring getDetails() const
return sequence details

ovoid setDetails( const char *details )
set sequence details. Overloaded to accept a string or char * parameter.

obool getPullOut()
return pull-out flag: true or false.

ovoid setPullOut( bool b )
set pull-out flag.

ovoid 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++.