NCBI C++ ToolKit
Public Attributes | List of all members
SBlastProgress Struct Reference

Search Toolkit Book for SBlastProgress

Progress monitoring structure. More...

#include <algo/blast/core/blast_def.h>

Public Attributes

EBlastStage stage
 Stage of the BLAST search currently in progress. More...
void * user_data
 Pointer to user-provided data. More...

Detailed Description

Progress monitoring structure.

This is updated by the engine to provided to the user as an argument to the user-supplied callback function (TInterruptFnPtr). This function then can assess whether the search should proceed or exit prematurely.

See also

Definition at line 341 of file blast_def.h.

Member Data Documentation

◆ stage

EBlastStage SBlastProgress::stage

Stage of the BLAST search currently in progress.

Definition at line 342 of file blast_def.h.

Referenced by BLAST_ComputeTraceback_MT(), BLAST_PreliminarySearchEngine(), CSBlastProgress::DebugDump(), interrupt_on_traceback(), and SBlastProgressReset().

◆ user_data

void* SBlastProgress::user_data

The documentation for this struct was generated from the following file:
Modified on Thu Feb 22 17:10:11 2024 by rev. 669887