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

Timestamp:

Nov 18, 2006, 3:55:24 PM (19 years ago)

Author:

Paul Price

Message:

Adding note that returned pointer is only a view.

File:

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

trunk/psModules/src/camera/pmFPAfileDefine.h

@@ -7 +7 @@
 *  @author EAM, IfA
 *
-*  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
-*  @date $Date: 2006-06-28 19:23:20 $
+*  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
+*  @date $Date: 2006-11-19 01:55:24 $
 *
 *  Copyright 2004-2005 Institute for Astronomy, University of Hawaii
@@ -19 +19 @@
 
 // load the pmFPAfile information from the camera configuration data
+//
+// 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 *pmFPAfileDefineInput (pmConfig *config, pmFPA *fpa, char *name);
 
 // load the pmFPAfile information from the camera configuration data
+//
+// 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 *pmFPAfileDefineOutput (pmConfig *config, pmFPA *fpa, char *name);
 
 // look for the given argname on the argument list.  find the give filename from the file rules
+//
+// 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 *pmFPAfileDefineFromArgs (bool *found, pmConfig *config, char *filename, char *argname);
 
 // look for the given argname on the argument list.  find the give filename from the file rules
+//
+// 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 *pmFPAfileDefineFromConf (bool *found, pmConfig *config, char *filename);
 
 // look for the given argname on the argument list.  find the give filename from the file rules
+//
+// 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 *pmFPAfileDefineFromDetDB (bool *found, pmConfig *config, char *filename, pmFPA *input, pmDetrendType type);
 
 // create a new output pmFPAfile based on an existing FPA
+//
+// 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 *pmFPAfileDefineFromFPA (pmConfig *config, pmFPA *src, int xBin, int yBin, char *filename);
 
 // create a new output pmFPAfile based on an existing FPA
 // only valid for pmFPAfile->mode == WRITE (or internal?)
+//
+// 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 *pmFPAfileDefineNewCamera (pmConfig *config, char *filename);
 
@@ -48 +69 @@
 
 // look for the given argname on the argument list.  find the give filename from the file rules
+//
+// 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, char *filename, char *argname, int entry);
 # endif