CBioseqInfoFetchRequest Class Reference

Search Toolkit Book for CBioseqInfoFetchRequest

#include <objtools/pubseq_gateway/impl/cassandra/request.hpp>

Public Types
enum class	EFields : TFields { eAccession = 1 , eVersion = 2 , eSeqIdType = 4 , eGI = 8 }

Public Member Functions
	CBioseqInfoFetchRequest ()=default
	CBioseqInfoFetchRequest (CBioseqInfoFetchRequest const &)=default
	CBioseqInfoFetchRequest (CBioseqInfoFetchRequest &&)=default
CBioseqInfoFetchRequest &	operator= (CBioseqInfoFetchRequest const &)=default
CBioseqInfoFetchRequest &	operator= (CBioseqInfoFetchRequest &&)=default
CBioseqInfoFetchRequest &	SetAccession (CBioseqInfoRecord::TAccession const &value)
CBioseqInfoFetchRequest &	SetVersion (CBioseqInfoRecord::TVersion value)
CBioseqInfoFetchRequest &	SetSeqIdType (CBioseqInfoRecord::TSeqIdType value)
CBioseqInfoFetchRequest &	SetGI (CBioseqInfoRecord::TGI value)
CBioseqInfoRecord::TAccession	GetAccession () const
CBioseqInfoRecord::TGI	GetGI () const
CBioseqInfoRecord::TVersion	GetVersion () const
CBioseqInfoRecord::TSeqIdType	GetSeqIdType () const
bool	HasField (EFields field) const
CBioseqInfoFetchRequest &	Reset ()
string	ToString () const

Private Types
using	TFields = uint8_t

Private Member Functions
void	SetField (EFields value)

Private Attributes
string	m_Accession
CBioseqInfoRecord::TGI	m_GI = 0
CBioseqInfoRecord::TVersion	m_Version = 0
CBioseqInfoRecord::TSeqIdType	m_SeqIdType = 0
TFields	m_State = 0

Detailed Description

Definition at line 47 of file request.hpp.

Member Typedef Documentation

TFields

using CBioseqInfoFetchRequest::TFields = uint8_t

private

Definition at line 49 of file request.hpp.

Member Enumeration Documentation

EFields

enum CBioseqInfoFetchRequest::EFields : TFields

strong

Enumerator
eAccession
eVersion
eSeqIdType
eGI

Definition at line 51 of file request.hpp.

Constructor & Destructor Documentation

CBioseqInfoFetchRequest() [1/3]

CBioseqInfoFetchRequest::CBioseqInfoFetchRequest ( )

default

CBioseqInfoFetchRequest() [2/3]

CBioseqInfoFetchRequest::CBioseqInfoFetchRequest ( CBioseqInfoFetchRequest const &  )

default

CBioseqInfoFetchRequest() [3/3]

CBioseqInfoFetchRequest::CBioseqInfoFetchRequest ( CBioseqInfoFetchRequest &&  )

default

Member Function Documentation

GetAccession()

CBioseqInfoRecord::TAccession CBioseqInfoFetchRequest::GetAccession ( void  ) const

inline

Definition at line 94 of file request.hpp.

References eAccession, HasField(), m_Accession, and NCBI_USER_THROW.

Referenced by CPubseqGatewayCacheBioseqInfo::Fetch(), ToJsonString(), and CPubseqGatewayCacheBioseqInfo::x_MakeLookupKey().

GetGI()

CBioseqInfoRecord::TGI CBioseqInfoFetchRequest::GetGI ( void  ) const

inline

Definition at line 102 of file request.hpp.

References eGI, HasField(), m_GI, and NCBI_USER_THROW.

Referenced by ToJsonString(), CCassBioseqInfoTaskFetch::x_InitializeQuery(), CCassBioseqInfoTaskFetch::x_IsMatchingRecord(), CPubseqGatewayCacheBioseqInfo::x_IsMatchingRecord(), and CPubseqGatewayCacheBioseqInfo::x_MakeLookupKey().

GetSeqIdType()

CBioseqInfoRecord::TSeqIdType CBioseqInfoFetchRequest::GetSeqIdType ( ) const

inline

Definition at line 118 of file request.hpp.

References eSeqIdType, HasField(), m_SeqIdType, and NCBI_USER_THROW.

Referenced by ToJsonString(), CCassBioseqInfoTaskFetch::Wait1(), CCassBioseqInfoTaskFetch::x_InitializeQuery(), CCassBioseqInfoTaskFetch::x_IsMatchingRecord(), CPubseqGatewayCacheBioseqInfo::x_IsMatchingRecord(), and CPubseqGatewayCacheBioseqInfo::x_MakeLookupKey().

GetVersion()

CBioseqInfoRecord::TVersion CBioseqInfoFetchRequest::GetVersion ( void  ) const

inline

Definition at line 110 of file request.hpp.

References eVersion, HasField(), m_Version, and NCBI_USER_THROW.

Referenced by ToJsonString(), CCassBioseqInfoTaskFetch::Wait1(), CCassBioseqInfoTaskFetch::x_InitializeQuery(), CCassBioseqInfoTaskFetch::x_IsMatchingRecord(), CPubseqGatewayCacheBioseqInfo::x_IsMatchingRecord(), and CPubseqGatewayCacheBioseqInfo::x_MakeLookupKey().

HasField()

bool CBioseqInfoFetchRequest::HasField ( EFields  field ) const

inline

Definition at line 126 of file request.hpp.

References m_State.

Referenced by CPubseqGatewayCacheBioseqInfo::Fetch(), CPubseqGatewayCache::FetchBioseqInfo(), GetAccession(), GetGI(), GetSeqIdType(), GetVersion(), ToJsonString(), ToString(), CCassBioseqInfoTaskFetch::Wait1(), CCassBioseqInfoTaskFetch::x_InitializeQuery(), CCassBioseqInfoTaskFetch::x_IsMatchingRecord(), CPubseqGatewayCacheBioseqInfo::x_IsMatchingRecord(), and CPubseqGatewayCacheBioseqInfo::x_MakeLookupKey().

operator=() [1/2]

CBioseqInfoFetchRequest& CBioseqInfoFetchRequest::operator= ( CBioseqInfoFetchRequest &&  )

default

operator=() [2/2]

CBioseqInfoFetchRequest& CBioseqInfoFetchRequest::operator= ( CBioseqInfoFetchRequest const &  )

default

Reset()

CBioseqInfoFetchRequest& CBioseqInfoFetchRequest::Reset ( void  )

inline

Definition at line 131 of file request.hpp.

References m_Accession, m_GI, m_SeqIdType, m_State, and m_Version.

SetAccession()

CBioseqInfoFetchRequest& CBioseqInfoFetchRequest::SetAccession ( CBioseqInfoRecord::TAccession const &  value )

inline

Definition at line 64 of file request.hpp.

References eAccession, m_Accession, SetField(), and rapidjson::value.

Referenced by ApplyInheritedSeqIds(), CPSGCache::x_LookupBioseqInfo(), CPSGCache::x_LookupINSDCBioseqInfo(), CPSGS_AsyncBioseqInfoBase::x_MakeRequest(), and CPSGS_AsyncResolveBase::x_PreparePrimaryBioseqInfoQuery().

SetField()

void CBioseqInfoFetchRequest::SetField ( EFields  value )

inlineprivate

Definition at line 172 of file request.hpp.

References m_State, and rapidjson::value.

Referenced by SetAccession(), SetGI(), SetSeqIdType(), and SetVersion().

SetGI()

CBioseqInfoFetchRequest& CBioseqInfoFetchRequest::SetGI ( CBioseqInfoRecord::TGI  value )

inline

Definition at line 87 of file request.hpp.

References eGI, m_GI, SetField(), and rapidjson::value.

Referenced by CPSGCache::x_LookupBioseqInfo(), CPSGCache::x_LookupINSDCBioseqInfo(), CPSGS_AsyncBioseqInfoBase::x_MakeRequest(), and CPSGS_AsyncResolveBase::x_PreparePrimaryBioseqInfoQuery().

SetSeqIdType()

CBioseqInfoFetchRequest& CBioseqInfoFetchRequest::SetSeqIdType ( CBioseqInfoRecord::TSeqIdType  value )

inline

Definition at line 80 of file request.hpp.

References eSeqIdType, m_SeqIdType, SetField(), and rapidjson::value.

Referenced by ApplyInheritedSeqIds(), CPSGCache::x_LookupBioseqInfo(), CPSGS_AsyncBioseqInfoBase::x_MakeRequest(), and CPSGS_AsyncResolveBase::x_PreparePrimaryBioseqInfoQuery().

SetVersion()

CBioseqInfoFetchRequest& CBioseqInfoFetchRequest::SetVersion ( CBioseqInfoRecord::TVersion  value )

inline

Definition at line 73 of file request.hpp.

References eVersion, m_Version, SetField(), and rapidjson::value.

Referenced by CPSGCache::x_LookupBioseqInfo(), CPSGCache::x_LookupINSDCBioseqInfo(), CPSGS_AsyncBioseqInfoBase::x_MakeRequest(), and CPSGS_AsyncResolveBase::x_PreparePrimaryBioseqInfoQuery().

ToString()

string CBioseqInfoFetchRequest::ToString ( void  ) const

inline

Definition at line 141 of file request.hpp.

References eAccession, eGI, eSeqIdType, eVersion, HasField(), m_Accession, m_GI, m_SeqIdType, m_Version, and result.

Member Data Documentation

m_Accession

string CBioseqInfoFetchRequest::m_Accession

private

Definition at line 177 of file request.hpp.

Referenced by GetAccession(), Reset(), SetAccession(), and ToString().

m_GI

CBioseqInfoRecord::TGI CBioseqInfoFetchRequest::m_GI = 0

private

Definition at line 178 of file request.hpp.

Referenced by GetGI(), Reset(), SetGI(), and ToString().

m_SeqIdType

CBioseqInfoRecord::TSeqIdType CBioseqInfoFetchRequest::m_SeqIdType = 0

private

Definition at line 180 of file request.hpp.

Referenced by GetSeqIdType(), Reset(), SetSeqIdType(), and ToString().

m_State

TFields CBioseqInfoFetchRequest::m_State = 0

private

Definition at line 181 of file request.hpp.

Referenced by HasField(), Reset(), and SetField().

m_Version

CBioseqInfoRecord::TVersion CBioseqInfoFetchRequest::m_Version = 0

private

Definition at line 179 of file request.hpp.

Referenced by GetVersion(), Reset(), SetVersion(), and ToString().

---

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

• include/objtools/pubseq_gateway/impl/cassandra/request.hpp