ATAC - Manual del desarrollador Pág. 2 de 8

Transcripción

1

2 ATAC - Manual del desarrollador Pág. 2 de 8 Contenido Contenido... 1 Contenido... 2 Referencias... 3 Introducción... 3 Comentarios... 4 Descripción de clases... 4 Descripción de métodos... 4 Descripción de atributos... 4 Organización del proyecto Ideas generales... 5 Filtros GUI, Estructura Vial, Ejecución y RdP... 5 Organización vertical - Capas GUI-RdP-Ejecución RdP... 6 Instalación de herramientas utilizadas... 7 Visual Studio 2008 Express edition... 7 MySQL... 7 Doxygen... 7 Jarp... 7 SVN... 7 Diseño... 7 Actualizaciones del Sistema... 8 Control de Cambios... 8 Actualización del código... 8 Actualización de la documentación... 8

3 ATAC - Manual del desarrollador Pág. 3 de 8 Referencias [R1] Diseño detallado RDP.doc. Introducción Este manual introduce al desarrollador en la comprensión del funcionamiento interno del sistema. Junto con este manual se proveen todas las herramientas utilizadas durante el proceso de desarrollo. Esto significa que usando este manual como guía, cualquier desarrollador con conocimiento del lenguaje C++ (generalizando aún más, con conocimiento de los conceptos de orientación a objetos) podría adicionar funcionalidades con relativamente poco esfuerzo. Se utilizó el entorno de desarrollo Visual Studio 2008 Express y el motor de Base de Datos MySQL. Ambos poseen comunidades de desarrollo activas, lo que provee una amplia variedad de recursos a la hora de resolver problemas o responder preguntas. El objetivo de todo desarrollo en equipo es escribir código entendible para los demás integrantes. Para esto fue de primordial importancia escribir comentarios a las clases, atributos y métodos.

4 ATAC - Manual del desarrollador Pág. 4 de 8 Comentarios Los comentarios son necesarios para generar automáticamente la ayuda del código utilizando doxygen *. El archivo atac.cfg contiene la configuración usada por el programa para crear la documentación. Los comentarios de las clases deberán ser colocados en los encabezados de las clases, de extensión.h. Además deberán respetar el formato descrito a continuación. Descripción de clases /** * Una explicación de para qué sirve la clase. Puede contener referencias a * <code>codigo</code>. * Esto es <em>cursiva</em> y esto <b>negrita</b>. * Esto es un <a href=" a un ticket</a>. * <p> * Esto es un párrafo. * </p> * <pre> * esto.un.metodo(con-parametro); * </pre> * La siguiente línea estará encabezada por see also (automáticamente) Clase */ Descripción de métodos /** * Para qué sirve el método. La relación con otros métodos o clases. algo Qué representa el parámetro algo Qué representa el valor de retorno */ Descripción de atributos /** * La utilidad del atributo. Su relacion con otras partes de la clase. * Clase */ * Doxygen es un programa gratuito que permite documentar código en variados formatos. Permite documentar código de muchos lenguajes y paradigmas. Para más información véase

5 ATAC - Manual del desarrollador Pág. 5 de 8 Organización del proyecto Ideas generales En este documento se describirán cada uno de los filtros. Los diagramas de clase correspondientes se pueden consultar en [R1] que se encuentra en el CD. Filtros GUI, Estructura Vial, Ejecución y RdP Los filtros en el entorno de desarrollo Visual Studio 2008 permiten organizar el proyecto dentro del IDE. Sin embargo no existe relación entre esta organización jerárquica y la estructura de carpetas en donde los archivos son almacenados. Debido a que la unidad mínima y autocontenida de código es la clase, decidimos que cada archivo con extensión.cpp represente una clase, y cada.h su información de cabecera. Excepciones a esta regla son el archivo constantes.h (con contenido auto descrito en su nombre), SoporteManejoHerramientas.h que contiene utilidades de la capa grafica y SoporteModificacionSentidos.h, con estructuras en la forma de clases. El filtro GUI contiene contiene todos los elementos usados por la capa gráfica. Los formularios no se pueden añadir a ningún filtro, por lo que fueron colocados en el raiz del proyecto ATAC. El filtro Estructura Vial contienen todas las clases que permiten crear una estructura vial real. El controlador ControladorEstructuraVial se encarga de convertir los datos almacenados en la base de datos en las clases de este filtro. RdP es el filtro que contiene las clases Transicion y Lugar, además de especializaciones de estas clases, una jerarquía de clases encabezada por la clase CreadorLugaresVecinos (de utilidad auxiliar en la creación de la RdP) y ControladorRdP. Esta clase permite la conexión con las clases del filtro anterior y almacena un arreglo de CarrilLugares. Esta última clase es el pilar fundamental a la hora de la creación de la RdP. El filtro Ejecución contiene al controlador que hace evolucionar a la RdP. Para una explicación exhaustiva del funcionamiento de estas clases véase [R1].

6 ATAC - Manual del desarrollador Pág. 6 de 8 Organización vertical - Capas GUI-RdP-Ejecución RdP Observando el proyecto como componentes de diferentes funcionalidades, podemos dividir el proyecto en GUI, RdP y Ejecución RdP. Como contexto de estos tres ccomponentes se encuentra el Usuario final.. Proyecto dividido en componentes con funciones distintas

7 ATAC - Manual del desarrollador Pág. 7 de 8 Instalación de herramientas utilizadas Este manual se acompaña de un CD de instalación. En el CD se encuentran todas las herramientas utilizadas para desarrollar el sistema ATAC. En el directorio \Herramientas\ se pueden encontrar todas las herramientas que se describen a continuación. Visual Studio 2008 Express edition \Herramientas\Visual Studio 2008 Este directorio contiene el instalador de la versión Express de Visual Studio. Su instalación requiere de conexión a Internet. MySQL \Herramientas\MySQL Este directorio contiene el instalador del motor de base de datos que utilizamos: MySQL. Doxygen \Herramientas\Doxygen En este directorio se encuentra el instalador del programa de creación de documentación. (atac.cfg es el arcivo que contienene la última configuración usada.) Jarp \Herramientas\Jarp Esta herramienta permite analizar la RdP creada por el programa y accesible en el archivo RdP.pnml SVN \Herramientas\SVN Este directorio contiene el cliente SVN para las actualizaciones del software. Como cliente SVN utilizamos el Tortoise SVN. Diseño \Herramientas\Diseño En este directorio se encuentra el instalador de la herramienta que utilizamos para administrar la base de datos MySQL GUI Tools. También una referencia a la herramienta que utilizamos para documentar la implementación del sistema. Entreprise Architect. Se puede obtener una versión accediendo a:

8 ATAC - Manual del desarrollador Pág. 8 de 8 Actualizaciones del Sistema Para facilitar el trabajo entre distintos desarrolladores se utilizó Assembla para el control de versiones del software. Assembla proporciona un servidor SVN para control de versiones y un servidor para control y registro de cambios. Cada desarrollador dispone de un usuario y una clave de acceso para acceder al servidor, obtener versiones del software y/o actualizar nuevas versiones. También para registrar cambios y bugs. Para más detalle se puede visitar el sitio Control de Cambios Para el control de cambios utilizamos Tickets. Se denominan tickets a tareas a desarrollar o bugs a corregir en el software. Cada ticket posee una prioridad y está asociado a un hito dentro del proyecto. Cada desarrollador puede asignarse un ticket, con lo cual indica la tarea que está desarrollando. Actualización del código Para el control de versiones utilizamos un servidor SVN también proporcionado por assembla. Para actualizar una versión, cada desarrollador actualiza su versión local, la modifica y luego la actualiza en el servidor SVN utilizando por ejemplo el cliente TortoiseSVN. En caso de conflicto entre archivos (2 desarrolladores han actualizado el mismo archivo) el último en actualizar deberá sincronizar los cambios para luego actualizar la versión de software del servidor. Es necesario que la versión de software a actualizar compile. No se deben actualizar versiones con errores de compilación. Actualización de la documentación La documentación se ha realizado con la herramienta Enterprise Architect. Dicha herramienta proporciona mecanismos para sincronizar la documentación con el código fuente. Una vez liberada una versión estable se deberá sincronizar la documentación.