NCBI C++ ToolKit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
CProcessor Class Referenceabstract

Search Toolkit Book for CProcessor

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

+ Inheritance diagram for CProcessor:
+ Collaboration diagram for CProcessor:

Public Types

enum  EType {
  eType_ID1 , eType_ID1_SNP , eType_Seq_entry , eType_Seq_entry_SNP ,
  eType_St_Seq_entry , eType_St_Seq_entry_SNPT , eType_ID2 , eType_ID2AndSkel ,
  eType_ID2_SE , eType_ID2_Split , eType_ID2_Chunk , eType_ID2_SNP ,
  eType_ExtAnnot , eType_AnnotInfo
}
 
typedef CBlob_id TBlobId
 
typedef int TBlobState
 
typedef int TBlobVersion
 
typedef int TChunkId
 
typedef unsigned TMagic
 
- Public Types inherited from CObject
enum  EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
 Control filling of newly allocated memory. More...
 
typedef CObjectCounterLocker TLockerType
 Default locker type for CRef. More...
 
typedef atomic< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 

Public Member Functions

virtual ~CProcessor (void)
 
virtual EType GetType (void) const =0
 
virtual TMagic GetMagic (void) const =0
 
virtual void ProcessStream (CReaderRequestResult &result, const TBlobId &blob_id, TChunkId chunk_id, CNcbiIstream &stream) const
 
virtual void ProcessObjStream (CReaderRequestResult &result, const TBlobId &blob_id, TChunkId chunk_id, CObjectIStream &obj_stream) const
 
void ProcessBlobFromID2Data (CReaderRequestResult &result, const TBlobId &blob_id, TChunkId chunk_id, const CID2_Reply_Data &data) const
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (const CObject &src) THROWS_NONE
 Assignment operator. More...
 
bool CanBeDeleted (void) const THROWS_NONE
 Check if object can be deleted. More...
 
bool IsAllocatedInPool (void) const THROWS_NONE
 Check if object is allocated in memory pool (not system heap) More...
 
bool Referenced (void) const THROWS_NONE
 Check if object is referenced. More...
 
bool ReferencedOnlyOnce (void) const THROWS_NONE
 Check if object is referenced only once. More...
 
void AddReference (void) const
 Add reference to object. More...
 
void RemoveReference (void) const
 Remove reference to object. More...
 
void ReleaseReference (void) const
 Remove reference without deleting object. More...
 
virtual void DoNotDeleteThisObject (void)
 Mark this object as not allocated in heap – do not delete this object. More...
 
virtual void DoDeleteThisObject (void)
 Mark this object as allocated in heap – object can be deleted. More...
 
void * operator new (size_t size)
 Define new operator for memory allocation. More...
 
void * operator new[] (size_t size)
 Define new[] operator for 'array' memory allocation. More...
 
void operator delete (void *ptr)
 Define delete operator for memory deallocation. More...
 
void operator delete[] (void *ptr)
 Define delete[] operator for memory deallocation. More...
 
void * operator new (size_t size, void *place)
 Define new operator. More...
 
void operator delete (void *ptr, void *place)
 Define delete operator. More...
 
void * operator new (size_t size, CObjectMemoryPool *place)
 Define new operator using memory pool. More...
 
void operator delete (void *ptr, CObjectMemoryPool *place)
 Define delete operator. More...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. More...
 
- Public Member Functions inherited from CDebugDumpable
 CDebugDumpable (void)
 
virtual ~CDebugDumpable (void)
 
void DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const
 
void DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const
 
void DumpToConsole (void) const
 

Static Public Member Functions

static void RegisterAllProcessors (CReadDispatcher &dispatcher)
 
static bool TryStringPack (void)
 
static bool TrySNPSplit (void)
 
static bool TrySNPTable (void)
 
static void SetSeqEntryReadHooks (CObjectIStream &in)
 
static void SetSNPReadHooks (CObjectIStream &in)
 
static void SetLoaded (CReaderRequestResult &result, const TBlobId &blob_id, TChunkId chunk_id, CLoadLockBlob &blob)
 
static TIntId GetGiOffset (void)
 
static void OffsetGi (TGi &gi, TIntId gi_offset)
 
static void OffsetGi (TIntId &gi, TIntId gi_offset)
 
static bool OffsetId (CSeq_id &id, TIntId gi_offset)
 
static bool OffsetId (CSeq_id_Handle &id, TIntId gi_offset)
 
static void OffsetAllGis (CBeginInfo obj, TIntId gi_offset)
 
static void OffsetAllGis (CTSE_SetObjectInfo &set_info, TIntId gi_offset)
 
static TGi ConvertGiFromOM (TGi gi)
 
static TGi ConvertGiToOM (TGi gi)
 
static CSeq_id_Handle ConvertIdFromOM (CSeq_id_Handle id)
 
static void OffsetGiToOM (TGi &gi)
 
static void OffsetIdToOM (CSeq_id &id)
 
static void OffsetAllGisFromOM (CBeginInfo obj)
 
static void OffsetAllGisToOM (CBeginInfo obj, CTSE_SetObjectInfo *set_info=0)
 
- Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (const type_info &type)
 
static EAllocFillMode GetAllocFillMode (void)
 
static void SetAllocFillMode (EAllocFillMode mode)
 
static void SetAllocFillMode (const string &value)
 Set mode from configuration parameter value. More...
 
- Static Public Member Functions inherited from CDebugDumpable
static void EnableDebugDump (bool on)
 

Protected Member Functions

 CProcessor (CReadDispatcher &dispatcher)
 
CWriterGetWriter (const CReaderRequestResult &result) const
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Static Protected Member Functions

static int CollectStatistics (void)
 
static void LogStat (CReaderRequestResultRecursion &recursion, const CBlob_id &blob_id, CGBRequestStatistics::EStatType stat_type, const char *descr, double size)
 
static void LogStat (CReaderRequestResultRecursion &recursion, const CBlob_id &blob_id, int chunk_id, CGBRequestStatistics::EStatType stat_type, const char *descr, double size)
 
static void LogStat (CReaderRequestResultRecursion &recursion, const CBlob_id &blob_id, CGBRequestStatistics::EStatType stat_type, const char *descr, CNcbiStreampos size)
 
static void LogStat (CReaderRequestResultRecursion &recursion, const CBlob_id &blob_id, int chunk_id, CGBRequestStatistics::EStatType stat_type, const char *descr, CNcbiStreampos size)
 
static void LogStat (CReaderRequestResultRecursion &recursion, const CBlob_id &blob_id, CGBRequestStatistics::EStatType stat_type, const char *descr, size_t size)
 
static void LogStat (CReaderRequestResultRecursion &recursion, const CBlob_id &blob_id, int chunk_id, CGBRequestStatistics::EStatType stat_type, const char *descr, size_t size)
 

Protected Attributes

CReadDispatcherm_Dispatcher
 

Additional Inherited Members

- Static Public Attributes inherited from CObject
static const TCount eCounterBitsCanBeDeleted = 1 << 0
 Define possible object states. More...
 
static const TCount eCounterBitsInPlainHeap = 1 << 1
 Heap signature was found. More...
 
static const TCount eCounterBitsPlaceMask
 Mask for 'in heap' state flags. More...
 
static const int eCounterStep = 1 << 2
 Skip over the "in heap" bits. More...
 
static const TCount eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
 Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...
 
static const TCount eCounterStateMask
 Valid object, and object in heap. More...
 

Detailed Description

Definition at line 61 of file processor.hpp.

Member Typedef Documentation

◆ TBlobId

Definition at line 64 of file processor.hpp.

◆ TBlobState

Definition at line 65 of file processor.hpp.

◆ TBlobVersion

Definition at line 66 of file processor.hpp.

◆ TChunkId

Definition at line 67 of file processor.hpp.

◆ TMagic

typedef unsigned CProcessor::TMagic

Definition at line 84 of file processor.hpp.

Member Enumeration Documentation

◆ EType

enum CProcessor::EType ( void  )
Enumerator
eType_ID1 
eType_ID1_SNP 
eType_Seq_entry 
eType_Seq_entry_SNP 
eType_St_Seq_entry 
eType_St_Seq_entry_SNPT 
eType_ID2 
eType_ID2AndSkel 
eType_ID2_SE 
eType_ID2_Split 
eType_ID2_Chunk 
eType_ID2_SNP 
eType_ExtAnnot 
eType_AnnotInfo 

Definition at line 68 of file processor.hpp.

Constructor & Destructor Documentation

◆ ~CProcessor()

CProcessor::~CProcessor ( void  )
virtual

Definition at line 232 of file processors.cpp.

◆ CProcessor()

CProcessor::CProcessor ( CReadDispatcher dispatcher)
protected

Definition at line 226 of file processors.cpp.

Member Function Documentation

◆ CollectStatistics()

int CProcessor::CollectStatistics ( void  )
inlinestaticprotected

Definition at line 219 of file processors.cpp.

References NCBI_PARAM_TYPE, and ncbi::grid::netcache::search::s_Value().

◆ ConvertGiFromOM()

static TGi CProcessor::ConvertGiFromOM ( TGi  gi)
inlinestatic

◆ ConvertGiToOM()

static TGi CProcessor::ConvertGiToOM ( TGi  gi)
inlinestatic

Definition at line 144 of file processor.hpp.

References GetGiOffset(), and OffsetGi().

Referenced by CProcessor_ExtAnnot::Process().

◆ ConvertIdFromOM()

static CSeq_id_Handle CProcessor::ConvertIdFromOM ( CSeq_id_Handle  id)
inlinestatic

Definition at line 149 of file processor.hpp.

References GetGiOffset(), and OffsetId().

Referenced by CPubseqReader::LoadSeq_idInfo().

◆ GetGiOffset()

TIntId CProcessor::GetGiOffset ( void  )
static

◆ GetMagic()

virtual TMagic CProcessor::GetMagic ( void  ) const
pure virtual

◆ GetType()

virtual EType CProcessor::GetType ( void  ) const
pure virtual

◆ GetWriter()

CWriter * CProcessor::GetWriter ( const CReaderRequestResult result) const
inlineprotected

◆ LogStat() [1/6]

static void CProcessor::LogStat ( CReaderRequestResultRecursion recursion,
const CBlob_id blob_id,
CGBRequestStatistics::EStatType  stat_type,
const char *  descr,
CNcbiStreampos  size 
)
inlinestaticprotected

Definition at line 184 of file processor.hpp.

References LogStat(), and ncbi::grid::netcache::search::fields::size.

◆ LogStat() [2/6]

void CProcessor::LogStat ( CReaderRequestResultRecursion recursion,
const CBlob_id blob_id,
CGBRequestStatistics::EStatType  stat_type,
const char *  descr,
double  size 
)
staticprotected

◆ LogStat() [3/6]

static void CProcessor::LogStat ( CReaderRequestResultRecursion recursion,
const CBlob_id blob_id,
CGBRequestStatistics::EStatType  stat_type,
const char *  descr,
size_t  size 
)
inlinestaticprotected

Definition at line 201 of file processor.hpp.

References LogStat(), and ncbi::grid::netcache::search::fields::size.

◆ LogStat() [4/6]

static void CProcessor::LogStat ( CReaderRequestResultRecursion recursion,
const CBlob_id blob_id,
int  chunk_id,
CGBRequestStatistics::EStatType  stat_type,
const char *  descr,
CNcbiStreampos  size 
)
inlinestaticprotected

Definition at line 192 of file processor.hpp.

References LogStat(), and ncbi::grid::netcache::search::fields::size.

◆ LogStat() [5/6]

void CProcessor::LogStat ( CReaderRequestResultRecursion recursion,
const CBlob_id blob_id,
int  chunk_id,
CGBRequestStatistics::EStatType  stat_type,
const char *  descr,
double  size 
)
staticprotected

◆ LogStat() [6/6]

static void CProcessor::LogStat ( CReaderRequestResultRecursion recursion,
const CBlob_id blob_id,
int  chunk_id,
CGBRequestStatistics::EStatType  stat_type,
const char *  descr,
size_t  size 
)
inlinestaticprotected

Definition at line 209 of file processor.hpp.

References LogStat(), and ncbi::grid::netcache::search::fields::size.

◆ OffsetAllGis() [1/2]

void CProcessor::OffsetAllGis ( CBeginInfo  obj,
TIntId  gi_offset 
)
static

◆ OffsetAllGis() [2/2]

void CProcessor::OffsetAllGis ( CTSE_SetObjectInfo set_info,
TIntId  gi_offset 
)
static

Definition at line 572 of file processors.cpp.

References CTSE_SetObjectInfo::m_Seq_annot_InfoMap, and NON_CONST_ITERATE.

◆ OffsetAllGisFromOM()

void CProcessor::OffsetAllGisFromOM ( CBeginInfo  obj)
static

◆ OffsetAllGisToOM()

void CProcessor::OffsetAllGisToOM ( CBeginInfo  obj,
CTSE_SetObjectInfo set_info = 0 
)
static

◆ OffsetGi() [1/2]

static void CProcessor::OffsetGi ( TGi gi,
TIntId  gi_offset 
)
inlinestatic

Definition at line 120 of file processor.hpp.

References GI_FROM, and ZERO_GI.

Referenced by ConvertGiFromOM(), ConvertGiToOM(), OffsetAllGis(), and OffsetGiToOM().

◆ OffsetGi() [2/2]

static void CProcessor::OffsetGi ( TIntId gi,
TIntId  gi_offset 
)
inlinestatic

Definition at line 127 of file processor.hpp.

◆ OffsetGiToOM()

static void CProcessor::OffsetGiToOM ( TGi gi)
inlinestatic

Definition at line 154 of file processor.hpp.

References GetGiOffset(), and OffsetGi().

Referenced by CPubseqReader::LoadSeq_idInfo().

◆ OffsetId() [1/2]

bool CProcessor::OffsetId ( CSeq_id id,
TIntId  gi_offset 
)
static

◆ OffsetId() [2/2]

bool CProcessor::OffsetId ( CSeq_id_Handle id,
TIntId  gi_offset 
)
static

◆ OffsetIdToOM()

static void CProcessor::OffsetIdToOM ( CSeq_id id)
inlinestatic

Definition at line 158 of file processor.hpp.

References GetGiOffset(), and OffsetId().

Referenced by CPubseqReader::LoadGiSeq_ids().

◆ ProcessBlobFromID2Data()

void CProcessor::ProcessBlobFromID2Data ( CReaderRequestResult result,
const TBlobId blob_id,
TChunkId  chunk_id,
const CID2_Reply_Data data 
) const

◆ ProcessObjStream()

void CProcessor::ProcessObjStream ( CReaderRequestResult result,
const TBlobId blob_id,
TChunkId  chunk_id,
CObjectIStream obj_stream 
) const
virtual

◆ ProcessStream()

void CProcessor::ProcessStream ( CReaderRequestResult result,
const TBlobId blob_id,
TChunkId  chunk_id,
CNcbiIstream stream 
) const
virtual

◆ RegisterAllProcessors()

void CProcessor::RegisterAllProcessors ( CReadDispatcher dispatcher)
static

Definition at line 299 of file processors.cpp.

References CReadDispatcher::InsertProcessor().

Referenced by CReadDispatcher::CReadDispatcher().

◆ SetLoaded()

static void CProcessor::SetLoaded ( CReaderRequestResult result,
const TBlobId blob_id,
TChunkId  chunk_id,
CLoadLockBlob blob 
)
static

◆ SetSeqEntryReadHooks()

void CProcessor::SetSeqEntryReadHooks ( CObjectIStream in)
static

◆ SetSNPReadHooks()

void CProcessor::SetSNPReadHooks ( CObjectIStream in)
static

Definition at line 380 of file processors.cpp.

References in(), TryStringPack(), and type.

Referenced by CSeq_annot_SNP_Info_Reader::Parse(), and CSeq_annot_SNP_Info_Reader::Read().

◆ TrySNPSplit()

bool CProcessor::TrySNPSplit ( void  )
static

◆ TrySNPTable()

bool CProcessor::TrySNPTable ( void  )
static

◆ TryStringPack()

bool CProcessor::TryStringPack ( void  )
static

Definition at line 314 of file processors.cpp.

References NCBI_PARAM_TYPE, and CPackString::TryStringPack().

Referenced by SetSeqEntryReadHooks(), and SetSNPReadHooks().

Member Data Documentation

◆ m_Dispatcher

CReadDispatcher* CProcessor::m_Dispatcher
protected

The documentation for this class was generated from the following files:
Modified on Fri Dec 01 04:44:33 2023 by modify_doxy.py rev. 669887