Changeset 17634 for trunk/psModules/src/camera/pmFPAfileDefine.h

Timestamp:

May 12, 2008, 11:41:55 AM (18 years ago)

Author:

Paul Price

Message:

Adding additional notes in header file that the returned pmFPAfile is a view only (the caller should not free it). Cleaning up erroneous frees of the pmFPAfile when an error is hit.

File:

• trunk/psModules/src/camera/pmFPAfileDefine.h (modified) (6 diffs)

trunk/psModules/src/camera/pmFPAfileDefine.h

@@ -4 +4 @@
  * @author EAM, IfA
  *
- * @version $Revision: 1.16 $ $Name: not supported by cvs2svn $
- * @date $Date: 2007-12-27 02:08:19 $
+ * @version $Revision: 1.17 $ $Name: not supported by cvs2svn $
+ * @date $Date: 2008-05-12 21:41:55 $
  * Copyright 2004-2005 Institute for Astronomy, University of Hawaii
  */
@@ -39 +39 @@
 
 /// Define the FPA file using the provided camera and format names.
+///
+/// Note that the returned pmFPAfile is a view only, so it should not be freed by the caller --- the only
+/// reference count is held by the config->files metadata.
 pmFPAfile *pmFPAfileDefineOutputForFormat(const pmConfig *config, // Configuration
                                           pmFPA *fpa, // Optional FPA to bind
@@ -78 +81 @@
 
 /// Same as pmFPAfileDefineFromFPA, except it uses an FPA file instead of an FPA
+///
+/// The new pmFPAfile is inserted into the config->files metadata, freed and returned; so that the user does
+/// not have to (and should not!) free the result.
 pmFPAfile *pmFPAfileDefineFromFile(const pmConfig *config, // Configuration
                                    pmFPAfile *src, // Source file for this file
@@ -122 +128 @@
 // create a file with the given name, assign it type "INTERNAL", and supply it with an image
 // of the requested dimensions. (image only, mask and weight are ignored)
-pmReadout *pmFPAfileDefineInternal (psMetadata *files, const char *name, int Nx, int Ny, int type);
+///
+/// The new pmFPAfile is inserted into the config->files metadata, freed and returned; so that the user does
+/// not have to (and should not!) free the result.
+pmReadout *pmFPAfileDefineInternal(psMetadata *files, const char *name, int Nx, int Ny, int type);
 
 // delete the INTERNAL file of the given name (if it exists)
-bool pmFPAfileDropInternal (psMetadata *files, const char *name);
+bool pmFPAfileDropInternal(psMetadata *files, const char *name);
 
 // look for the given argname on the argument list.  find the give filename from the file rules
@@ -131 +140 @@
 // Note that the returned pmFPAfile is a view only, so it should not be freed by the caller --- the only
 // reference count is held by the config->files metadata.
-pmFPAfile *pmFPAfileDefineSingleFromArgs (bool *found, pmConfig *config, const char *filename,
-        const char *argname, int entry);
+pmFPAfile *pmFPAfileDefineSingleFromArgs(bool *found, pmConfig *config, const char *filename,
+                                         const char *argname, int entry);
 
 // Select or construct the requested readout.  If the named entry does not exist, generate it based
@@ -139 +148 @@
 // pmFPAfile is being used internally.
 pmReadout *pmFPAGenerateReadout(const pmConfig *config, // configuration information
-                                const pmFPAview *view, // select background for this entry
-                                const char *name, // name of internal/external file
-                                const pmFPA *fpa, // use this fpa to generate
-                                const psImageBinning *binning);
+                                const pmFPAview *view, // select background for this entry
+                                const char *name, // name of internal/external file
+                                const pmFPA *fpa, // use this fpa to generate
+                                const psImageBinning *binning);
 
 /// @}