Main Page   Compound List   File List   Compound Members   File Members   Related Pages  

ccp4_program.h File Reference

Go to the source code of this file.

Defines

#define CCP4_VERSION_NO   "5.0"
#define CCP4_PATCH_LEVEL   "5.0.0"
#define MAXLEN_PROGNAME   80
#define MAXLEN_PROGVERSION   80
#define MAXLEN_RCSDATE   80

Functions

char * ccp4_prog_vers (char *progvers)
char * ccp4ProgramName (const char *progname)
char * ccp4RCSDate (const char *rcs_string)
void ccp4ProgramTime (int init)
int ccp4VerbosityLevel (int level)
int ccp4_licence_exists (const char *name)
int html_log_output (int ihtml_in)
int summary_output (int isumm_in)


Detailed Description

Utilies to set and fetch program information. Peter Briggs CCP4 May 2001


Function Documentation

int ccp4_licence_exists const char *    name
 

Check existence of licence agreement

Parameters:
name  Name of licence, e.g. "CCP4".
Returns:
1 for licence exists, else 0.

char* ccp4_prog_vers char *    progvers
 

Register or query program version.

Parameters:
progvers  Program version string, or NULL to query existing value.
Returns:
Program version string.

char* ccp4ProgramName const char *    progname
 

Set or return program name.

Parameters:
progname  Program name, or NULL to query existing value.
Returns:
Program name

void ccp4ProgramTime int    init
 

Set or print program time information

Parameters:
init 

char* ccp4RCSDate const char *    rcs_string
 

Set or return program RCS date

Parameters:
rcs_string  Date string, or NULL to query existing value.
Returns:
Date string

int ccp4VerbosityLevel int    level
 

Set or return the reference verbosity level Always return the verbosity level - if verboselevel is between 0 and 9 then reset the verbosity level to verboselevel

Parameters:
level  Verbosity level, or -1 to query existing value.
Returns:
Verbosity level

int html_log_output int    ihtml_in
 

Register or query html output level.

Parameters:
ihtml_in  0 = turn off html output, 1 = turn on html output, -1 = query existing value
Returns:
0 = no html output, 1 = html output

int summary_output int    isumm_in
 

Register or query summary output level.

Parameters:
isumm_in  0 = turn off summary output, 1 = turn on summary output, -1 = query existing value
Returns:
0 = no summary output, 1 = summary output