Content-type: text/html Manpage of RAPIDS

RAPIDS

Section: RAPIDS Application related API (API)
Updated: September 2004
Index  

NAME

namespace rapids
reporterror(), debugmsg(),
reportvar(), algstate(),
- RAPIDS C++ API for user applications
 

DESCRIPTION

The RAPIDS Application Programmer Interface (API) provides various functions that users can use in their applications to report different kinds of events to the RAPIDS Main Display and Control Node (MDCN).

All functions returns immediately after posting the event information into the RAPIDS messaging system

Most of the functions return SUCCESS (1) if successful, else FAILURE(-1) in case of error.

 

How to use them

#include "rapids_api++.h"
g++ -I{RAPIDS_API_INCLUDEDIR} ... -L{RAPIDS_API_LIBDIR} -lrmq


where RAPIDS_API_INCLUDEDIR is the directory where "rapids_api++.h" is present
and RAPIDS_API_LIBDIR is the directory where librmq.a is present

 

Routines

int rapids::reporterror(int error_level, string error_msg) ;
Logs an API event reporting an error to the RAPIDS system.

error_level is one of the 3 error_levels: FATAL, SEVERE and WARNING. error_msg is a C++ string containing the error message.

int rapids::debugmsg(int debug_level, string debug_msg) ;
Logs an API event to print a debug message to the RAPIDS system.

debug_level is one of the 3 debug_levels: FINE, FINER and and FINEST. debug_msg is a C++ string containing the debug message.

int rapids::reportvar(char* var_name, string var_val) ;
Logs an API event to report the value of a certain variable.

var_name is the name of the variable. var_val is a C++ string containing the value of the variable in ASCII text.

Other version of this call with options for specifying an integer, long, float, or double for the var_val are forthcoming.

int rapids::algstatus(char* alg_name, char* status) ;
Logs an API event to report the state of the (current) algorithm being run.

alg_name is the name of the algorithm to be reported. status is the current state of the algorithm as defined by one of the algstatus codes: ALG_START and ALG_END

 

EXAMPLES

#include "rapids_api++.h"

int main() {


  rapids::reporterror(SEVERE, "This is a grave error") ;


  rapids::debugmsg(FINEST, "reached here") ;


  rapids::reportvar("double d", "2") ;


  rapids::algstatus("main", ALG_START) ;


  return 0 ;

}

 

SEE ALSO

printf(2), rmq(2),  

BUGS AND RESTRICTIONS

Still testing


 

Index

NAME
DESCRIPTION
How to use them
Routines
EXAMPLES
SEE ALSO
BUGS AND RESTRICTIONS

This document was created by man2html, using the manual pages.
Time: 11:56:55 GMT, March 25, 2005