Documentación sobre las operaciones básicas.

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

diff --git a/src/clave.h b/src/clave.h
index be75a7ce90fd699ed9efc46f9a3a8bc3d2fb19eb..c0f3a3040145e24764cd390b200dac7cae8d5a7e 100644 (file)
--- a/src/clave.h
+++ b/src/clave.h
@@ -2,16 +2,32 @@
 #ifndef _CLAVE_H_
 #define _CLAVE_H_
 
-/* Clave para agregar a un arbol B */
 #include "common.h"
+#include <string>
 
+/** Clase abstracta para manejo de Claves */
 class Clave {
        public:
                virtual ~Clave () {}
 
+               /** Retorna el tamaño en bytes que ocupa la clave */
                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.
+                *
+                *  El array debe ser liberado por el llamador.
+                */
                virtual uchar *ToArray () const = 0;
+               virtual uchar *ToRaw (uint &size) const = 0;
+
+               /** Retorna un clon de la clave actual */
                virtual Clave *Clone () const = 0;
+
+               virtual bool operator < (const Clave &k) const = 0;
+               virtual bool operator == (const Clave &k) const = 0;
+               virtual operator std::string () const = 0;
 };
 
 #endif