mqsession.h

00001 #ifndef _SESSION_H_
00002 #define _SESSION_H_
00003 
00004 /* Copyright (c) Kyriacos Leptos and the President and Fellows of Harvard University
00005    Release Date: 2004-11-01
00006    Part of the MapQuant suite library "massspec.lib" 
00007 */
00008 
00009 extern char* CURR_SESSION_PATH;
00010 extern char* CURR_SESSION_NAME;
00011 
00012 Rectangle4i     Session_getRectangle4i  (MQExperiment *expmnt, char* session_name);
00013 char*           Session_getPath         (MQExperiment *expmnt, char* szSessionName);
00014 void            Session_createFolder    (MQExperiment *expmnt, char* session);
00015 MQString*       Session_getSessionsFromFile(char* filename, int* nsessions);
00016 int             Session_isMultiple      (MQExperiment *expmnt, char* session);
00017 
00018 /*>char* Session_assembleFilename(MQExperiment *expmnt, char* szSession, char* szLabel, FileType nType)
00019    ---------------------------------------------
00020    Input:   MQExperiment *expmnt     the pointer to an MQExperiment data structure
00021             char*      szSession   the name of the session
00022             FileType   nType       the the type of the file
00023             char*      szLabel     the label attached to the session name 
00024 
00025    Returns: char  *        the name of the filename
00026    It assembles a filename of in the session folder in the form:
00027    "SESSION_PATH"/"SESSION_NAME"."LABEL"."FILE_EXTENSION"
00028    e.g. Session_assembleFilename("030212081232", FILE_IPK, "bs")
00029    would give: "SESSION_PATH"/030212081232_bs.fpeaks
00030 
00031    15.01.96 The date the function was created followed by
00032             dates of any modifications in the same format
00033 */
00034 
00035 char*   Session_assembleFilename(MQExperiment *expmnt, char* szSession, char* szNameInSession, MQFileType nType);
00036 
00037 char*   Session_assembleSubFilename(MQExperiment *expmnt, char* session, char* filename, MQFileType nType, char* subfilename);
00038 void    Session_createFilenameFolder(MQExperiment *expmnt, char* session, char* filename, MQFileType nType);
00039 char*   Session_getProcScriptName(MQExperiment* expmnt, char* szSession);
00040 
00041 #endif
00042 

Generated on Tue Feb 7 11:54:27 2006 for libmqobject by  doxygen 1.4.6