X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=lib%2FmaracasVisuLib%2Fsrc%2Finterface%2FwxWindows%2Fwidgets%2FimageUndoRedo%2FimageDequeUR.h;h=69cf80a435b1dc37f49bf7058d8905b36dcf3129;hb=f050938d3947f6b785289da6d58f8fec2da57421;hp=a20630aa8d844ef1a7fefc0d38179b7807a736b0;hpb=ada3e60bcd998550327dac4f95b65f0c113f063b;p=creaMaracasVisu.git

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/imageDequeUR.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/imageDequeUR.h
index a20630a..69cf80a 100755
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/imageDequeUR.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/imageDequeUR.h
@@ -1,8 +1,9 @@
-/*
- * ImageDeque.h
- *
- *  Created on: Sep 22, 2011
- *      Author: caceres
+/*!
+ * @file	imageDequeUR.h
+ * @brief	This file contains the Image3DDequeUR class. -- Abstract class
+ * @author 	Info-Dev
+ * @author	Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
+ * @date 	2011-11-15
  */
 
 #ifndef IMAGEDEQUE_H_
@@ -16,25 +17,78 @@
 #include "imageInfoUR.h"
 #include "imageModificationManager.h"
 
+/*! @class ImageDequeUR imageDequeUR.h "imageDequeUR.cxx"
+ *	@brief This class contains the management of the undo/redo - Abstract Class
+ */
 class ImageDequeUR {
 public:
-	typedef std::deque<ImageInfoUR*> ImageInfoDeque;
+	//typedef definition
+	// ----------------------------------------------------------------------------------
+	/*!	@typedef vtkSmartPointer<vtkImageData> VTKImageDataPointerType;
+	 *	@brief Defines the pointer of vtkImageDate type.
+	 */
 	typedef vtkSmartPointer<vtkImageData> VTKImageDataPointerType;
+	// ----------------------------------------------------------------------------------
+	/*!	@typedef std::string StringType;
+	 *	@brief Redefinition of the string type.
+	 */
 	typedef std::string StringType;
+	// ----------------------------------------------------------------------------------
+	/*!	@typedef ImageMManager ImageMManagerType;
+	 *	@brief Definition of the ImageMManager type.
+	 */
 	typedef ImageMManager ImageMManagerType;
+	// ----------------------------------------------------------------------------------
 public:
+	// ----------------------------------------------------------------------------------
+	/*! @fn ImageDequeUR();
+	 * @brief This is the default constructor.
+	 */
 	ImageDequeUR();
+	// ----------------------------------------------------------------------------------
+	/*! @fn virtual ~ImageDequeUR();
+	 * @brief This is the destructor.
+	 */
 	virtual ~ImageDequeUR();
-	virtual void AddImageToUndoContainer(VTKImageDataPointerType img,
-			ImageMManager* imMManager);
-	virtual void AddImageToRedoContainer(VTKImageDataPointerType img,
-			ImageMManager* imMManager);
-	virtual void CleanUndoContainerFromIndex(const int& index);
-	virtual void CleanRedoContainerFromIndex(const int& index);
-	virtual void CleanContainers();
+	// ----------------------------------------------------------------------------------
+	/*! @fn virtual void AddImagesToURContainer(VTKImageDataPointerType imgUndo,
+	 VTKImageDataPointerType imgRedo, ImageMManager* imMManager);
+	 * @brief This method adds the images for undo and redo in a container
+	 * @param imgUndo The undoImage cropped.
+	 * @param imgRedo The redoImage cropped.
+	 * @param imManager The image manager.
+	 */
+	virtual void AddImagesToURContainer(VTKImageDataPointerType imgUndo,
+			VTKImageDataPointerType imgRedo, ImageMManager* imMManager);
+	// ----------------------------------------------------------------------------------
+	/*! @fn virtual void CleanURContainerFromIndex(const int& index);
+	 * @brief This method allows to clean the container from a given index.
+	 * @param index The index.
+	 */
+	virtual void CleanURContainerFromIndex(const int& index);
+	// ----------------------------------------------------------------------------------
+	/*! @fn virtual void ManageMemory();
+	 * @brief This method cleans the memory.
+	 * @details This method cleans the principal memory when the images are not in use.
+	 */
 	virtual void ManageMemory();
+	// ----------------------------------------------------------------------------------
+	/*! @fn virtual ImageInfoUR* Undo();
+	 * @brief This method is the undo action.
+	 * @return
+	 */
 	virtual ImageInfoUR* Undo();
+	// ----------------------------------------------------------------------------------
+	/*! @fn virtual ImageInfoUR* Redo();
+	 * @brief This method is the redo action.
+	 * @return
+	 */
 	virtual ImageInfoUR* Redo();
+	// ----------------------------------------------------------------------------------
+	/*! @fn void SetGlobalPath(const StringType& globalPath);
+	 * @brief This method sets the global path where the temporary files will be stored.
+	 * @param globalPath The String with the path.
+	 */
 };
 
 #endif /* IMAGEDEQUE_H_ */