DoxyDoc.

[z.facultad/75.52/treemulator.git] / src / clave.h

diff --git a/src/clave.h b/src/clave.h
index 81e24dbe594ff01027d6631cd6a8011ebdaaee56..e609bb02d37797d22556b25b83a52c4a2d1566c0 100644 (file)
--- a/src/clave.h
+++ b/src/clave.h
@@ -6,12 +6,20 @@
 #include "common.h"
 #include <string>
 
 #include "common.h"
 #include <string>
 

+/** Clave abstracta para manejo de Claves */

 class Clave {
        public:
                virtual ~Clave () {}
 
 class Clave {
        public:
                virtual ~Clave () {}
 

+               /** Retorna el tamaño en bytes que ocupa la clave */

                virtual uint Size () const = 0;
                virtual uint Size () const = 0;

+               /** Retorna un array de bytes de Size() de longitud.
+                * 
+                *  El contenido del array es la clave en formato RAW
+                *  para guardar en disco.
+                */

                virtual uchar *ToArray () const = 0;
                virtual uchar *ToArray () const = 0;

+               /** Retorna un clon de la clave actual */

                virtual Clave *Clone () const = 0;
 
                virtual bool operator < (const Clave &k) const = 0;
                virtual Clave *Clone () const = 0;
 
                virtual bool operator < (const Clave &k) const = 0;