SEQ< GENOME_TYPE > Class Template Reference

#include <seq.h>

List of all members.

Public Member Functions

 SEQ ()
 SEQ (const SEQ< GENOME_TYPE > &G)
 ~SEQ ()
SEQ< GENOME_TYPE > & operator= (const SEQ< GENOME_TYPE > &G)
void set_KO (string KO)
void set_start (GENOME_TYPE start)
void set_end (GENOME_TYPE end)
void set_orientation (const char orientation)
void set_info (string str)
void set_dirty ()
GENOME_TYPE get_start () const
GENOME_TYPE get_end () const
string get_KO () const
char get_orientation () const
string get_info () const
int get_dirty () const
bool operator< (const SEQ< GENOME_TYPE > &g) const
bool operator> (const SEQ< GENOME_TYPE > &g) const
bool operator== (const SEQ< GENOME_TYPE > &g) const

Private Attributes

GENOME_TYPE Start
GENOME_TYPE End
char Orientation
string info
string KO
int dirty

template<class GENOME_TYPE>
class SEQ< GENOME_TYPE >


Constructor & Destructor Documentation

template<class GENOME_TYPE>
SEQ< GENOME_TYPE >::SEQ  )  [inline]
 

Default constructor. Initializes the "dirty" field with 0.

template<class GENOME_TYPE>
SEQ< GENOME_TYPE >::SEQ const SEQ< GENOME_TYPE > &  G  ) 
 

Copy constructor.

Parameters:
G,: SEQ<GENOME_TYPE> object reference.

template<class GENOME_TYPE>
SEQ< GENOME_TYPE >::~SEQ  )  [inline]
 

Destructor.


Member Function Documentation

template<class GENOME_TYPE>
int SEQ< GENOME_TYPE >::get_dirty  )  const
 

Returns the "dirty" field of the sequence.

Returns:
GENOME_TYPE

template<class GENOME_TYPE>
GENOME_TYPE SEQ< GENOME_TYPE >::get_end  )  const
 

Returns the ending coordinate of the sequence.

Returns:
GENOME_TYPE

template<class GENOME_TYPE>
string SEQ< GENOME_TYPE >::get_info  )  const
 

Returns the "info" field of the sequence.

Returns:
string

template<class GENOME_TYPE>
string SEQ< GENOME_TYPE >::get_KO  )  const
 

Returns the KO of the sequence.

Returns:
string

template<class GENOME_TYPE>
char SEQ< GENOME_TYPE >::get_orientation  )  const
 

Returns the orientation of the sequence.

Returns:
char

template<class GENOME_TYPE>
GENOME_TYPE SEQ< GENOME_TYPE >::get_start  )  const
 

Returns the beginning coordinate of the sequence.

Returns:
GENOME_TYPE

template<class GENOME_TYPE>
bool SEQ< GENOME_TYPE >::operator< const SEQ< GENOME_TYPE > &  g  )  const
 

Operator < . Compares between this and g according to KO field.

Parameters:
g,: const SEQ<GENOME_TYPE>&
Returns:
bool

template<class GENOME_TYPE>
SEQ< GENOME_TYPE > & SEQ< GENOME_TYPE >::operator= const SEQ< GENOME_TYPE > &  G  ) 
 

Assignment operator. Copies G's fields to the current object fields.

Parameters:
G,: const SEQ<GENOME_TYPE>&
Returns:
SEQ<GENOME_TYPE>&

template<class GENOME_TYPE>
bool SEQ< GENOME_TYPE >::operator== const SEQ< GENOME_TYPE > &  g  )  const
 

Operator == . Compares between this and g according to KO field.

Parameters:
g,: const SEQ<GENOME_TYPE>&
Returns:
bool

template<class GENOME_TYPE>
bool SEQ< GENOME_TYPE >::operator> const SEQ< GENOME_TYPE > &  g  )  const
 

Operator > . Compares between this and g according to KO field.

Parameters:
g,: const SEQ<GENOME_TYPE>&
Returns:
bool

template<class GENOME_TYPE>
void SEQ< GENOME_TYPE >::set_dirty  ) 
 

Sets the "dirty" field of the sequence to 1.

template<class GENOME_TYPE>
void SEQ< GENOME_TYPE >::set_end GENOME_TYPE  end  ) 
 

Sets the ending coordinate of the sequence.

Parameters:
end,: GENOME_TYPE

template<class GENOME_TYPE>
void SEQ< GENOME_TYPE >::set_info string  str  ) 
 

Sets the "info" field of the sequence.

Parameters:
str,: string

template<class GENOME_TYPE>
void SEQ< GENOME_TYPE >::set_KO string  KO  ) 
 

Sets the KO of the calling object.

Parameters:
KO,: string.

template<class GENOME_TYPE>
void SEQ< GENOME_TYPE >::set_orientation const char  orientation  ) 
 

Sets the orientation of the sequence.

Parameters:
orientation,: char

template<class GENOME_TYPE>
void SEQ< GENOME_TYPE >::set_start GENOME_TYPE  start  ) 
 

Sets the beginning coordinate of the sequence.

Parameters:
start,: GENOME_TYPE


Member Data Documentation

template<class GENOME_TYPE>
int SEQ< GENOME_TYPE >::dirty [private]
 

An auxiliary field which was used in cleanfile.h. 0 is for valid and 1 is for not valid.

template<class GENOME_TYPE>
GENOME_TYPE SEQ< GENOME_TYPE >::End [private]
 

template<class GENOME_TYPE>
string SEQ< GENOME_TYPE >::info [private]
 

The suitable entry from the file *.anchor.

template<class GENOME_TYPE>
string SEQ< GENOME_TYPE >::KO [private]
 

The sequence's KO.

template<class GENOME_TYPE>
char SEQ< GENOME_TYPE >::Orientation [private]
 

The sequence's orientation.

template<class GENOME_TYPE>
GENOME_TYPE SEQ< GENOME_TYPE >::Start [private]
 

The sequence's coordinates.


The documentation for this class was generated from the following file:
Generated on Tue May 9 18:43:46 2006 for PrePro by  doxygen 1.4.6-NO