CFrameFinder Class Reference
[BLAST (Basic Local Alignment Search Tool)]

Search Toolkit Book for CFrameFinder

#include <blast_aux.hpp>

List of all members.

---

Detailed Description

Function object to assist in finding all CSeqLocInfo objects which corresponds to a given frame.

Definition at line 129 of file blast_aux.hpp.

Public Types
typedef CSeqLocInfo::ETranslationFrame	ETranslationFrame
	Convenience typedef.
Public Member Functions
	CFrameFinder (ETranslationFrame frame)
	ctor
bool	operator() (const CRef< CSeqLocInfo > &seqlocinfo) const
	Returns true if its argument's frame corresponds to the one used to create this object.
Private Attributes
ETranslationFrame	m_Frame
	Frame to look for.

---

Member Typedef Documentation

typedef CSeqLocInfo::ETranslationFrame CFrameFinder::ETranslationFrame

Convenience typedef. Definition at line 133 of file blast_aux.hpp.

---

Constructor & Destructor Documentation

CFrameFinder::CFrameFinder (  ETranslationFrame  frame  )  [inline]

ctor Parameters: frame  the translation frame [in] Definition at line 137 of file blast_aux.hpp.

---

Member Function Documentation

bool CFrameFinder::operator() (  const CRef< CSeqLocInfo > &  seqlocinfo  )  const [inline]

Returns true if its argument's frame corresponds to the one used to create this object. Parameters: seqlocinfo  the object to examine [in] Definition at line 142 of file blast_aux.hpp. References CRef< C, Locker >::Empty(), and NCBI_THROW.

---

Member Data Documentation

ETranslationFrame CFrameFinder::m_Frame [private]

Frame to look for. Definition at line 150 of file blast_aux.hpp.

---

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

• include/algo/blast/api/blast_aux.hpp

---