Se completa un poco mas el manual del proyecto.

[z.facultad/75.42/plaqui.git] / Constructor / include / workplace.h

diff --git a/Constructor/include/workplace.h b/Constructor/include/workplace.h
index 2bb065318914f57221a27a0d2a582299affbe941..908a2311b210f569fe7d20635ec0e87089c6e100 100644 (file)
--- a/Constructor/include/workplace.h
+++ b/Constructor/include/workplace.h
@@ -6,22 +6,100 @@
 #include <gtkmm.h>
 #include <libglademm.h>
 
+
+///Indico que la clase CItem existe para poder compilar.
+class CItem;
+
+//Indico que la clase CItem existe para poder compilar.
 class CItem;
 
+/**Esta estructura define una linea entre un item logico y uno de transporte,
+  *tambien indica cual de las dos salidas del tanque esta conectada.
+  */
 typedef struct {
-       CItem *logic, *store;
+       int logic_id, store_id;
+       bool cistern_out1;
 }t_line;
 
+
+/**
+ * Area de trabajo.
+ * Ella se encarga de eliminar los items y dibujar las lineas logicas que los
+ * conectan.
+ * Esta clase es la encarga de de manejar el Area trabajo.
+ * Deriva de Gtk::DrawingArea pues es donde se van a
+ * dibujar todos los elementos. Una de sus principales
+ * tareas es redibujarse cuando sea necesario y al mismo
+ * tiempo, redibujar los elementos que contiene, como
+ * pueden ser los items de la planta o las lineas logicas
+ * que conectan los mismos.
+ *
+ * Para lograr esto, se ha redefinido el metodo virtual
+ * (contenido en la clase ancestro) on_expose_event() de
+ * manera conveniente.
+ *
+ * Tambien se encarga de eliminar correctamente un item, 
+ * eliminando al mismo tiempo las lineas que llegan o 
+ * salen de el.
+ */
 class WorkPlace:public Gtk::Fixed {
        public:
+               ///Constructor.
                WorkPlace(BaseObjectType* cobject, const Glib::RefPtr<Gnome::Glade::Xml> &refGlade);
+       
+               /// Destructor.
                virtual ~WorkPlace();
+
+               /// Funcion que se ejecuta cuando se crea la ventana
+               virtual void on_realize();
+
+               ///Esta funcion es llamada cada vez que el area de trabajo se tenga que redibujar.
                virtual bool on_expose_event(GdkEventExpose *event);
+       
+               ///Borra el item con ID == _id.
                void delete_item(int _id);
+       
+               ///Borra las lineas que esten conectadas con el item de ID == _id.
                void delete_line(int _id);      
+       
+               ///Devuelve un puntero al item logico cuyo ID es _id.   
                CItem *get_logic_item(int _id);
+       
+               ///Devuelve un puntero al item  de transporte _id.              
+               CItem *get_item(int _id);
+
+               int get_item_id(const std::string &s);
+               int get_logic_id(const std::string &s);
+       
+               ///Actualiza las posiciones de los conectores logicos.
+               void update_logic_position();
+               
+               ///Punteros a las listas de items.
                std::list<CItem *> *listaItems, *lista_logic_Items;
-               std::list<t_line> lista_lineas;
+               
+               ///Verifica si hay nombres repetidos.
+               virtual bool chek_name(Glib::ustring _name, int _id);
+               
+               /** Listas de lineas que van de una compuerta a la entrada de un item y de la salida de un item a una compuerta
+                  * lista_lineas_in = (salida) compuerta --> (entrada) item
+                  * lista_lineas_out= (entrada) compuerta --> (salida) item
+                  * lista_lineas_logic = (salida) compuerta --> (entrada) compuerta.
+                  * Esta ultima lista contiene las lineas que van desde la compuerta seleccionada que se guarda CItem::en gate_id hasta
+                  * la compuerta clickeada en segundo termino.
+               */
+               std::list<t_line> lista_lineas_in, lista_lineas_out, lista_lineas_logic;
+               
+               /**Variable global que identifica cual item logico fue apuntado para
+                 *conectarlo mediante una linea a un item de transporte
+                 */
+               static int pointed;
+               
+               ///Estado de diseño
+               bool *logica;
+       protected:
+               void draw_line(int x1, int y1, int x2, int y2, Gdk::Color &color);
+               Gdk::Color color_in, color_out, color_dot;
+               Glib::RefPtr<Gdk::GC> gc;
 };
 
 #endif