A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/doxyhtml/classCDataLoadingAppJob.html below:

NCBI C++ ToolKit: CDataLoadingAppJob Class Reference

Search Toolkit Book for CDataLoadingAppJob

CDataLoadingAppJob - a base class for Jobs loading data into projects. More...

#include <gui/core/loading_app_job.hpp>

  CDataLoadingAppJob ()   constructor for derived classes More...
  virtual  ~CDataLoadingAppJob ()   const CSelectProjectOptions::TData &  GetData () const   const objects::CScope &  GetScope () const   virtual void  GetHTMLResults (wxString &, wxString &)   void  AddProjectItem (objects::CProjectItem &item)   void  AddProjectItem (objects::CProjectItem &item, objects::CLoaderDescriptor &loader)   void  AddDataLoader (objects::CLoaderDescriptor &loader)   void  ClearItems ()   virtual EJobState  Run ()   Function that does all the useful work, called by the Engine. More...
  virtual CRef< CObject >  GetResult ()   Returns the Job Result. More...
  virtual CConstIRef< IAppJobProgress >  GetProgress ()   implement Run() in derived classes, make sure that exceptions are handled and m_StopRequested flag is respected. More...
    CAppJob (const string &descr="AppJob")   CAppJob. More...
  virtual CConstIRef< IAppJobError >  GetError () override   Returns IAppJobError object describing internal error that caused the Job to fail. More...
  virtual string  GetDescr () const override   Returns a human readable description of the Job (optional) More...
    CJobCancelable ()   void  SetDataLocker (ILocker *locker)   virtual void  RequestCancel () override   RequestCancel() is called to notify the Job that it shall exit Run() function ASAP. More...
  virtual bool  IsCanceled () const override     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...
    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   virtual  ~IAppJob ()   virtual bool  BeforeRun ()   Function will be called on the main thread before execution of Run Should not do any lengthy work returns true to continue job execution on worker thread false to quit execution with status - failed. More...
 

CDataLoadingAppJob - a base class for Jobs loading data into projects.

Definition at line 71 of file loading_app_job.hpp.

◆ CDataLoadingAppJob() CDataLoadingAppJob::CDataLoadingAppJob ( ) ◆ ~CDataLoadingAppJob() ◆ AddDataLoader() void CDataLoadingAppJob::AddDataLoader ( objects::CLoaderDescriptor &  loader ) ◆ AddProjectItem() [1/2] void CDataLoadingAppJob::AddProjectItem ( objects::CProjectItem &  item )

Referenced by CGBProjectHelper::AddProjectItemsFromRID(), CMSAToolJob::x_AddTreeProjectItem(), CVcfLoadingJob::x_CreateColumnarVCFProjectItem(), CProSplignJob::x_CreateOneProjectItem(), CGBankLoadingJob::x_CreateProjectItems(), CBLASTSeqToolJob::x_CreateProjectItems(), CCleanupAlignmentsJob::x_CreateProjectItems(), CGroupAlignmentsJob::x_CreateProjectItems(), CMergeAlignmentsJob::x_CreateProjectItems(), CMSAToolJob::x_CreateProjectItems(), CNGAlignJob::x_CreateProjectItems(), CPhyloTreeJob::x_CreateProjectItems(), CTaxTreeToolJob::x_CreateProjectItems(), CAdvancedCleanupJob::x_CreateProjectItems(), CCreateNeedlemanWunschJob::x_CreateProjectItems(), CFindOverlapJob::x_CreateProjectItems(), CSplignJob::x_CreateProjectItems(), CTreeBuilderJob::x_CreateProjectItems(), CBamLoadingJob::x_CreateProjectItems(), CWindowMaskerJob::x_CreateProjectItems(), CSrcEditJob::x_CreateProjectItems(), and CVcfLoadingJob::x_CreateSeqIdProjectItem().

◆ AddProjectItem() [2/2] void CDataLoadingAppJob::AddProjectItem ( objects::CProjectItem &  item, objects::CLoaderDescriptor &  loader  ) ◆ ClearItems() void CDataLoadingAppJob::ClearItems ( ) ◆ GetData() ◆ GetHTMLResults() virtual void CDataLoadingAppJob::GetHTMLResults ( wxString &  , wxString &    ) inlinevirtual ◆ GetProgress() ◆ GetResult() ◆ GetScope() const objects::CScope& CDataLoadingAppJob::GetScope ( void  ) const inline ◆ Run()

Function that does all the useful work, called by the Engine.

Run() shall be implemented so that it will allow for exiting once RequestCancel() is called.

Implements IAppJob.

Definition at line 71 of file loading_app_job.cpp.

References IAppJob::eCompleted, IAppJob::eFailed, Error(), CAppJob::GetDescr(), CException::GetMsg(), Info(), LOG_POST, CAppJob::m_Descr, CAppJob::m_Error, CAppJob::m_Mutex, CException::ReportAll(), CRef< C, Locker >::Reset(), x_ResetState(), and x_Run().

◆ x_CreateProjectItems() virtual void CDataLoadingAppJob::x_CreateProjectItems ( ) protectedpure virtual

override this function in derived classes and populate m_Items.

If data loaders are needed, they should be created here too.

Implemented in CSrcEditJob, CWindowMaskerJob, CMergeItemsJob, CVcfLoadingJob, CCleanupJob, CBamLoadingJob, CTreeBuilderJob, CSplignJob, CProSplignJob, CFindOverlapJob, CCreateNeedlemanWunschJob, CAdvancedCleanupJob, CDebugMacroToolJob, CTaxTreeToolJob, CPhyloTreeJob, CNGAlignJob, CMSAToolJob, CMergeAlignmentsJob, CGroupAlignmentsJob, CCleanupAlignmentsJob, CBLASTSeqToolJob, CNetBlastLoadingJob, and CGBankLoadingJob.

Referenced by x_Run().

◆ x_ResetState() void CDataLoadingAppJob::x_ResetState ( ) protectedvirtual ◆ x_Run() void CDataLoadingAppJob::x_Run ( void  ) protectedvirtual ◆ x_SetTextResult() void CDataLoadingAppJob::x_SetTextResult ( const string &  result ) protected ◆ m_Data ◆ m_DataMutex std::mutex CDataLoadingAppJob::m_DataMutex private ◆ m_Scope CRef<objects::CScope> CDataLoadingAppJob::m_Scope protected ◆ m_TextResult string CDataLoadingAppJob::m_TextResult protected

The documentation for this class was generated from the following files:

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4