Search Toolkit Book for CSeqTestContext
CSeqTestContext defines any contextual information that a derived class might need. More...
#include <algo/seqqa/seqtest.hpp>
Inheritance diagram for CSeqTestContext:
Collaboration diagram for CSeqTestContext:
Public Member Functions | |
| CSeqTestContext (objects::CScope &scope) | |
| objects::CScope & | GetScope () const |
| Return the scope. More... | |
| bool | HasKey (const string &key) const |
| Is there an attribute by this name? More... | |
| string & | operator[] (const string &key) |
| read/write access to named attribute More... | |
| string | operator[] (const string &key) const |
| read-only access to named attribute for const instance 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... | |
| 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 |
Private Attributes | |
| CRef< objects::CScope > | m_Scope |
| map< string, string > | m_Values |
Additional Inherited Members | |
| 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... | |
| 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 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
CSeqTestContext defines any contextual information that a derived class might need.
It is empty and is provided for run-time binding.
Definition at line 51 of file seqtest.hpp.
Constructor & Destructor Documentation
◆ CSeqTestContext()
|
inline |
Definition at line 54 of file seqtest.hpp.
Member Function Documentation
◆ GetScope()
|
inline |
Return the scope.
Definition at line 58 of file seqtest.hpp.
◆ HasKey()
Is there an attribute by this name?
Definition at line 65 of file seqtest.hpp.
References map_checker< Container >::end(), map_checker< Container >::find(), ncbi::grid::netcache::search::fields::key, and m_Values.
◆ operator[]() [1/2]
read/write access to named attribute
Definition at line 69 of file seqtest.hpp.
References ncbi::grid::netcache::search::fields::key, and m_Values.
◆ operator[]() [2/2]
read-only access to named attribute for const instance
Definition at line 74 of file seqtest.hpp.
References map_checker< Container >::end(), map_checker< Container >::find(), ncbi::grid::netcache::search::fields::key, and m_Values.
Member Data Documentation
◆ m_Scope
|
private |
Definition at line 85 of file seqtest.hpp.
◆ m_Values
Definition at line 87 of file seqtest.hpp.
Referenced by HasKey(), and operator[]().
The documentation for this class was generated from the following file:
- include/algo/seqqa/seqtest.hpp
