NCBI C++ ToolKit
Public Member Functions | Protected Attributes | Private Member Functions | List of all members
CBamUIDataSource Class Reference

Search Toolkit Book for CBamUIDataSource

CBamUIDataSource. More...

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

+ Inheritance diagram for CBamUIDataSource:
+ Collaboration diagram for CBamUIDataSource:

Public Member Functions

 CBamUIDataSource (CBamUIDataSourceType &type)
 ~CBamUIDataSource ()
IExtension interface 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...
IServiceLocatorConsumer implementation
virtual void SetServiceLocator (IServiceLocator *locator)
IUIDataSource interface implementation
virtual IUIDataSourceTypeGetType () const
virtual const IUIObjectGetDescr ()
 returns UI description of the object (label, icon etc.) More...
virtual bool IsOpen ()
 a Data source needs to be open before use and closed after. More...
virtual bool Open ()
 Prepares Data Source for use, any initialization that can be potentially time-consuming or may require error handling shall be done in this function, not in a constructor. More...
virtual bool Close ()
virtual void EditProperties ()
virtual IUIToolManagerGetLoadManager ()
virtual int GetDefaultCommand ()
virtual wxEvtHandler * CreateEvtHandler ()
IDataLoaderProvider implementation
virtual string AddDataLoader (const objects::CUser_object &obj)
 Add a new data loader to object manager. More...
virtual string GetLoaderName (const objects::CUser_object &obj) const
 Get the data loader's name based on input object. More...
IExplorerItemCmdContributor implementation
virtual IExplorerItemCmdContributor::TContribution GetMenu (wxTreeCtrl &treeCtrl, PT::TItems &items)
 for the given set of items returns a contribution More...
- 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 IExtension
virtual ~IExtension ()
- Public Member Functions inherited from IServiceLocatorConsumer
virtual ~IServiceLocatorConsumer ()
- Public Member Functions inherited from IUIDataSource
virtual ~IUIDataSource ()
- Public Member Functions inherited from IDataLoaderProvider
virtual ~IDataLoaderProvider ()
- Public Member Functions inherited from IExplorerItemCmdContributor
virtual ~IExplorerItemCmdContributor ()

Protected Attributes

CRef< CBamUIDataSourceTypem_Type
CUIObject m_Descr
bool m_Open

Private Member Functions

bool x_GetBamInputs (const objects::CUser_object &obj, string &path, string &files, string &idx, string &target_assm) const
bool x_GetSrzAccession (const objects::CUser_object &obj, string &srz) const
bool x_GetCSraInputs (const objects::CUser_object &obj, string &file) const
bool x_GetSraAccession (const objects::CUser_object &obj, string &sra) const

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< Uint8TCounter
 Counter type is CAtomiCounter. More...
typedef Uint8 TCount
 Alias for value type of counter. More...
- Public Types inherited from IExplorerItemCmdContributor
typedef pair< wxMenu *, wxEvtHandler * > TContribution
 Contribution consists of a Menu object and event handler. 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


Definition at line 71 of file bam_ui_data_source.hpp.

The documentation for this class was generated from the following files:
Modified on Wed Jun 19 17:02:31 2024 by rev. 669887