Search Toolkit Book for CCache_blob
#include <objtools/data_loaders/asn_cache/Cache_blob.hpp>
Inheritance diagram for CCache_blob:
Collaboration diagram for CCache_blob:
Public Types | |
| enum | { kVersion = 1 , kMagicNum = 0x05D705DD , kMD5Size = 16 } |
| Public Types inherited from CCache_blob_Base | |
| enum class | E_memberIndex { e__allMandatory = 0 , e_magic , e_timestamp , e_blob , e_md5_digest } |
| typedef int | TMagic |
| typedef int | TTimestamp |
| typedef vector< char > | TBlob |
| typedef vector< char > | TMd5_digest |
| typedef Tparent::CMemberIndex< E_memberIndex, 5 > | TmemberIndex |
| 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< Uint8 > | TCounter |
| Counter type is CAtomiCounter. More... | |
| typedef Uint8 | TCount |
| Alias for value type of counter. More... | |
Public Member Functions | |
| CCache_blob (void) | |
| ~CCache_blob (void) | |
| void | Pack (const CSeq_entry &entry) |
| void | UnPack (CSeq_entry &entry) const |
| void | UnPack (vector< unsigned char > &raw_bytes) const |
| Public Member Functions inherited from CCache_blob_Base | |
| CCache_blob_Base (void) | |
| virtual | ~CCache_blob_Base (void) |
| DECLARE_INTERNAL_TYPE_INFO () | |
| bool | IsSetMagic (void) const |
| Check if a value has been assigned to Magic data member. More... | |
| bool | CanGetMagic (void) const |
| Check if it is safe to call GetMagic method. More... | |
| void | ResetMagic (void) |
| Reset Magic data member. More... | |
| TMagic | GetMagic (void) const |
| Get the Magic member data. More... | |
| void | SetMagic (TMagic value) |
| Assign a value to Magic data member. More... | |
| TMagic & | SetMagic (void) |
| Assign a value to Magic data member. More... | |
| bool | IsSetTimestamp (void) const |
| Check if a value has been assigned to Timestamp data member. More... | |
| bool | CanGetTimestamp (void) const |
| Check if it is safe to call GetTimestamp method. More... | |
| void | ResetTimestamp (void) |
| Reset Timestamp data member. More... | |
| TTimestamp | GetTimestamp (void) const |
| Get the Timestamp member data. More... | |
| void | SetTimestamp (TTimestamp value) |
| Assign a value to Timestamp data member. More... | |
| TTimestamp & | SetTimestamp (void) |
| Assign a value to Timestamp data member. More... | |
| bool | IsSetBlob (void) const |
| Check if a value has been assigned to Blob data member. More... | |
| bool | CanGetBlob (void) const |
| Check if it is safe to call GetBlob method. More... | |
| void | ResetBlob (void) |
| Reset Blob data member. More... | |
| const TBlob & | GetBlob (void) const |
| Get the Blob member data. More... | |
| TBlob & | SetBlob (void) |
| Assign a value to Blob data member. More... | |
| bool | IsSetMd5_digest (void) const |
| Check if a value has been assigned to Md5_digest data member. More... | |
| bool | CanGetMd5_digest (void) const |
| Check if it is safe to call GetMd5_digest method. More... | |
| void | ResetMd5_digest (void) |
| Reset Md5_digest data member. More... | |
| const TMd5_digest & | GetMd5_digest (void) const |
| Get the Md5_digest member data. More... | |
| TMd5_digest & | SetMd5_digest (void) |
| Assign a value to Md5_digest data member. More... | |
| virtual void | Reset (void) |
| Reset the whole object. More... | |
| Public Member Functions inherited from CSerialObject | |
| CSerialObject (void) | |
| virtual | ~CSerialObject (void) |
| virtual const CTypeInfo * | GetThisTypeInfo (void) const =0 |
| virtual void | Assign (const CSerialObject &source, ESerialRecursionMode how=eRecursive) |
| Set object to copy of another one. More... | |
| virtual bool | Equals (const CSerialObject &object, ESerialRecursionMode how=eRecursive) const |
| Check if both objects contain the same values. More... | |
| virtual void | DebugDump (CDebugDumpContext ddc, unsigned int depth) const |
| Define method for dumping debug information. More... | |
| void | ThrowUnassigned (TMemberIndex index) const |
| void | ThrowUnassigned (TMemberIndex index, const char *file_name, int file_line) const |
| bool | HasNamespaceName (void) const |
| Check if object data type has namespace name. More... | |
| const string & | GetNamespaceName (void) const |
| Get namespace name. More... | |
| bool | HasNamespacePrefix (void) const |
| Check if data type has namespace prefix. More... | |
| const string & | GetNamespacePrefix (void) const |
| Get namespace prefix. More... | |
| Public Member Functions inherited from CObject | |
| CObject (void) | |
| Constructor. More... | |
| CObject (const CObject &src) | |
| Copy constructor. More... | |
| virtual | ~CObject (void) |
| Destructor. More... | |
| CObject & | operator= (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... | |
| 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 |
Private Types | |
| typedef CCache_blob_Base | Tparent |
Private Member Functions | |
| CCache_blob (const CCache_blob &value) | |
| CCache_blob & | operator= (const CCache_blob &value) |
Additional Inherited Members | |
| Static Public Member Functions inherited from CSerialObject | |
| static void | SetVerifyDataThread (ESerialVerifyData verify) |
| static void | SetVerifyDataGlobal (ESerialVerifyData verify) |
| static string | UnassignedString (void) |
| static CStringUTF8 | UnassignedStringUTF8 (void) |
| static char | UnassignedByte (void) |
| 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) |
| Static Public Attributes inherited from CSerialObject | |
| static const char * | ms_UnassignedStr = "<*unassigned*>" |
| static const char | ms_UnassignedByte = char(0xcd) |
| 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... | |
| Protected Member Functions inherited from CObject | |
| virtual void | DeleteThis (void) |
| Virtual method "deleting" this object. More... | |
Detailed Description
Definition at line 55 of file Cache_blob.hpp.
Member Typedef Documentation
◆ Tparent
|
private |
Definition at line 57 of file Cache_blob.hpp.
Member Enumeration Documentation
◆ anonymous enum
| anonymous enum |
| Enumerator | |
|---|---|
| kVersion | |
| kMagicNum | |
| kMD5Size | |
Definition at line 60 of file Cache_blob.hpp.
Constructor & Destructor Documentation
◆ CCache_blob() [1/2]
| CCache_blob::CCache_blob | ( | void | ) |
Definition at line 64 of file Cache_blob.cpp.
◆ ~CCache_blob()
| CCache_blob::~CCache_blob | ( | void | ) |
Definition at line 70 of file Cache_blob.cpp.
◆ CCache_blob() [2/2]
|
private |
Member Function Documentation
◆ operator=()
|
private |
◆ Pack()
| void CCache_blob::Pack | ( | const CSeq_entry & | entry | ) |
Definition at line 75 of file Cache_blob.cpp.
References CMD5StreamWriter< Buffer >::Flush(), CObjectOStream::Flush(), CMD5StreamWriter< Buffer >::GetMD5Sum(), kMagicNum, CCache_blob_Base::SetBlob(), CCache_blob_Base::SetMagic(), and CCache_blob_Base::SetMd5_digest().
Referenced by CPrimeCacheApplication::CCacheBioseq::operator()(), SBlobInserter::operator()(), SBlobCopier::operator()(), CPrimeCacheApplication::x_CacheSeqEntry(), CPrimeCacheApplication::x_Process_Fasta(), and CPrimeCacheApplication::x_Process_Ids().
◆ UnPack() [1/2]
| void CCache_blob::UnPack | ( | CSeq_entry & | entry | ) | const |
Definition at line 98 of file Cache_blob.cpp.
References CCache_blob_Base::GetBlob().
Referenced by CAsnCacheStore::GetEntry(), CAsnCacheStore::GetRaw(), and SBlobCopier::operator()().
◆ UnPack() [2/2]
| void CCache_blob::UnPack | ( | vector< unsigned char > & | raw_bytes | ) | const |
Definition at line 111 of file Cache_blob.cpp.
References buf, CCache_blob_Base::GetBlob(), and ncbi::grid::netcache::search::fields::size.
The documentation for this class was generated from the following files:
- include/objtools/data_loaders/asn_cache/Cache_blob.hpp
- src/objtools/data_loaders/asn_cache/Cache_blob.cpp
