mpe_describe_state.4

fortran并行计算包

.TH MPE_Describe_state 4 "2/2/2008" " " "MPE"
.SH NAME
MPE_Describe_state \-  Describe the attributes of a state without byte informational data in MPI_COMM_WORLD. 
.SH SYNOPSIS
.nf
int MPE_Describe_state( int state_startID, int state_finalID,
                        const char *name, const char *color )
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B state_startID 
- event number for the beginning of the state.
.PD 1
.PD 0
.TP
.B state_finalID 
- event number for the ending of the state.
.PD 1
.PD 0
.TP
.B name          
- name of the state,
the maximum length of the NULL-terminated string is,
sizeof(CLOG_DESC), 32.
.PD 1
.PD 0
.TP
.B color         
- color of the state,
the maximum length of the NULL-terminated string is,
sizeof(CLOG_COLOR), 24.
.PD 1

.SH NOTES
Adds a state definition to the logfile.
States are added to a log file by calling 'MPE_Log_event()'
for the start and end event numbers.  The function is provided
for backward compatibility purpose.  Users are urged to
use 'MPE_Describe_comm_state()' and 'MPE_Log_comm_event()' instead.

This function is threadsafe.

.SH SEE ALSO
MPE_Log_get_state_eventIDs(), MPE_Describe_comm_state()
.br
.SH LOCATION
../src/logging/src/mpe_log.c