NCBI C++ ToolKit
|
Search Toolkit Book for CEntrez2_eval_boolean_Base
**************************************** When evaluating a boolean query the counts of hits is always returned. More...
#include <objects/entrez2/Entrez2_eval_boolean_.hpp>
Public Types | |
enum class | E_memberIndex { e__allMandatory = 0 , e_return_UIDs , e_return_parse , e_query } |
typedef bool | TReturn_UIDs |
typedef bool | TReturn_parse |
typedef CEntrez2_boolean_exp | TQuery |
typedef Tparent::CMemberIndex< E_memberIndex, 4 > | 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 | |
CEntrez2_eval_boolean_Base (void) | |
virtual | ~CEntrez2_eval_boolean_Base (void) |
DECLARE_INTERNAL_TYPE_INFO () | |
bool | IsSetReturn_UIDs (void) const |
return UID list? Check if a value has been assigned to Return_UIDs data member. More... | |
bool | CanGetReturn_UIDs (void) const |
Check if it is safe to call GetReturn_UIDs method. More... | |
void | ResetReturn_UIDs (void) |
Reset Return_UIDs data member. More... | |
void | SetDefaultReturn_UIDs (void) |
Assign default value to Return_UIDs data member. More... | |
TReturn_UIDs | GetReturn_UIDs (void) const |
Get the Return_UIDs member data. More... | |
void | SetReturn_UIDs (TReturn_UIDs value) |
Assign a value to Return_UIDs data member. More... | |
TReturn_UIDs & | SetReturn_UIDs (void) |
Assign a value to Return_UIDs data member. More... | |
bool | IsSetReturn_parse (void) const |
return parsed query? Check if a value has been assigned to Return_parse data member. More... | |
bool | CanGetReturn_parse (void) const |
Check if it is safe to call GetReturn_parse method. More... | |
void | ResetReturn_parse (void) |
Reset Return_parse data member. More... | |
void | SetDefaultReturn_parse (void) |
Assign default value to Return_parse data member. More... | |
TReturn_parse | GetReturn_parse (void) const |
Get the Return_parse member data. More... | |
void | SetReturn_parse (TReturn_parse value) |
Assign a value to Return_parse data member. More... | |
TReturn_parse & | SetReturn_parse (void) |
Assign a value to Return_parse data member. More... | |
bool | IsSetQuery (void) const |
the actual query Check if a value has been assigned to Query data member. More... | |
bool | CanGetQuery (void) const |
Check if it is safe to call GetQuery method. More... | |
void | ResetQuery (void) |
Reset Query data member. More... | |
const TQuery & | GetQuery (void) const |
Get the Query member data. More... | |
void | SetQuery (TQuery &value) |
Assign a value to Query data member. More... | |
TQuery & | SetQuery (void) |
Assign a value to Query 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 CSerialObject | Tparent |
Private Member Functions | |
CEntrez2_eval_boolean_Base (const CEntrez2_eval_boolean_Base &) | |
CEntrez2_eval_boolean_Base & | operator= (const CEntrez2_eval_boolean_Base &) |
Private Attributes | |
Uint4 | m_set_State [1] |
bool | m_Return_UIDs |
bool | m_Return_parse |
CRef< TQuery > | m_Query |
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... | |
**************************************** When evaluating a boolean query the counts of hits is always returned.
In addition, you can request the UIDs of the hits or the the parsed query in structured form (with counts by term), or both. **************************************** evaluate Boolean query
Definition at line 80 of file Entrez2_eval_boolean_.hpp.