NCBI C++ ToolKit
|
Search Toolkit Book for CEntrez2_id_list
#include <objects/entrez2/Entrez2_id_list.hpp>
Public Types | |
typedef TIntId | TUid |
typedef CConstResizingIterator< TUids, TUid > | TConstUidIterator |
typedef CResizingIterator< TUids, TUid > | TUidIterator |
![]() | |
enum class | E_memberIndex { e__allMandatory = 0 , e_db , e_num , e_uids } |
typedef CEntrez2_db_id | TDb |
typedef int | TNum |
typedef vector< char > | TUids |
typedef Tparent::CMemberIndex< E_memberIndex, 4 > | TmemberIndex |
![]() | |
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 | |
CEntrez2_id_list (void) | |
~CEntrez2_id_list (void) | |
TUidIterator | GetUidIterator () |
TConstUidIterator | GetConstUidIterator () const |
void | Resize (size_t size) |
void | AssignUids (const vector< TUid > &uids) |
size_t | GetUidSizeBits (void) const |
size_t | GetUidSizeBytes (void) const |
void | PackUids (void) |
![]() | |
CEntrez2_id_list_Base (void) | |
virtual | ~CEntrez2_id_list_Base (void) |
DECLARE_INTERNAL_TYPE_INFO () | |
bool | IsSetDb (void) const |
the database Check if a value has been assigned to Db data member. More... | |
bool | CanGetDb (void) const |
Check if it is safe to call GetDb method. More... | |
void | ResetDb (void) |
Reset Db data member. More... | |
const TDb & | GetDb (void) const |
Get the Db member data. More... | |
void | SetDb (const TDb &value) |
Assign a value to Db data member. More... | |
TDb & | SetDb (void) |
Assign a value to Db data member. More... | |
bool | IsSetNum (void) const |
number of uids Check if a value has been assigned to Num data member. More... | |
bool | CanGetNum (void) const |
Check if it is safe to call GetNum method. More... | |
void | ResetNum (void) |
Reset Num data member. More... | |
TNum | GetNum (void) const |
Get the Num member data. More... | |
void | SetNum (TNum value) |
Assign a value to Num data member. More... | |
TNum & | SetNum (void) |
Assign a value to Num data member. More... | |
bool | IsSetUids (void) const |
coded uids Check if a value has been assigned to Uids data member. More... | |
bool | CanGetUids (void) const |
Check if it is safe to call GetUids method. More... | |
void | ResetUids (void) |
Reset Uids data member. More... | |
const TUids & | GetUids (void) const |
Get the Uids member data. More... | |
TUids & | SetUids (void) |
Assign a value to Uids data member. More... | |
virtual void | Reset (void) |
Reset the whole object. More... | |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
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 Attributes | |
static const size_t | sm_UidSize = sizeof(CEntrez2_id_list::TUid) |
![]() | |
static const char * | ms_UnassignedStr = "<*unassigned*>" |
static const char | ms_UnassignedByte = char(0xcd) |
![]() | |
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... | |
Private Types | |
typedef CEntrez2_id_list_Base | Tparent |
Private Member Functions | |
void | x_SetNativeUidSize (void) |
CEntrez2_id_list (const CEntrez2_id_list &value) | |
CEntrez2_id_list & | operator= (const CEntrez2_id_list &value) |
Additional Inherited Members | |
![]() | |
static void | SetVerifyDataThread (ESerialVerifyData verify) |
static void | SetVerifyDataGlobal (ESerialVerifyData verify) |
static string | UnassignedString (void) |
static CStringUTF8 | UnassignedStringUTF8 (void) |
static char | UnassignedByte (void) |
![]() | |
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 void | EnableDebugDump (bool on) |
![]() | |
virtual void | DeleteThis (void) |
Virtual method "deleting" this object. More... | |
Definition at line 52 of file Entrez2_id_list.hpp.
Definition at line 57 of file Entrez2_id_list.hpp.
|
private |
Definition at line 54 of file Entrez2_id_list.hpp.
typedef TIntId CEntrez2_id_list::TUid |
Definition at line 56 of file Entrez2_id_list.hpp.
Definition at line 58 of file Entrez2_id_list.hpp.
|
inline |
Definition at line 99 of file Entrez2_id_list.hpp.
CEntrez2_id_list::~CEntrez2_id_list | ( | void | ) |
Definition at line 74 of file Entrez2_id_list.cpp.
|
private |
Definition at line 87 of file Entrez2_id_list.cpp.
References GetUidIterator(), ITERATE, and Resize().
Referenced by CEntrez2Client::GetDocsums(), CEntrez2Client::GetNeighbors(), and x_SetNativeUidSize().
CEntrez2_id_list::TConstUidIterator CEntrez2_id_list::GetConstUidIterator | ( | ) | const |
Definition at line 63 of file Entrez2_id_list.cpp.
References CEntrez2_id_list_Base::CanGetUids(), CEntrez2_id_list_Base::GetUids(), GetUidSizeBits(), and s_EmptyList.
Referenced by CTaxTreeTestDlg::OnSubmitClick(), PackUids(), CEntrez2ClientApp::x_FormatReply(), and x_SetNativeUidSize().
CEntrez2_id_list::TUidIterator CEntrez2_id_list::GetUidIterator | ( | ) |
Definition at line 55 of file Entrez2_id_list.cpp.
References GetUidSizeBits(), CEntrez2_id_list_Base::SetUids(), and x_SetNativeUidSize().
Referenced by AssignUids(), and CId1FetchApp::LookUpGI().
size_t CEntrez2_id_list::GetUidSizeBits | ( | void | ) | const |
Definition at line 98 of file Entrez2_id_list.cpp.
References GetUidSizeBytes().
Referenced by GetConstUidIterator(), and GetUidIterator().
size_t CEntrez2_id_list::GetUidSizeBytes | ( | void | ) | const |
Definition at line 104 of file Entrez2_id_list.cpp.
References CEntrez2_id_list_Base::CanGetNum(), CEntrez2_id_list_Base::CanGetUids(), CEntrez2_id_list_Base::GetNum(), and CEntrez2_id_list_Base::GetUids().
Referenced by GetUidSizeBits(), and x_SetNativeUidSize().
|
private |
void CEntrez2_id_list::PackUids | ( | void | ) |
Definition at line 115 of file Entrez2_id_list.cpp.
References CConstResizingIterator< TSeq, TOut >::AtEnd(), CEntrez2_id_list_Base::CanGetNum(), CEntrez2_id_list_Base::CanGetUids(), GetConstUidIterator(), CEntrez2_id_list_Base::GetNum(), ITERATE, kMax_UI4, and CEntrez2_id_list_Base::SetUids().
Referenced by CId1FetchApp::LookUpGI().
void CEntrez2_id_list::Resize | ( | size_t | size | ) |
Definition at line 79 of file Entrez2_id_list.cpp.
References CEntrez2_id_list_Base::SetNum(), CEntrez2_id_list_Base::SetUids(), ncbi::grid::netcache::search::fields::size, and x_SetNativeUidSize().
Referenced by AssignUids(), and CId1FetchApp::LookUpGI().
|
private |
Definition at line 133 of file Entrez2_id_list.cpp.
References AssignUids(), CConstResizingIterator< TSeq, TOut >::AtEnd(), GetConstUidIterator(), CEntrez2_id_list_Base::GetNum(), and GetUidSizeBytes().
Referenced by GetUidIterator(), and Resize().
|
static |
Definition at line 77 of file Entrez2_id_list.hpp.