Changeset 2932 in Sophya for trunk/SophyaExt/FitsIOServer/fitshandler.h

Timestamp:

Apr 3, 2006, 12:13:59 PM (19 years ago)

Author:

ansari

Message:

Modifs suggere par Casandjian (suppression espace ds les kw fits et conservation des kw de type STRUCT) et petites corrections, maj commentaires auto-doc - Reza 3/4/2006

File:

• trunk/SophyaExt/FitsIOServer/fitshandler.h (modified) (1 diff)

trunk/SophyaExt/FitsIOServer/fitshandler.h

@@ -20 +20 @@
   //! Return the real data object
   virtual AnyDataObj* DataObj() = 0;       // Retourne l'objet reel 
-  //! Return a positive value if I/O for object \b o can be handled
+
+  /*! 
+    \brief Return a positive value if I/O for object \b o can be handled
+
+    - Rc= 0 -> Can NOT handle fits I/O operations for the object \b o 
+    - Rc= 1 -> Can handle fits I/O operations for the object \b o 
+    - Rc= 2 -> This is a specific handler for object \b o
+    - Rc > 2 -> Higher Rc values can be returned if needed 
+      (for subclasses with specific handlers)
+
+  */
   virtual int         CheckHandling(AnyDataObj & o) = 0;
   //! Read/write operation will use the object o
   virtual void        SetDataObj(AnyDataObj & o) = 0;
 
-  //! Return a positive value if current HDU can be read by the handler
+  //! 
+  /*! 
+    \brief Return a positive value if current HDU can be read by the handler
+
+    - Rc= 0 -> Can NOT read the current HDU 
+    - Rc= 1 -> Can read the current HDU (generic reader)
+    - Rc= 2 -> Can read the current HDU, as a specific reader
+    - Rc > 2 -> Higher Rc values can be returned if needed 
+      (when multiple specific handlers are registered) 
+
+  */
   virtual int         CheckReadability(FitsInOutFile& is) = 0;