CFixedSeq_ids Class Reference

Search Toolkit Book for CFixedSeq_ids

#include <objtools/data_loaders/genbank/impl/request_result.hpp>

Collaboration diagram for CFixedSeq_ids:

Public Types
enum	{ kUnknownState = -256 }
typedef int	TState
typedef vector< CSeq_id_Handle >	TList
typedef TList::const_reference	const_reference
typedef TList::const_iterator	const_iterator

Public Member Functions
	CFixedSeq_ids (void)
	CFixedSeq_ids (TState state)
	CFixedSeq_ids (const TList &list, TState state=kUnknownState)
	CFixedSeq_ids (ENcbiOwnership ownership, TList &list, TState state=kUnknownState)
const TList &	Get (void) const
	operator const TList & (void) const
TState	GetState (void) const
bool	IsFound (void) const
void	SetState (TState state)
void	SetNotFound (void)
bool	empty (void) const
size_t	size (void) const
const_iterator	begin (void) const
const_iterator	end (void) const
const_reference	front (void) const
CDataLoader::SGiFound	FindGi (void) const
CDataLoader::SAccVerFound	FindAccVer (void) const
string	FindLabel (void) const

Private Types
typedef CObjectFor< TList >	TObject

Private Attributes
TState	m_State
CConstRef< TObject >	m_Ref

Detailed Description

Definition at line 75 of file request_result.hpp.

Member Typedef Documentation

const_iterator

typedef TList::const_iterator CFixedSeq_ids::const_iterator

Definition at line 81 of file request_result.hpp.

const_reference

typedef TList::const_reference CFixedSeq_ids::const_reference

Definition at line 80 of file request_result.hpp.

TList

typedef vector<CSeq_id_Handle> CFixedSeq_ids::TList

Definition at line 79 of file request_result.hpp.

TObject

typedef CObjectFor<TList> CFixedSeq_ids::TObject

private

Definition at line 144 of file request_result.hpp.

TState

typedef int CFixedSeq_ids::TState

Definition at line 78 of file request_result.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
kUnknownState

Definition at line 83 of file request_result.hpp.

Constructor & Destructor Documentation

CFixedSeq_ids() [1/4]

CFixedSeq_ids::CFixedSeq_ids

(

void

)

Definition at line 73 of file request_result.cpp.

CFixedSeq_ids() [2/4]

CFixedSeq_ids::CFixedSeq_ids ( TState  state )

explicit

Definition at line 80 of file request_result.cpp.

References SetNotFound().

CFixedSeq_ids() [3/4]

CFixedSeq_ids::CFixedSeq_ids ( const TList &  list, TState  state = kUnknownState  )

explicit

Definition at line 88 of file request_result.cpp.

References empty(), and SetNotFound().

CFixedSeq_ids() [4/4]

CFixedSeq_ids::CFixedSeq_ids	(	ENcbiOwnership	ownership,
		TList &	list,
		TState	state = kUnknownState
	)

Definition at line 98 of file request_result.cpp.

References empty(), eTakeOwnership, m_Ref, SetNotFound(), and swap().

Member Function Documentation

begin()

const_iterator CFixedSeq_ids::begin ( void  ) const

inline

Definition at line 126 of file request_result.hpp.

References Get().

Referenced by front().

empty()

bool CFixedSeq_ids::empty ( void  ) const

inline

Definition at line 118 of file request_result.hpp.

References Get().

Referenced by CFixedSeq_ids(), and IsFound().

end()

const_iterator CFixedSeq_ids::end ( void  ) const

inline

Definition at line 130 of file request_result.hpp.

References Get().

FindAccVer()

CDataLoader::SAccVerFound CFixedSeq_ids::FindAccVer

(

void

)

const

Definition at line 149 of file request_result.cpp.

References CDataLoader::SAccVerFound::acc_ver, IsFound(), ITERATE, and CDataLoader::SAccVerFound::sequence_found.

FindGi()

CDataLoader::SGiFound CFixedSeq_ids::FindGi

(

void

)

const

Definition at line 133 of file request_result.cpp.

References CSeq_id_Base::e_Gi, CDataLoader::SGiFound::gi, IsFound(), ITERATE, and CDataLoader::SGiFound::sequence_found.

FindLabel()

string CFixedSeq_ids::FindLabel

(

void

)

const

Definition at line 165 of file request_result.cpp.

References GetLabel(), IsFound(), and string.

front()

const_reference CFixedSeq_ids::front ( void  ) const

inline

Definition at line 134 of file request_result.hpp.

References begin().

Get()

const TList& CFixedSeq_ids::Get ( void  ) const

inline

Definition at line 95 of file request_result.hpp.

References m_Ref.

Referenced by begin(), empty(), end(), operator const TList &(), and size().

GetState()

TState CFixedSeq_ids::GetState ( void  ) const

inline

Definition at line 104 of file request_result.hpp.

References m_State.

Referenced by IsFound(), and CReader::SetAndSaveSeq_idSeq_ids().

IsFound()

bool CFixedSeq_ids::IsFound ( void  ) const

inline

Definition at line 109 of file request_result.hpp.

References empty(), CBioseq_Handle::fState_not_found, and GetState().

Referenced by FindAccVer(), FindGi(), FindLabel(), and CReader::SetAndSaveSeq_idSeq_ids().

operator const TList &()

CFixedSeq_ids::operator const TList & ( void  ) const

inline

Definition at line 99 of file request_result.hpp.

References Get().

SetNotFound()

void CFixedSeq_ids::SetNotFound

(

void

)

Definition at line 122 of file request_result.cpp.

References CBioseq_Handle::fState_no_data, CBioseq_Handle::fState_not_found, kUnknownState, and m_State.

Referenced by CFixedSeq_ids().

SetState()

void CFixedSeq_ids::SetState

(

TState

state

)

Definition at line 116 of file request_result.cpp.

References m_State.

size()

size_t CFixedSeq_ids::size ( void  ) const

inline

Definition at line 122 of file request_result.hpp.

References Get().

Referenced by CCacheWriter::WriteSeq_ids().

Member Data Documentation

m_Ref

CConstRef<TObject> CFixedSeq_ids::m_Ref

private

Definition at line 147 of file request_result.hpp.

Referenced by CFixedSeq_ids(), and Get().

m_State

TState CFixedSeq_ids::m_State

private

Definition at line 146 of file request_result.hpp.

Referenced by GetState(), SetNotFound(), and SetState().

---

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

• include/objtools/data_loaders/genbank/impl/request_result.hpp
• src/objtools/data_loaders/genbank/request_result.cpp