Constructor/include/documentacion.h

   1 /** \page page_constructor PlaQui Constructor.
   2
   3 \section page_constructor_general Descripción general.
   4         El constructor se basa en la clase Constructor, que es la ventana principal. En
   5         ella se realizan las tareas más importantes como el
   6         \ref Constructor::check_connection "chequeo de las conexiones" que
   7         \ref CItem::check_connection "verifica que cada ítem esté bien connectado"
   8         para que el flujo entre los elementos de la planta sea correcto.
   9         Otra clase importante es WorkPlace, que se encarga de dibujar todos los elementos
  10         las conexiones lógicas entre ellos.
  11
  12 \section page_constructor_formato_xml Formato del archivo de planta.
  13         El archivo que guarda el Constructor es un archvo de texto con formato XML.
  14         El archivo comienza con el tag <tt>planata</tt> y en él contiene una
  15         cantidad indefinida de elementos.
  16         Cada elemento se guarda de forma diferente dentro del tag <tt>planta</tt>.
  17         - \ref Conduct "Tubo":
  18                 \verbinclude tubo.xml
  19         - \ref Conduct "Codo":
  20                 \verbinclude codo.xml
  21         - Empalme (\ref Union "unión" o \ref Splitter "división"):
  22                 \verbinclude empalme.xml
  23         - \ref Pump "Bomba":
  24                 \verbinclude bomba.xml
  25         - \ref Cistern "Tanque":
  26                 \verbinclude tanque.xml
  27         - Exclusa:
  28                 \verbinclude exclusa.xml
  29         - \ref Drain "Drenaje":
  30                 \verbinclude drenaje.xml
  31         - And:
  32                 \verbinclude and.xml
  33         - Or:
  34                 \verbinclude or.xml
  35         - Not:
  36                 \verbinclude not.xml
  37
  38 */
  39