NCBI C++ ToolKit
Public Types | Public Member Functions | Static Public Attributes | Private Attributes | List of all members
CBioseqInfoRecord Class Reference

Search Toolkit Book for CBioseqInfoRecord

#include <objtools/pubseq_gateway/impl/cassandra/bioseq_info/record.hpp>

+ Collaboration diagram for CBioseqInfoRecord:

Public Types

using TAccession = string
 
using TName = string
 
using TVersion = int16_t
 
using TSeqIdType = int16_t
 
using TDateChanged = int64_t
 
using THash = int32_t
 
using TGI = int64_t
 
using TLength = int32_t
 
using TMol = int8_t
 
using TSat = int16_t
 
using TSatKey = int32_t
 
using TSeqIds = set< tuple< int16_t, string > >
 
using TSeqState = int8_t
 
using TState = int8_t
 
using TTaxId = int32_t
 
using TWritetime = int64_t
 

Public Member Functions

 CBioseqInfoRecord ()
 
void Reset ()
 
 CBioseqInfoRecord (CBioseqInfoRecord const &)=default
 
CBioseqInfoRecord & operator= (CBioseqInfoRecord const &)=default
 
CBioseqInfoRecord & operator= (CBioseqInfoRecord &&)=default
 
CBioseqInfoRecord & SetAccession (const TAccession &value)
 
CBioseqInfoRecord & SetVersion (TVersion value)
 
CBioseqInfoRecord & SetSeqIdType (TSeqIdType value)
 
CBioseqInfoRecord & SetDateChanged (TDateChanged value)
 
CBioseqInfoRecord & SetHash (THash value)
 
CBioseqInfoRecord & SetGI (TGI value)
 
CBioseqInfoRecord & SetLength (TLength value)
 
CBioseqInfoRecord & SetMol (TMol value)
 
CBioseqInfoRecord & SetSat (TSat value)
 
CBioseqInfoRecord & SetSatKey (TSatKey value)
 
CBioseqInfoRecord & SetSeqIds (TSeqIds const &value)
 
CBioseqInfoRecord & SetSeqIds (TSeqIds &&value)
 
CBioseqInfoRecord & SetSeqState (TSeqState value)
 
CBioseqInfoRecord & SetState (TState value)
 
CBioseqInfoRecord & SetTaxId (TTaxId value)
 
CBioseqInfoRecord & SetName (TName value)
 
CBioseqInfoRecord & SetWritetime (TWritetime value)
 
TAccession const & GetAccession () const
 
TVersion GetVersion () const
 
TSeqIdType GetSeqIdType () const
 
TDateChanged GetDateChanged () const
 
THash GetHash () const
 
TGI GetGI () const
 
TLength GetLength () const
 
TMol GetMol () const
 
TSat GetSat () const
 
TSatKey GetSatKey () const
 
TSeqIds & GetSeqIds ()
 
TSeqIds const & GetSeqIds () const
 
TSeqState GetSeqState () const
 
TState GetState () const
 
TTaxId GetTaxId () const
 
TName GetName () const
 
TWritetime GetWritetime () const
 
string ToString () const
 

Static Public Attributes

static const TState kStateAlive = 10
 

Private Attributes

TAccession m_Accession
 
TVersion m_Version
 
TSeqIdType m_SeqIdType
 
TGI m_GI
 
TName m_Name
 
TDateChanged m_DateChanged
 
THash m_Hash
 
TLength m_Length
 
TMol m_Mol
 
TSat m_Sat
 
TSatKey m_SatKey
 
TSeqIds m_SeqIds
 
TSeqState m_SeqState
 
TState m_State
 
TTaxId m_TaxId
 
TWritetime m_Writetime
 

Detailed Description

Definition at line 48 of file record.hpp.

Member Typedef Documentation

◆ TAccession

using CBioseqInfoRecord::TAccession = string

Definition at line 51 of file record.hpp.

◆ TDateChanged

using CBioseqInfoRecord::TDateChanged = int64_t

Definition at line 55 of file record.hpp.

◆ TGI

using CBioseqInfoRecord::TGI = int64_t

Definition at line 57 of file record.hpp.

◆ THash

using CBioseqInfoRecord::THash = int32_t

Definition at line 56 of file record.hpp.

◆ TLength

using CBioseqInfoRecord::TLength = int32_t

Definition at line 58 of file record.hpp.

◆ TMol

using CBioseqInfoRecord::TMol = int8_t

Definition at line 59 of file record.hpp.

◆ TName

using CBioseqInfoRecord::TName = string

Definition at line 52 of file record.hpp.

◆ TSat

using CBioseqInfoRecord::TSat = int16_t

Definition at line 60 of file record.hpp.

◆ TSatKey

using CBioseqInfoRecord::TSatKey = int32_t

Definition at line 61 of file record.hpp.

◆ TSeqIds

using CBioseqInfoRecord::TSeqIds = set<tuple<int16_t, string> >

Definition at line 62 of file record.hpp.

◆ TSeqIdType

using CBioseqInfoRecord::TSeqIdType = int16_t

Definition at line 54 of file record.hpp.

◆ TSeqState

using CBioseqInfoRecord::TSeqState = int8_t

Definition at line 63 of file record.hpp.

◆ TState

using CBioseqInfoRecord::TState = int8_t

Definition at line 64 of file record.hpp.

◆ TTaxId

using CBioseqInfoRecord::TTaxId = int32_t

Definition at line 65 of file record.hpp.

◆ TVersion

using CBioseqInfoRecord::TVersion = int16_t

Definition at line 53 of file record.hpp.

◆ TWritetime

using CBioseqInfoRecord::TWritetime = int64_t

Definition at line 66 of file record.hpp.

Constructor & Destructor Documentation

◆ CBioseqInfoRecord() [1/2]

CBioseqInfoRecord::CBioseqInfoRecord ( )
inline

Definition at line 71 of file record.hpp.

◆ CBioseqInfoRecord() [2/2]

CBioseqInfoRecord::CBioseqInfoRecord ( CBioseqInfoRecord const &  )
default

Member Function Documentation

◆ GetAccession()

TAccession const& CBioseqInfoRecord::GetAccession ( void  ) const
inline

Definition at line 198 of file record.hpp.

References m_Accession.

Referenced by SBioseqResolution::AdjustAccession(), ApplyInheritedSeqIds(), GetBioseqRecordId(), SBioseqResolution::SetBioseqInfo(), ToBioseqProtobuf(), ToJsonString(), CPSGS_IPGResolveProcessor::x_FormSeqId(), CPSGCache::x_LookupBioseqInfo(), CPSGCache::x_LookupINSDCBioseqInfo(), CPSGCache::x_LookupSi2csi(), CPSGS_AsyncBioseqInfoBase::x_MakeRequest(), CPSGS_AsyncBioseqInfoBase::x_OnBioseqInfo(), CPSGS_AsyncResolveBase::x_OnBioseqInfo(), CPSGS_AsyncResolveBase::x_OnBioseqInfoWithoutSeqIdType(), and CPSGS_AsyncResolveBase::x_Process().

◆ GetDateChanged()

TDateChanged CBioseqInfoRecord::GetDateChanged ( ) const
inline

Definition at line 213 of file record.hpp.

References m_DateChanged.

Referenced by ToBioseqProtobuf(), and ToJsonString().

◆ GetGI()

TGI CBioseqInfoRecord::GetGI ( void  ) const
inline

Definition at line 223 of file record.hpp.

References m_GI.

Referenced by GetBioseqRecordId(), ToBioseqProtobuf(), ToJsonString(), CCassBioseqInfoTaskFetch::x_IsMatchingNewRecord(), CPSGCache::x_LookupBioseqInfo(), CPSGCache::x_LookupINSDCBioseqInfo(), CPSGS_AsyncBioseqInfoBase::x_MakeRequest(), and CPSGS_AsyncResolveBase::x_Process().

◆ GetHash()

THash CBioseqInfoRecord::GetHash ( void  ) const
inline

Definition at line 218 of file record.hpp.

References m_Hash.

Referenced by ToBioseqProtobuf(), and ToJsonString().

◆ GetLength()

TLength CBioseqInfoRecord::GetLength ( void  ) const
inline

Definition at line 228 of file record.hpp.

References m_Length.

Referenced by ToBioseqProtobuf(), and ToJsonString().

◆ GetMol()

TMol CBioseqInfoRecord::GetMol ( void  ) const
inline

Definition at line 233 of file record.hpp.

References m_Mol.

Referenced by ToBioseqProtobuf(), and ToJsonString().

◆ GetName()

TName CBioseqInfoRecord::GetName ( void  ) const
inline

Definition at line 273 of file record.hpp.

References m_Name.

Referenced by ToBioseqProtobuf(), ToJsonString(), and CPSGS_IPGResolveProcessor::x_FormSeqId().

◆ GetSat()

TSat CBioseqInfoRecord::GetSat ( void  ) const
inline

Definition at line 238 of file record.hpp.

References m_Sat.

Referenced by ToBioseqProtobuf(), and ToJsonString().

◆ GetSatKey()

TSatKey CBioseqInfoRecord::GetSatKey ( void  ) const
inline

Definition at line 243 of file record.hpp.

References m_SatKey.

Referenced by ToBioseqProtobuf(), and ToJsonString().

◆ GetSeqIds() [1/2]

TSeqIds& CBioseqInfoRecord::GetSeqIds ( void  )
inline

Definition at line 248 of file record.hpp.

References m_SeqIds.

Referenced by SBioseqResolution::AdjustAccession(), ApplyInheritedSeqIds(), ToBioseqProtobuf(), ToJsonString(), CCassBioseqInfoTaskFetch::x_MergeSeqIds(), and CCassBioseqInfoTaskFetch::x_PopulateRecord().

◆ GetSeqIds() [2/2]

TSeqIds const& CBioseqInfoRecord::GetSeqIds ( void  ) const
inline

Definition at line 253 of file record.hpp.

References m_SeqIds.

◆ GetSeqIdType()

TSeqIdType CBioseqInfoRecord::GetSeqIdType ( ) const
inline

Definition at line 208 of file record.hpp.

References m_SeqIdType.

Referenced by SBioseqResolution::AdjustAccession(), CPSGS_AsyncResolveBase::AdjustBioseqAccession(), ApplyInheritedSeqIds(), CPSGS_AsyncResolveBase::CanSkipBioseqInfoRetrieval(), GetBioseqRecordId(), SBioseqResolution::SetBioseqInfo(), ToBioseqProtobuf(), ToJsonString(), CPSGS_IPGResolveProcessor::x_FormSeqId(), CCassBioseqInfoTaskFetch::x_IsMatchingNewRecord(), CPSGCache::x_LookupBioseqInfo(), CPSGCache::x_LookupSi2csi(), CPSGS_AsyncBioseqInfoBase::x_MakeRequest(), CPSGS_AsyncBioseqInfoBase::x_OnBioseqInfo(), and CPSGS_AsyncResolveBase::x_Process().

◆ GetSeqState()

TSeqState CBioseqInfoRecord::GetSeqState ( ) const
inline

Definition at line 258 of file record.hpp.

References m_SeqState.

Referenced by ToBioseqProtobuf(), and ToJsonString().

◆ GetState()

TState CBioseqInfoRecord::GetState ( void  ) const
inline

Definition at line 263 of file record.hpp.

References m_State.

Referenced by ApplyInheritedSeqIds(), ToBioseqProtobuf(), and ToJsonString().

◆ GetTaxId()

TTaxId CBioseqInfoRecord::GetTaxId ( void  ) const
inline

Definition at line 268 of file record.hpp.

References m_TaxId.

Referenced by ToBioseqProtobuf(), and ToJsonString().

◆ GetVersion()

TVersion CBioseqInfoRecord::GetVersion ( void  ) const
inline

Definition at line 203 of file record.hpp.

References m_Version.

Referenced by SBioseqResolution::AdjustAccession(), CPSGS_AsyncResolveBase::AdjustBioseqAccession(), CPSGS_AsyncResolveBase::CanSkipBioseqInfoRetrieval(), GetBioseqRecordId(), ToBioseqProtobuf(), ToJsonString(), CPSGS_IPGResolveProcessor::x_FormSeqId(), CCassBioseqInfoTaskFetch::x_IsMatchingNewRecord(), CPSGCache::x_LookupBioseqInfo(), CPSGCache::x_LookupINSDCBioseqInfo(), CPSGS_AsyncBioseqInfoBase::x_MakeRequest(), CPSGS_AsyncBioseqInfoBase::x_OnBioseqInfoWithoutSeqIdType(), and CPSGS_AsyncResolveBase::x_Process().

◆ GetWritetime()

TWritetime CBioseqInfoRecord::GetWritetime ( ) const
inline

Definition at line 278 of file record.hpp.

References m_Writetime.

◆ operator=() [1/2]

CBioseqInfoRecord& CBioseqInfoRecord::operator= ( CBioseqInfoRecord &&  )
default

◆ operator=() [2/2]

CBioseqInfoRecord& CBioseqInfoRecord::operator= ( CBioseqInfoRecord const &  )
default

◆ Reset()

void CBioseqInfoRecord::Reset ( void  )

Definition at line 43 of file record.cpp.

References set< Key, Compare >::clear(), m_Accession, m_DateChanged, m_GI, m_Hash, m_Length, m_Mol, m_Sat, m_SatKey, m_SeqIds, m_SeqIdType, m_SeqState, m_State, m_TaxId, m_Version, and m_Writetime.

Referenced by CPSGS_AsyncResolveBase::x_Process().

◆ SetAccession()

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

Definition at line 94 of file record.hpp.

References m_Accession, and rapidjson::value.

Referenced by SBioseqResolution::AdjustAccession(), CPSGCache::x_LookupSi2csi(), CPSGS_AsyncResolveBase::x_OnSi2csiRecord(), CCassBioseqInfoTaskFetch::x_PopulateRecord(), CPSGS_ResolveBase::x_ResolvePrimaryOSLTInCache(), and CPSGS_ResolveBase::x_ResolveSecondaryOSLTInCache().

◆ SetDateChanged()

CBioseqInfoRecord& CBioseqInfoRecord::SetDateChanged ( TDateChanged  value)
inline

Definition at line 112 of file record.hpp.

References m_DateChanged, and rapidjson::value.

Referenced by CPubseqGatewayCacheBioseqInfo::x_ExtractRecord(), and CCassBioseqInfoTaskFetch::x_PopulateRecord().

◆ SetGI()

CBioseqInfoRecord& CBioseqInfoRecord::SetGI ( TGI  value)
inline

Definition at line 124 of file record.hpp.

References m_GI, and rapidjson::value.

Referenced by CPSGCache::x_LookupSi2csi(), CPSGS_AsyncResolveBase::x_OnSi2csiRecord(), and CCassBioseqInfoTaskFetch::x_PopulateRecord().

◆ SetHash()

CBioseqInfoRecord& CBioseqInfoRecord::SetHash ( THash  value)
inline

Definition at line 118 of file record.hpp.

References m_Hash, and rapidjson::value.

Referenced by CPubseqGatewayCacheBioseqInfo::x_ExtractRecord(), and CCassBioseqInfoTaskFetch::x_PopulateRecord().

◆ SetLength()

CBioseqInfoRecord& CBioseqInfoRecord::SetLength ( TLength  value)
inline

Definition at line 130 of file record.hpp.

References m_Length, and rapidjson::value.

Referenced by CPubseqGatewayCacheBioseqInfo::x_ExtractRecord(), and CCassBioseqInfoTaskFetch::x_PopulateRecord().

◆ SetMol()

CBioseqInfoRecord& CBioseqInfoRecord::SetMol ( TMol  value)
inline

Definition at line 136 of file record.hpp.

References m_Mol, and rapidjson::value.

Referenced by CPubseqGatewayCacheBioseqInfo::x_ExtractRecord(), and CCassBioseqInfoTaskFetch::x_PopulateRecord().

◆ SetName()

CBioseqInfoRecord& CBioseqInfoRecord::SetName ( TName  value)
inline

Definition at line 184 of file record.hpp.

References m_Name, and rapidjson::value.

Referenced by CPubseqGatewayCacheBioseqInfo::x_ExtractRecord(), and CCassBioseqInfoTaskFetch::x_PopulateRecord().

◆ SetSat()

CBioseqInfoRecord& CBioseqInfoRecord::SetSat ( TSat  value)
inline

Definition at line 142 of file record.hpp.

References m_Sat, and rapidjson::value.

Referenced by CPubseqGatewayCacheBioseqInfo::x_ExtractRecord(), and CCassBioseqInfoTaskFetch::x_PopulateRecord().

◆ SetSatKey()

CBioseqInfoRecord& CBioseqInfoRecord::SetSatKey ( TSatKey  value)
inline

Definition at line 148 of file record.hpp.

References m_SatKey, and rapidjson::value.

Referenced by CPubseqGatewayCacheBioseqInfo::x_ExtractRecord(), and CCassBioseqInfoTaskFetch::x_PopulateRecord().

◆ SetSeqIds() [1/2]

CBioseqInfoRecord& CBioseqInfoRecord::SetSeqIds ( TSeqIds &&  value)
inline

Definition at line 160 of file record.hpp.

References m_SeqIds, and rapidjson::value.

◆ SetSeqIds() [2/2]

CBioseqInfoRecord& CBioseqInfoRecord::SetSeqIds ( TSeqIds const &  value)
inline

Definition at line 154 of file record.hpp.

References m_SeqIds, and rapidjson::value.

Referenced by CPubseqGatewayCacheBioseqInfo::x_ExtractRecord().

◆ SetSeqIdType()

CBioseqInfoRecord& CBioseqInfoRecord::SetSeqIdType ( TSeqIdType  value)
inline

Definition at line 106 of file record.hpp.

References m_SeqIdType, and rapidjson::value.

Referenced by SBioseqResolution::AdjustAccession(), CPSGCache::x_LookupSi2csi(), CPSGS_AsyncResolveBase::x_OnSi2csiRecord(), CCassBioseqInfoTaskFetch::x_PopulateRecord(), CPSGS_ResolveBase::x_ResolvePrimaryOSLTInCache(), and CPSGS_ResolveBase::x_ResolveSecondaryOSLTInCache().

◆ SetSeqState()

CBioseqInfoRecord& CBioseqInfoRecord::SetSeqState ( TSeqState  value)
inline

Definition at line 166 of file record.hpp.

References m_SeqState, and rapidjson::value.

Referenced by CPubseqGatewayCacheBioseqInfo::x_ExtractRecord(), and CCassBioseqInfoTaskFetch::x_PopulateRecord().

◆ SetState()

CBioseqInfoRecord& CBioseqInfoRecord::SetState ( TState  value)
inline

Definition at line 172 of file record.hpp.

References m_State, and rapidjson::value.

Referenced by CPubseqGatewayCacheBioseqInfo::x_ExtractRecord(), and CCassBioseqInfoTaskFetch::x_PopulateRecord().

◆ SetTaxId()

CBioseqInfoRecord& CBioseqInfoRecord::SetTaxId ( TTaxId  value)
inline

Definition at line 178 of file record.hpp.

References m_TaxId, and rapidjson::value.

Referenced by CPubseqGatewayCacheBioseqInfo::x_ExtractRecord(), and CCassBioseqInfoTaskFetch::x_PopulateRecord().

◆ SetVersion()

CBioseqInfoRecord& CBioseqInfoRecord::SetVersion ( TVersion  value)
inline

Definition at line 100 of file record.hpp.

References m_Version, and rapidjson::value.

Referenced by CPSGCache::x_LookupSi2csi(), CPSGS_AsyncResolveBase::x_OnSi2csiRecord(), CCassBioseqInfoTaskFetch::x_PopulateRecord(), and CPSGS_ResolveBase::x_ResolvePrimaryOSLTInCache().

◆ SetWritetime()

CBioseqInfoRecord& CBioseqInfoRecord::SetWritetime ( TWritetime  value)
inline

Definition at line 190 of file record.hpp.

References m_Writetime, and rapidjson::value.

Referenced by CCassBioseqInfoTaskFetch::x_PopulateRecord().

◆ ToString()

string CBioseqInfoRecord::ToString ( void  ) const

Definition at line 62 of file record.cpp.

References m_Accession, m_DateChanged, m_GI, m_Hash, m_Length, m_Mol, m_Name, m_Sat, m_SatKey, m_SeqIdType, m_SeqState, m_State, m_TaxId, m_Version, and NStr::NumericToString().

Member Data Documentation

◆ kStateAlive

const TState CBioseqInfoRecord::kStateAlive = 10
static

Definition at line 68 of file record.hpp.

Referenced by CCassBioseqInfoTaskFetch::x_InheritanceRequired(), and CCassBioseqInfoTaskFetch::x_MergeSeqIds().

◆ m_Accession

TAccession CBioseqInfoRecord::m_Accession
private

Definition at line 286 of file record.hpp.

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

◆ m_DateChanged

TDateChanged CBioseqInfoRecord::m_DateChanged
private

Definition at line 292 of file record.hpp.

Referenced by GetDateChanged(), Reset(), SetDateChanged(), and ToString().

◆ m_GI

TGI CBioseqInfoRecord::m_GI
private

Definition at line 289 of file record.hpp.

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

◆ m_Hash

THash CBioseqInfoRecord::m_Hash
private

Definition at line 293 of file record.hpp.

Referenced by GetHash(), Reset(), SetHash(), and ToString().

◆ m_Length

TLength CBioseqInfoRecord::m_Length
private

Definition at line 294 of file record.hpp.

Referenced by GetLength(), Reset(), SetLength(), and ToString().

◆ m_Mol

TMol CBioseqInfoRecord::m_Mol
private

Definition at line 295 of file record.hpp.

Referenced by GetMol(), Reset(), SetMol(), and ToString().

◆ m_Name

TName CBioseqInfoRecord::m_Name
private

Definition at line 291 of file record.hpp.

Referenced by GetName(), SetName(), and ToString().

◆ m_Sat

TSat CBioseqInfoRecord::m_Sat
private

Definition at line 296 of file record.hpp.

Referenced by GetSat(), Reset(), SetSat(), and ToString().

◆ m_SatKey

TSatKey CBioseqInfoRecord::m_SatKey
private

Definition at line 297 of file record.hpp.

Referenced by GetSatKey(), Reset(), SetSatKey(), and ToString().

◆ m_SeqIds

TSeqIds CBioseqInfoRecord::m_SeqIds
private

Definition at line 298 of file record.hpp.

Referenced by GetSeqIds(), Reset(), and SetSeqIds().

◆ m_SeqIdType

TSeqIdType CBioseqInfoRecord::m_SeqIdType
private

Definition at line 288 of file record.hpp.

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

◆ m_SeqState

TSeqState CBioseqInfoRecord::m_SeqState
private

Definition at line 299 of file record.hpp.

Referenced by GetSeqState(), Reset(), SetSeqState(), and ToString().

◆ m_State

TState CBioseqInfoRecord::m_State
private

Definition at line 300 of file record.hpp.

Referenced by GetState(), Reset(), SetState(), and ToString().

◆ m_TaxId

TTaxId CBioseqInfoRecord::m_TaxId
private

Definition at line 301 of file record.hpp.

Referenced by GetTaxId(), Reset(), SetTaxId(), and ToString().

◆ m_Version

TVersion CBioseqInfoRecord::m_Version
private

Definition at line 287 of file record.hpp.

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

◆ m_Writetime

TWritetime CBioseqInfoRecord::m_Writetime
private

Definition at line 302 of file record.hpp.

Referenced by GetWritetime(), Reset(), and SetWritetime().

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.0
Modified on Fri Sep 20 14:57:06 2024 by modify_doxy.py rev. 669887