cSequenceDatabase Class Reference

The class representing a database of sequences. More...

#include <cSequenceDatabase.h>

Public Member Functions
	cSequenceDatabase ()
	The constructor.
void	loadFromPlainTextStream (ifstream &stream, bool keeprt)
	Load the database of sequences from a plain text stream. More...
void	storeToPlainTextStream (ofstream &stream, bool keeprt)
	Store the database of sequences into a plain text stream. More...
int	size ()
	Get the number of sequences in the database. More...
cSequence &	operator[] (int position)
	Overloaded operator []. More...
void	clear ()
	Clear the vector of sequences.
void	push_back (cSequence &sequence)
	Push a new sequence into the vector of sequences. More...
void	erase (int index)
	Erase a sequence. More...
void	store (ofstream &os)
	Store the structure into an output stream. More...
void	load (ifstream &is, int fileversionpart1, int fileversionpart2, int fileversionpart3)
	Load the structure from an input stream. More...
void	attachDecoys (bool &terminatecomputation)
	Attach decoys. More...

Detailed Description

The class representing a database of sequences.

Member Function Documentation

attachDecoys()

void cSequenceDatabase::attachDecoys

(

bool &

terminatecomputation

)

Attach decoys.

Parameters

terminatecomputation

reference to a variable determining that the computation must be stopped

erase()

void cSequenceDatabase::erase

(

int

index

)

Erase a sequence.

Parameters

index

index of a sequence

load()

void cSequenceDatabase::load	(	ifstream &	is,
		int	fileversionpart1,
		int	fileversionpart2,
		int	fileversionpart3
	)

Load the structure from an input stream.

Parameters

is	an input stream
fileversionpart1	first number of .res the file version
fileversionpart2	second number of .res the file version
fileversionpart3	third number of .res the file version

loadFromPlainTextStream()

void cSequenceDatabase::loadFromPlainTextStream	(	ifstream &	stream,
		bool	keeprt
	)

Load the database of sequences from a plain text stream.

Parameters

stream	reference to an input file stream
keeprt	keep retention time as a part of the compound name

operator[]()

cSequence & cSequenceDatabase::operator[]

(

int

position

)

Overloaded operator [].

Parameters

position

of the sequence in the vector of sequences

Return values

cSequence

reference to a sequence

push_back()

void cSequenceDatabase::push_back

(

cSequence &

sequence

)

Push a new sequence into the vector of sequences.

Parameters

sequence

an inserted sequence

size()

int cSequenceDatabase::size

(

)

Get the number of sequences in the database.

Return values

int	number of sequences

store()

void cSequenceDatabase::store

(

ofstream &

os

)

Store the structure into an output stream.

Parameters

os	an output stream

storeToPlainTextStream()

void cSequenceDatabase::storeToPlainTextStream	(	ofstream &	stream,
		bool	keeprt
	)

Store the database of sequences into a plain text stream.

Parameters

stream	reference to an output file stream
keeprt	keep retention time as a part of the compound name

---

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

• core/cSequenceDatabase.h
• core/cSequenceDatabase.cpp