pmFPAfileIO.h

Go to the documentation of this file.
00001 /* @file  pmFPAview.h
00002  * @brief Tools to manipulate the FPA structure elements.
00003  *
00004  * @author EAM, IfA
00005  *
00006  * @version $Revision: 1.3 $ $Name:  $
00007  * @date $Date: 2007/01/24 02:54:14 $
00008  * Copyright 2004-2005 Institute for Astronomy, University of Hawaii
00009  */
00010 
00011 #ifndef PM_FPA_FILE_IO_H
00012 #define PM_FPA_FILE_IO_H
00013 
00014 /// @addtogroup Camera Camera Layout
00015 /// @{
00016 
00017 // open the real file corresponding to the given pmFPAfile appropriate to the current view
00018 bool pmFPAfileOpen (pmFPAfile *file, const pmFPAview *view, pmConfig *config);
00019 
00020 // read from the real file corresponding to the given pmFPAfile for the current view
00021 bool pmFPAfileRead (pmFPAfile *file, const pmFPAview *view, pmConfig *config);
00022 
00023 bool pmFPAfileCreate (pmFPAfile *file, const pmFPAview *view, pmConfig *config);
00024 
00025 // write to the real file corresponding to the given pmFPAfile for the current view
00026 bool pmFPAfileWrite (pmFPAfile *file, const pmFPAview *view, pmConfig *config);
00027 
00028 // close the real file corresponding to the given pmFPAfile appropriate to the current view
00029 bool pmFPAfileClose (pmFPAfile *file, const pmFPAview *view);
00030 
00031 // free the data at this level
00032 bool pmFPAfileFreeData(pmFPAfile *file, const pmFPAview *view);
00033 
00034 // set the state of the specified pmFPAfile to active (state == true) or inactive
00035 // if name is NULL, set the state for all pmFPAfiles
00036 bool pmFPAfileActivate (psMetadata *files, bool state, char *name);
00037 
00038 // examine all pmFPAfiles listed in the files and perform the needed I/O operations (open,read,write,close)
00039 bool pmFPAfileIOChecks (pmConfig *config, const pmFPAview *view, pmFPAfilePlace place);
00040 
00041 /// @}
00042 # endif

Generated on Fri Feb 2 22:35:28 2007 for Pan-STARRS Module Library by  doxygen 1.5.1