NCBI C++ ToolKit
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
CBLASTDatabases Class Reference

Search Toolkit Book for CBLASTDatabases

#include <gui/objutils/blast_databases.hpp>

+ Inheritance diagram for CBLASTDatabases:
+ Collaboration diagram for CBLASTDatabases:

Public Types

enum  EState { eInitial , eLoaded , eLoading , eFailed }
 
typedef std::unordered_map< string, stringTDbMap
 
- 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 Types inherited from CEventHandler
enum  EDispatch { eDispatch_SelfOnly , eDispatch_AllHandlers , eDispatch_FirstHandler , eDispatch_Default = eDispatch_AllHandlers }
 enum controlling dispatching strategies More...
 
enum  EPoolName {
  ePool_Default = 0 , ePool_Parent , ePool_Child , ePool_Sibling ,
  ePool_NextAvailable
}
 Identifiers for standard pools. More...
 
typedef vector< CEventHandler * > TListeners
 
typedef map< int, TListenersTPools
 
typedef list< AutoPtr< SPostRequest > > TPostRequests
 
typedef std::map< CEventHandler *, intTHandlerToCount
 
typedef void(* FOnPostCallback) ()
 

Public Member Functions

EState GetState () const
 
bool Loaded () const
 
void Load (const char *path, const char *dbtree)
 
const TDbMapGetDbMap (bool nuc)
 
const vector< string > & GetDefaultMRU_DBs (bool nuc_db)
 
- Public Member Functions inherited from CObjectEx
 CObjectEx (void)
 
virtual ~CObjectEx (void)
 
- 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
 
- Public Member Functions inherited from CWeakObject
 CWeakObject (void)
 
virtual ~CWeakObject (void)
 
CPtrToObjectProxyGetPtrProxy (void) const
 Get pointer to proxy object containing pointer to this object. More...
 
- Public Member Functions inherited from CEventHandler
 CEventHandler ()
 CEventHandler. More...
 
virtual ~CEventHandler ()
 
virtual void AddListener (CEventHandler *listener, int pool_name=ePool_Default)
 Add a listener. More...
 
virtual void RemoveListener (CEventHandler *listener)
 Remove a listener. More...
 
virtual void RemoveAllListeners (void)
 
virtual bool HasListener (CEventHandler *listener, int pool_name=ePool_Default) const
 returns "true" if the given listener belongs to the specified pool More...
 
virtual const TListenersGetListeners (int pool_name=ePool_Default) const
 returns a set of listeners fro the specified pool More...
 
virtual bool OnEvent (CEvent *evt)
 Processes en event. Returns "true" if event has been processed. More...
 
virtual bool Dispatch (CEvent *evt, EDispatch disp_how=eDispatch_Default, int pool_name=ePool_Default)
 Dispatches an event to the listeners (but does not handle it). More...
 
virtual bool Send (CEvent *evt, EDispatch disp_how=eDispatch_Default, int pool_name=ePool_Default)
 Sends an event synchronously. More...
 
virtual bool Send (CEvent *evt, int pool_name)
 
void Post (CRef< CEvent > evt, EDispatch disp_how=eDispatch_Default, int pool_name=ePool_Default)
 Handles an event asynchronously (process and/or dispatch). More...
 

Static Public Member Functions

static CBLASTDatabasesGetInstance ()
 
- 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 Member Functions inherited from CEventHandler
static bool HandlePostRequest ()
 
static void ClearPostQueue ()
 erases all events from the queue More...
 
static void DestroyPostQueue ()
 

Private Member Functions

 CBLASTDatabases ()
 
void x_OnJobNotification (CEvent *evt)
 
void x_UpdateDbMap (bool nuc)
 
 DECLARE_EVENT_MAP ()
 

Private Attributes

TDbMap m_NucDbMap
 
TDbMap m_ProtDbMap
 
vector< stringm_Nuc_DefMRU_DBs
 
vector< stringm_Prot_DefMRU_DBs
 
int m_JobId
 
string m_Path
 
EState m_State
 

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...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 
- Protected Member Functions inherited from CWeakObject
void CleanWeakRefs (void) const
 Method cleaning all CWeakRefs referencing at this moment to the object After calling to this method all existing CWeakRefs referencing to the object will return NULL, so it effectively will be equal to deleting the object. More...
 
- Protected Member Functions inherited from CEventHandler
virtual const SEvtMapGetEventMap () const
 
void x_DeclareDead ()
 Removes itself unavailable for async event delivery. More...
 
void x_AddListenerToPool (CEventHandler *listener, int pool_name)
 
- Protected Attributes inherited from CEventHandler
TPools m_Pools
 
- Static Protected Attributes inherited from CEventHandler
static const SEvtMap sm_EvtMap
 

Detailed Description

Definition at line 45 of file blast_databases.hpp.

Member Typedef Documentation

◆ TDbMap

typedef std::unordered_map<string, string> CBLASTDatabases::TDbMap

Definition at line 48 of file blast_databases.hpp.

Member Enumeration Documentation

◆ EState

Enumerator
eInitial 
eLoaded 
eLoading 
eFailed 

Definition at line 50 of file blast_databases.hpp.

Constructor & Destructor Documentation

◆ CBLASTDatabases()

CBLASTDatabases::CBLASTDatabases ( )
private

Definition at line 61 of file blast_databases.cpp.

Referenced by GetInstance().

Member Function Documentation

◆ DECLARE_EVENT_MAP()

CBLASTDatabases::DECLARE_EVENT_MAP ( )
private

◆ GetDbMap()

const CBLASTDatabases::TDbMap & CBLASTDatabases::GetDbMap ( bool  nuc)

◆ GetDefaultMRU_DBs()

const vector< string > & CBLASTDatabases::GetDefaultMRU_DBs ( bool  nuc_db)

◆ GetInstance()

CBLASTDatabases & CBLASTDatabases::GetInstance ( void  )
static

◆ GetState()

EState CBLASTDatabases::GetState ( void  ) const
inline

Definition at line 60 of file blast_databases.hpp.

References m_State.

Referenced by CBLASTSearchOptionsPanel::x_CheckDBLoaded().

◆ Load()

void CBLASTDatabases::Load ( const char *  path,
const char *  dbtree 
)

◆ Loaded()

bool CBLASTDatabases::Loaded ( ) const
inline

◆ x_OnJobNotification()

void CBLASTDatabases::x_OnJobNotification ( CEvent evt)
private

◆ x_UpdateDbMap()

void CBLASTDatabases::x_UpdateDbMap ( bool  nuc)
private

Member Data Documentation

◆ m_JobId

int CBLASTDatabases::m_JobId
private

Definition at line 83 of file blast_databases.hpp.

Referenced by Load().

◆ m_Nuc_DefMRU_DBs

vector<string> CBLASTDatabases::m_Nuc_DefMRU_DBs
private

Definition at line 78 of file blast_databases.hpp.

Referenced by GetDefaultMRU_DBs(), and x_UpdateDbMap().

◆ m_NucDbMap

TDbMap CBLASTDatabases::m_NucDbMap
private

Definition at line 75 of file blast_databases.hpp.

Referenced by GetDbMap(), and x_UpdateDbMap().

◆ m_Path

string CBLASTDatabases::m_Path
private

Definition at line 84 of file blast_databases.hpp.

Referenced by Load(), and x_UpdateDbMap().

◆ m_Prot_DefMRU_DBs

vector<string> CBLASTDatabases::m_Prot_DefMRU_DBs
private

Definition at line 79 of file blast_databases.hpp.

Referenced by GetDefaultMRU_DBs(), and x_UpdateDbMap().

◆ m_ProtDbMap

TDbMap CBLASTDatabases::m_ProtDbMap
private

Definition at line 76 of file blast_databases.hpp.

Referenced by GetDbMap(), and x_UpdateDbMap().

◆ m_State

EState CBLASTDatabases::m_State
private

Definition at line 85 of file blast_databases.hpp.

Referenced by GetDbMap(), GetDefaultMRU_DBs(), GetState(), Load(), and Loaded().


The documentation for this class was generated from the following files:
Modified on Thu May 23 12:33:50 2024 by modify_doxy.py rev. 669887