]> git.llucax.com Git - z.facultad/75.42/plaqui.git/commitdiff
Subo documentacion del Constructor que me habia olvidado.
authorLeandro Lucarella <llucax@gmail.com>
Tue, 2 Dec 2003 02:22:52 +0000 (02:22 +0000)
committerLeandro Lucarella <llucax@gmail.com>
Tue, 2 Dec 2003 02:22:52 +0000 (02:22 +0000)
Constructor/include/documentacion.h [new file with mode: 0644]

diff --git a/Constructor/include/documentacion.h b/Constructor/include/documentacion.h
new file mode 100644 (file)
index 0000000..cf42e63
--- /dev/null
@@ -0,0 +1,39 @@
+/** \page page_constructor PlaQui Constructor.
+
+\section page_constructor_general Descripción general.
+       El constructor se basa en la clase Constructor, que es la ventana principal. En
+       ella se realizan las tareas más importantes como el
+       \ref Constructor::check_connection "chequeo de las conexiones" que
+       \ref CItem::check_connection "verifica que cada ítem esté bien connectado"
+       para que el flujo entre los elementos de la planta sea correcto.
+       Otra clase importante es WorkPlace, que se encarga de dibujar todos los elementos
+       las conexiones lógicas entre ellos.
+
+\section page_constructor_formato_xml Formato del archivo de planta.
+       El archivo que guarda el Constructor es un archvo de texto con formato XML.
+       El archivo comienza con el tag <tt>planata</tt> y en él contiene una
+       cantidad indefinida de elementos.
+       Cada elemento se guarda de forma diferente dentro del tag <tt>planta</tt>.
+       - \ref Conduct "Tubo":
+               \verbinclude tubo.xml
+       - \ref Conduct "Codo":
+               \verbinclude codo.xml
+       - Empalme (\ref Union "unión" o \ref Splitter "división"):
+               \verbinclude empalme.xml
+       - \ref Pump Bomba:
+               \verbinclude bomba.xml
+       - \ref Cistern "Tanque":
+               \verbinclude tanque.xml
+       - Exclusa:
+               \verbinclude exclusa.xml
+       - \ref Drain "Drenaje":
+               \verbinclude drenaje.xml
+       - And:
+               \verbinclude and.xml
+       - Or:
+               \verbinclude or.xml
+       - Not:
+               \verbinclude not.xml
+
+*/
+