Entry< GENUM_TYPE > Class Template Reference

#include <entry.h>

List of all members.

Public Member Functions

 Entry ()
 Entry (const Entry< GENUM_TYPE > &ent)
 ~Entry ()
void InseretEntry (GENUM_TYPE s_1, GENUM_TYPE e_1, GENUM_TYPE s_2, GENUM_TYPE e_2, bool sign_, const string label_)
void GetS1E1 (GENUM_TYPE &start, GENUM_TYPE &end) const
void GetS2E2 (GENUM_TYPE &start, GENUM_TYPE &end) const
void SetS1E1 (GENUM_TYPE start, GENUM_TYPE end)
void SetS2E2 (GENUM_TYPE start, GENUM_TYPE end)
bool GetSign () const
string GetLabel () const
bool IsInUse () const
void Delete ()
Entry< GENUM_TYPE > & operator= (const Entry< GENUM_TYPE > &ent)
bool operator== (const Entry< GENUM_TYPE > &ent) const

Private Attributes

bool InUse
string Label
GENUM_TYPE S1
GENUM_TYPE E1
GENUM_TYPE S2
GENUM_TYPE E2
bool Sign


Detailed Description

template<class GENUM_TYPE>
class Entry< GENUM_TYPE >

Class name: Entry

This class is used to hold the information of an entry in the table. The information that is held is: 1) The satrts and ends of the two segments. 2) The Sign of the entry, '+' means the two segments are have the same direction, '-' means they have opposite directions. 3) The label of the entry.

Author:
Rani Zand


Constructor & Destructor Documentation

template<class GENUM_TYPE>
Entry< GENUM_TYPE >::Entry  )  [inline]
 

Constructor.

template<class GENUM_TYPE>
Entry< GENUM_TYPE >::Entry const Entry< GENUM_TYPE > &  ent  ) 
 

Copy constructor.

template<class GENUM_TYPE>
Entry< GENUM_TYPE >::~Entry  )  [inline]
 

Distructor.


Member Function Documentation

template<class GENUM_TYPE>
void Entry< GENUM_TYPE >::Delete  ) 
 

Sets the parameter InUse to false

template<class GENUM_TYPE>
string Entry< GENUM_TYPE >::GetLabel  )  const
 

Return the label of the entry.

Returns:
the label of the entry.

template<class GENUM_TYPE>
void Entry< GENUM_TYPE >::GetS1E1 GENUM_TYPE &  start,
GENUM_TYPE &  end
const
 

Gets the start and end of the first segment.

Parameters:
start reference to a variable the its value will be the start of the first segment.
end reference to a variable the its value will be the end of the first segment.

template<class GENUM_TYPE>
void Entry< GENUM_TYPE >::GetS2E2 GENUM_TYPE &  start,
GENUM_TYPE &  end
const
 

Gets the start and end of the second segment.

Parameters:
start reference to a variable the its value will be the start of the second segment.
end reference to a variable the its value will be the end of the second segment.

template<class GENUM_TYPE>
bool Entry< GENUM_TYPE >::GetSign  )  const
 

Return the sign of the entry, true if the two segments have the same direction, false otherwise.

Returns:
the sign of the entry.

template<class GENUM_TYPE>
void Entry< GENUM_TYPE >::InseretEntry GENUM_TYPE  s_1,
GENUM_TYPE  e_1,
GENUM_TYPE  s_2,
GENUM_TYPE  e_2,
bool  sign_,
const string  label_
 

Sets the entry's parameters.

Parameters:
s_1 the start of the first segment of the entry.
e_1 the end of the first segment of the entry.
s_2 the start of the second segment of the entry.
e_2 the end of the second segment of the entry.
sign_ the sign of the entry.
label_ the label of the entry.

template<class GENUM_TYPE>
bool Entry< GENUM_TYPE >::IsInUse  )  const
 

Return true if the entry is in use.

Returns:
true if the entry is in use.

template<class GENUM_TYPE>
Entry< GENUM_TYPE > & Entry< GENUM_TYPE >::operator= const Entry< GENUM_TYPE > &  ent  ) 
 

operator =, copys all the variables of 'ent' to this .

template<class GENUM_TYPE>
bool Entry< GENUM_TYPE >::operator== const Entry< GENUM_TYPE > &  ent  )  const
 

operator ==, return true if the two entries have the same label .

template<class GENUM_TYPE>
void Entry< GENUM_TYPE >::SetS1E1 GENUM_TYPE  start,
GENUM_TYPE  end
 

Sets the start and end of the first segment.

Parameters:
start the new start of the first segment.
end the new end of the first segment.

template<class GENUM_TYPE>
void Entry< GENUM_TYPE >::SetS2E2 GENUM_TYPE  start,
GENUM_TYPE  end
 

Sets the start and end of the second segment.

Parameters:
start the new start of the second segment.
end the new end of the second segment.


Member Data Documentation

template<class GENUM_TYPE>
GENUM_TYPE Entry< GENUM_TYPE >::E1 [private]
 

template<class GENUM_TYPE>
GENUM_TYPE Entry< GENUM_TYPE >::E2 [private]
 

template<class GENUM_TYPE>
bool Entry< GENUM_TYPE >::InUse [private]
 

Indicates if the entry is used or not.

template<class GENUM_TYPE>
string Entry< GENUM_TYPE >::Label [private]
 

The entry's label.

template<class GENUM_TYPE>
GENUM_TYPE Entry< GENUM_TYPE >::S1 [private]
 

Starts and Ends of organisms 1 and 2.

template<class GENUM_TYPE>
GENUM_TYPE Entry< GENUM_TYPE >::S2 [private]
 

template<class GENUM_TYPE>
bool Entry< GENUM_TYPE >::Sign [private]
 

Entry's sign, if Sign = true that means the the direction of [S1,E1] and [S2,E2] are the same, if Sign = false the directions are opposite.


The documentation for this class was generated from the following file:
Generated on Sat May 6 13:40:42 2006 for MAGIC by  doxygen 1.4.6-NO