src/clustal/progress.c File Reference

#include <stdlib.h>
#include <stdio.h>
#include <assert.h>
#include "util.h"
#include "log.h"
#include "progress.h"
Include dependency graph for progress.c:

Defines

#define LOGLEVEL_THRESHOLD   LOG_INFO

Functions

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

Define Documentation

#define LOGLEVEL_THRESHOLD   LOG_INFO

Function Documentation

void FreeProgress ( progress_t **  pprProgress  ) 

Frees progress structure and its members.

Parameters:
[out] pprProgress Pointer pointer to progress structure
See also:
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] pprProgress Pointer pointer to progress structure. Progress structure will be allocated here.
[in] prFile Where to log messages to
[in] pcPrefix What prefix to use for messages
[in] bPrintCR If TRUE carriage return instead of newline will be printed between log messages
void ProgressDone ( progress_t prProgress  ) 

Finishes progress output by printing the elapsed time.

Parameters:
[in] prProgress Pointer to the progress structure
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] prProgress Pointer to the progress structure
[in] iStep Current step number
[in] iTotalSteps Total step number
[in] bForceOutput If percentage hasn't changed output is normally supressed normally. Output can be forced with this flag.
Generated on Fri Aug 31 05:32:52 2012 for Clustal Omega by  doxygen 1.6.3