NCBI C++ ToolKit
Public Member Functions | Protected Member Functions | List of all members
CSNPSearchTool Class Reference

Search Toolkit Book for CSNPSearchTool

CSNPSearchTool. More...

#include <gui/packages/pkg_sequence/snp_search_tool.hpp>

+ Inheritance diagram for CSNPSearchTool:
+ Collaboration diagram for CSNPSearchTool:

Public Member Functions

 CSNPSearchTool ()
 IDMSearchTool. More...
 
IUITool implementation
virtual IUIToolClone () const
 
virtual string GetName () const
 returns unique name of the method that is used in UI to identify it More...
 
virtual string GetDescription () const
 returns a detailed description of the method that is used in UI More...
 
IDMSearchTool implementation
virtual CIRef< IDMSearchFormCreateSearchForm ()
 factory method for creating a form representing the tool More...
 
virtual bool IsCompatible (IDataMiningContext *context)
 retuns true if the tool is compatible with the provided Search Context More...
 
IExtension implementation
virtual string GetExtensionIdentifier () const
 returns the unique human-readable identifier for the extension the id should use lowercase letters separated by underscores - "like_this" More...
 
virtual string GetExtensionLabel () const
 returns a displayable label for this extension ( please capitalize the key words - "My Extension" ) More...
 
- Public Member Functions inherited from CSearchToolBase
 CSearchToolBase ()
 
virtual ~CSearchToolBase ()
 
void OnAJNotification (CEvent *evt)
 CAppJobDispatcher notification handler. More...
 
void OnProgress (CEvent *evt)
 
virtual IDMSearchTool::TUIToolFlags GetFlags (void)
 special flags More...
 
virtual IDMSearchTool::TConversionsGetConversions (void)
 list of acceptable feat types top convert and default type More...
 
virtual const IDMSearchTool::TFiltersGetFilters (void) const
 list of all tool-provided filters More...
 
virtual IDMSearchTool::TFiltersSetFilters ()
 
virtual bool StartSearch (IDMSearchQuery &query, IDMSearchFormController &listener)
 Starts search Job, the job is identified by the query object. More...
 
virtual bool CancelSearch (IDMSearchFormController &listener)
 
virtual bool PullSearch (IDMSearchQuery &query, IDMSearchFormController &listener)
 Pulls cached result from cache if possible (true) More...
 
virtual string GetJobDescr (IDMSearchFormController &form)
 
- 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 IExtension
virtual ~IExtension ()
 
- 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...
 
- Public Member Functions inherited from IDMSearchTool
virtual ~IDMSearchTool ()
 
- Public Member Functions inherited from IUITool
virtual ~IUITool ()
 

Protected Member Functions

virtual CRef< CSearchJobBasex_CreateJob (IDMSearchQuery &query)
 implementing CSearchToolBase pure virtual function More...
 
- Protected Member Functions inherited from CSearchToolBase
int x_GetSessionIndexByID (int job_id)
 
int x_GetSessionIndexByQuery (IDMSearchQuery &query)
 
int x_GetSessionIndexByListener (IDMSearchFormController &listener)
 
virtual void x_OnJobCompleted (CAppJobNotification &notify, SSession &session)
 
virtual void x_OnJobFailed (CAppJobNotification &notify, SSession &session)
 
virtual void x_OnJobCanceled (CAppJobNotification &notify, SSession &session)
 
- 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)
 

Additional Inherited Members

- Public Types inherited from CSearchToolBase
enum  EPatternType { eExactMatch , eWildcard , eRegexp , eNamed }
 
- 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 Types inherited from IDMSearchTool
enum  TUIFlagValue { eNone = 0 , eAutorun = 1 , eCache = 2 , eFilter = 4 }
 
typedef int TUIToolFlags
 
typedef pair< string, stringTFilter
 
- Static Public Member Functions inherited from CSearchToolBase
static string GetPatternTypeStr (EPatternType ptype)
 String representation of pattern type. 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 Member Functions inherited from CEventHandler
static bool HandlePostRequest ()
 
static void ClearPostQueue ()
 erases all events from the queue More...
 
static void DestroyPostQueue ()
 
- 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 Attributes inherited from CSearchToolBase
string m_Name
 
int m_ReportPeriod
 
vector< SSession * > m_Sessions
 
IDMSearchTool::TConversions m_Conversions
 
IDMSearchTool::TFilters m_Filters
 
CRef< CObjectListm_Cache
 
- Protected Attributes inherited from CEventHandler
TPools m_Pools
 
- Static Protected Attributes inherited from CEventHandler
static const SEvtMap sm_EvtMap
 

Detailed Description

CSNPSearchTool.

Definition at line 54 of file snp_search_tool.hpp.


The documentation for this class was generated from the following files:
Modified on Mon Apr 22 04:01:53 2024 by modify_doxy.py rev. 669887