HASSLE Code documentation

location: Home > Archive > HASSLE > HASSLE code documentation

Chapter 5-6:Vertical Utilities


Section 5-6: Vertical Utilities

Copyrighted material. See the Internet Biocompanion Home Page for further information.

[ Previous chapter ][ This chapter ][ Next chapter ]

$Header: /bioy2/biocomputing/eggenber/Hassle/RCS/functionsv.txt,v 1.13 1994/10/12 10:02:27 eggenber Exp $

 
  
/*+*****************************************************************************  
  
Function:       ProcInt  
  
Purpose:        Integer handling utility. Copies an integer from/to a dynamic  
                data structure containing variable identifier and value as  
                structure elements.  
  
Arguments:      variable identifier;  
                pointer to its value;  
                type of action (PUT/GET/FREE)  
  
Return value:   SUCCESS if everything is ok;  
                VARNOTFOUND on attempt to operate on an undefined variable  
  
Called by:      CloseCliComIP[1];  
                CloseSerComIP[1];  
                CompDoItLine[3];  
                OpenCliComIP[1];  
                OpenSerComIP[1];  
                ReceiveLineIP[1];  
                SendLineIP[1]  
  
Calls:  
  
*****************************************************************************-*/  
/*+*****************************************************************************  
  
Function:       ProcLong  
  
Purpose:        Long integer handling utility. Copies a long integer from/to  
                a dynamic data structure containing variable identifier and  
                value as structure elements.  
  
Arguments:      variable identifier;  
                pointer to its value;  
                type of action (PUT/GET/FREE)  
  
  
Return value:   SUCCESS if everything is ok;  
                VARNOTFOUND on attempt to operate on an undefined variable  
  
Called by:      CompTimeLine[3];  
                ParsTimeLine[3]  
  
Calls:  
  
*****************************************************************************-*/  
/*+*****************************************************************************  
  
Function:       ProcMessage  
  
Purpose:        Message handling utility. Determine the message handling mode  
                and the debugging mode from the public variables "i_messagemode"  
   
                and "cp_debugmode" or default values. Print message to the  
                appropriate stream. If the message has to be printed to a  
                logfile, then determine whether the logfile already exists.  
                If it is the first time writing to the logfile, then assign a  
                unique filename using to the current time and check whether the  
                filename is already in use by another process. Then copy the  
                filename to public storage.  
  
Arguments:      pointer to the message;  
                message type (__DEFAULT/__VERBOSE/__DEBUG/__EDEBUG)  
  
Return value:   LOCKFILE_CREATE_ERR if creating lockfile failed;  
                LOGFILE_OPEN_ERR if opening logfile failed;  
                LOGFILE_WRITE_ERR if writing logfile failed;  
                SUCCESS if everything is ok  
  
Called by:  
  
Calls:          ProcInt[V];  
                ProcString[V]  
  
*****************************************************************************-*/  
/*+*****************************************************************************  
  
Function:       ProcString  
  
Purpose:        String handling utility. Copies a string  from/to a dynamic  
                data structure containing variable identifier and pointer to  
                its first element as structure elements.  
  
Arguments:      variable identifier;  
                pointer to its first element;  
                type of action (PUT/GET/FREE)  
  
  
Return value:   SUCCESS if everything is ok;  
                VARNOTFOUND on attempt to operate on an undefined variable  
  
Called by:      AssFirstHost[3];  
                AssNextHost[3];  
                CompDatEndLine[3];  
                CompDatStartLine[3];  
                CompDoItLine[3];  
                CompExitLine[3];  
                CompFailLine[3];  
                CompHassLine[3];  
                CompServLine[3];  
                CompTimeLine[3];  
                CompXDatLine[3];  
                CompYDatLine[3];  
                CtrlHassProc[5];  
                OpenCliComIP[1];  
                ParsXDatLine[3];  
                ParsYDatLine[3]  
  
Calls:  
  
*****************************************************************************-*/  

[next page] , or [overview] , or [table of contents]