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

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/image3DDequeUR.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/image3DDequeUR.h
index cdcdefb..86a6473 100755
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/image3DDequeUR.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/image3DDequeUR.h
@@ -1,8 +1,9 @@
-/*
- * image3DDequeUR.h
- *
- *  Created on: Sep 26, 2011
- *      Author: caceres
+/*!
+ * @file	image3DDequeUR.h
+ * @brief	This file contains the Image3DDequeUR class.
+ * @author 	Info-Dev
+ * @author	Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
+ * @date 	2011-11-15
  */
 
 #ifndef IMAGE3DDEQUEUR_H_
@@ -11,30 +12,94 @@
 #include "imageDequeUR.h"
 #include <ctime>
 
+/*! @class Image3DDequeUR image3DDequeUR.h "image3DDequeUR.cxx"
+ *	@brief This class contains the management of the undo/redo deque - Concrete Class
+ *  @details This class derives from ImageDequeUR.
+ */
 class Image3DDequeUR: public ImageDequeUR {
 public:
+	//typedef definition
+	// ----------------------------------------------------------------------------------
+	/*!	@typedef std::deque<ImageInfoUR*> ImageInfoDeque;
+	 *	@brief Defines the deque of ImageInfoUR for the undo/redo.
+	 */
+	typedef std::deque<ImageInfoUR*> ImageInfoDeque;
+	// ----------------------------------------------------------------------------------
+public:
+	// ----------------------------------------------------------------------------------
+	/*! @fn Image3DDequeUR();
+	 * @brief This is the default constructor.
+	 */
 	Image3DDequeUR();
+	// ----------------------------------------------------------------------------------
+	/*! @fn virtual ~Image3DDequeUR();
+	 * @brief This is the destructor.
+	 */
 	virtual ~Image3DDequeUR();
-	void SetGlobalPath(const StringType& globalPath);
-	StringType GetGlobalPath();
-	StringType GetImageName(const int & pos, const bool& undo);
-	virtual void AddImageToUndoContainer(VTKImageDataPointerType img,
-			ImageMManagerType* imMManager);
-	virtual void AddImageToRedoContainer(VTKImageDataPointerType img,
-			ImageMManagerType* 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.
+	 */
+	void SetGlobalPath(const StringType& globalPath);
+	// ----------------------------------------------------------------------------------
+	/*! @fn StringType GetGlobalPath();
+	 * @brief This method returns a String with the global path.
+	 * @return
+	 */
+	StringType GetGlobalPath();
+	// ----------------------------------------------------------------------------------
+	/*! @fn StringType GetImageName(const int & pos);
+	 * @brief This method returns a String with an image name which won't be repeated.
+	 * @param pos The position of the container to manage a sequence.
+	 * @return
+	 */
+	StringType GetImageName(const int & pos);
+	// ----------------------------------------------------------------------------------
+	/*! @fn void CleanHardDisk();
+	 * @brief This method cleans the hard disk of the temporary files.
+	 */
+	void CleanHardDisk();
+	// ----------------------------------------------------------------------------------
 protected:
-	ImageInfoDeque m_ImgUndoDeque;
-	ImageInfoDeque m_ImgRedoDeque;
-	int m_CurrentUndoPos;
-	int m_CurrentRedoPos;
-	StringType m_GlobalPath;
-	StringType m_IDImages;
+	ImageInfoDeque m_ImgURDeque; //!<This is the container of the images for undo and redo.
+	int m_CurrentURPos; //!<This is the index where is located the undo and redo state.
+	StringType m_GlobalPath; //!<This is the string with the global path.
+	StringType m_IDImages; //!<This is the string with the ID of the images (For the filenames).
 };
 
 #endif /* IMAGE3DDEQUEUR_H_ */