Clustal Omega  1.2.4
Data Structures | Functions
progress.h File Reference
#include "squid/stopwatch.h"
Include dependency graph for progress.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  progress_t
 

Functions

void NewProgress (progress_t **pprProgress, FILE *prFile, char *pcPrefix, bool bPrintCR)
 Allocates a new progress structure and initialises its members. Free with FreeProgress() More...
 
void FreeProgress (progress_t **pprProgress)
 Frees progress structure and its members. More...
 
void ProgressLog (progress_t *prProgress, unsigned long int iStep, unsigned long int iTotalSteps, bool bForceOutput)
 Prints a progress update (and a carriage return) More...
 
void ProgressDone (progress_t *pprProgress)
 Finishes progress output by printing the elapsed time. More...
 

Function Documentation

◆ FreeProgress()

void FreeProgress ( progress_t **  pprProgress)

Frees progress structure and its members.

Parameters
[out]pprProgressPointer pointer to progress structure
See also
NewProgress()

◆ NewProgress()

void NewProgress ( progress_t **  pprProgress,
FILE *  prFile,
char *  pcPrefix,
bool  bPrintCR 
)

Allocates a new progress structure and initialises its members. Free with FreeProgress()

Note
Starts the internal stopwatch immediatly!
See also
FreeProgress()
Parameters
[out]pprProgressPointer pointer to progress structure. Progress structure will be allocated here.
[in]prFileWhere to log messages to
[in]pcPrefixWhat prefix to use for messages
[in]bPrintCRIf TRUE carriage return instead of newline will be printed between log messages

◆ ProgressDone()

void ProgressDone ( progress_t prProgress)

Finishes progress output by printing the elapsed time.

Parameters
[in]prProgressPointer to the progress structure

◆ ProgressLog()

void ProgressLog ( progress_t prProgress,
unsigned long int  iStep,
unsigned long int  iTotalSteps,
bool  bForceOutput 
)

Prints a progress update (and a carriage return)

Parameters
[in]prProgressPointer to the progress structure
[in]iStepCurrent step number
[in]iTotalStepsTotal step number
[in]bForceOutputIf percentage hasn't changed output is normally supressed normally. Output can be forced with this flag.