CSeqLocInfo Class Reference

Search Toolkit Book for CSeqLocInfo

#include <seqlocinfo.hpp>

Inheritance diagram for CSeqLocInfo:

Inheritance graph
[legend]
Collaboration diagram for CSeqLocInfo:

Collaboration graph
[legend]
List of all members.

Detailed Description

structure for seqloc info

Definition at line 48 of file seqlocinfo.hpp.

Public Types

enum  ETranslationFrame {
  eFramePlus1 = 1, eFramePlus2 = 2, eFramePlus3 = 3, eFrameMinus1 = -1,
  eFrameMinus2 = -2, eFrameMinus3 = -3, eFrameNotSet = 0
}

Public Member Functions

 CSeqLocInfo (objects::CSeq_interval *interval, int frame)
 CSeqLocInfo (objects::CSeq_id &id, TSeqRange &range, int frame)
const objects::CSeq_interval & GetInterval () const
const objects::CSeq_id & GetSeqId () const
void SetInterval (objects::CSeq_interval *interval)
objects::ENa_strand GetStrand () const
 Convert the frame to a strand.
int GetFrame () const
void SetFrame (int frame)
 operator TSeqRange () const
 operator pair () const
bool operator== (const CSeqLocInfo &rhs) const
bool operator!= (const CSeqLocInfo &rhs) const

Private Attributes

CRef< objects::CSeq_interval > m_Interval
ETranslationFrame m_Frame

Friends

ostream & operator<< (ostream &out, const CSeqLocInfo &rhs)


Member Enumeration Documentation

enum CSeqLocInfo::ETranslationFrame
 

Enumerator:
eFramePlus1 
eFramePlus2 
eFramePlus3 
eFrameMinus1 
eFrameMinus2 
eFrameMinus3 
eFrameNotSet 

Definition at line 50 of file seqlocinfo.hpp.


Constructor & Destructor Documentation

CSeqLocInfo::CSeqLocInfo objects::CSeq_interval *  interval,
int  frame
[inline]
 

Definition at line 60 of file seqlocinfo.hpp.

CSeqLocInfo::CSeqLocInfo objects::CSeq_id &  id,
TSeqRange range,
int  frame
[inline]
 

Definition at line 64 of file seqlocinfo.hpp.


Member Function Documentation

int CSeqLocInfo::GetFrame void   )  const [inline]
 

Definition at line 79 of file seqlocinfo.hpp.

Referenced by GetStrand(), and operator==().

const objects::CSeq_interval& CSeqLocInfo::GetInterval void   )  const [inline]
 

Definition at line 69 of file seqlocinfo.hpp.

const objects::CSeq_id& CSeqLocInfo::GetSeqId void   )  const [inline]
 

Definition at line 71 of file seqlocinfo.hpp.

Referenced by operator==().

objects::ENa_strand CSeqLocInfo::GetStrand  )  const
 

Convert the frame to a strand.

Definition at line 39 of file seqlocinfo.cpp.

References eFrameMinus1, eFrameMinus2, eFrameMinus3, eFrameNotSet, eFramePlus1, eFramePlus2, eFramePlus3, ENa_strand(), eNa_strand_minus, eNa_strand_plus, eNa_strand_unknown, and GetFrame().

CSeqLocInfo::operator pair  )  const [inline]
 

Definition at line 87 of file seqlocinfo.hpp.

CSeqLocInfo::operator TSeqRange  )  const [inline]
 

Definition at line 83 of file seqlocinfo.hpp.

bool CSeqLocInfo::operator!= const CSeqLocInfo rhs  )  const [inline]
 

Definition at line 100 of file seqlocinfo.hpp.

bool CSeqLocInfo::operator== const CSeqLocInfo rhs  )  const
 

Definition at line 62 of file seqlocinfo.cpp.

References GetFrame(), GetSeqId(), and Match().

void CSeqLocInfo::SetFrame int  frame  ) 
 

Definition at line 82 of file seqlocinfo.cpp.

References NStr::IntToString(), and m_Frame.

Referenced by BOOST_AUTO_TEST_CASE().

void CSeqLocInfo::SetInterval objects::CSeq_interval *  interval  )  [inline]
 

Definition at line 73 of file seqlocinfo.hpp.


Friends And Related Function Documentation

ostream& operator<< ostream &  out,
const CSeqLocInfo rhs
[friend]
 

Definition at line 92 of file seqlocinfo.hpp.


Member Data Documentation

ETranslationFrame CSeqLocInfo::m_Frame [private]
 

Definition at line 106 of file seqlocinfo.hpp.

Referenced by SetFrame().

CRef<objects::CSeq_interval> CSeqLocInfo::m_Interval [private]
 

Definition at line 105 of file seqlocinfo.hpp.


The documentation for this class was generated from the following files:
Generated on Wed Dec 9 08:08:23 2009 for NCBI C++ ToolKit by  doxygen 1.4.6
Modified on Wed Dec 09 08:19:56 2009 by modify_doxy.py rev. 173732