0% encontró este documento útil (0 votos)

14 vistas

MANUAL DEL PROGRAMADOR POLI

El manual del programador para el software HidroSmart proporciona una guía detallada sobre la arquitectura y los módulos de la aplicación, diseñada para la gestión eficiente del consumo de agua en Bogotá. Incluye información sobre la interfaz gráfica, el núcleo del sistema y la conexión entre módulos, así como instrucciones para la instalación del software. Está dirigido a desarrolladores de diferentes niveles de experiencia, facilitando el aprendizaje y la implementación del proyecto.

Cargado por

CALDERÓN GIRALDO DAVID SANTIAGO

Derechos de autor

Nos tomamos en serio los derechos de los contenidos. Si sospechas que se trata de tu contenido, reclámalo aquí.

Formatos disponibles

Descarga como DOCX, PDF, TXT o lee en línea desde Scribd

0% encontró este documento útil (0 votos)

14 vistas

MANUAL DEL PROGRAMADOR POLI

Cargado por

CALDERÓN GIRALDO DAVID SANTIAGO

Derechos de autor

Nos tomamos en serio los derechos de los contenidos. Si sospechas que se trata de tu contenido, reclámalo aquí.

Formatos disponibles

Descarga como DOCX, PDF, TXT o lee en línea desde Scribd

Está en la página 1/ 15

MANUAL DEL

PROGRAMADOR
2024

DATE \@ "d MMMM" \* MERGEFORMAT 18

noviembre

“HIDROSMART”: PROPUESTA DE SOFTWARE PARA GESTIÓN EFICIENTE DEL C

Creado por: David Santiago Calderon Giraldo

1
“HIDROSMART”: PROPUESTA DE SOFTWARE
PARA GESTIÓN EFICIENTE DEL CONSUMO DE
AGUA EN BOGOTÁ
“Hidrosmart”: Software proposal for efficient management of water
consumption in Bogotá

TABLA DE CONTENIDO

1. INTRODUCCIÓN………………………………………………………………………1
1.1 Objetivo…………………………………………………………………………1
1.2 Alcance del documento………………………………………………….1
2. ARQUITECTURA DE LA APLICACIÓN………………………………………..1
2
2.1 Módulo de Interfaz gráfica de usuario o vista…………………1
2.2 Módulo de Núcleo………………………………………………………….1
2.3 Módulo de Conexión………………………………………………………1
3. ASPECTOS DE DISEÑO E IMPLEMENTACIÓN DEL PROYECTO….…1
3.1 Implementación módulo interfaz gráfica………………………..1
3.2 Implementación módulo núcleo………………………………….….1
3.2.1 Paquete clases………………………………………………………1
4. INSTALACIÓN DE LA APLICACIÓN……………………………………………..1
4.1 Instalación JAVA……………………………………………………………..1
4.2 Instalación aplicaciones adicionales para el programa…….1

1. INTRODUCCIÓN

Este texto sirve como una orientación detallada para los desarrolladores de
la aplicación HidroSmart, enfocándose en su arquitectura y las clases que la
componen. El manual está estructurado en varios capítulos principales, que
incluyen: Descripción general del sistema, Arquitectura, y Aspectos de
diseño e implementación.

3
1.1 OBJETIVO

El propósito de este manual es proporcionar una referencia clara y

práctica sobre la arquitectura de la herramienta, dirigida a
programadores con distintos niveles de experiencia. Para aquellos
con poca o ninguna experiencia, este documento actúa como una
guía inicial que facilita el aprendizaje y el desarrollo de habilidades
necesarias para contribuir al proyecto. Por otro lado, los
programadores más experimentados pueden usarlo como un
recurso de consulta rápida y estructurada, asegurando la correcta
comprensión y mantenimiento de la herramienta.

1.2 ALCANCE DEL DOCUMENTO

El alcance de este manual se centra en los desarrolladores del

sistema HidroSmart, una plataforma diseñada para el monitoreo y
gestión eficiente del agua en los hogares de las principales
localidades de Bogotá. Aquí se detalla de manera exhaustiva la
arquitectura de la aplicación, junto con los aspectos fundamentales
de diseño e implementación, proporcionando así una visión
completa que permitirá a los programadores entender y trabajar
eficientemente con la herramienta.

2. ARQUITECTURA DE HIDROSMART

4
2.1 Módulo de Interfaz gráfica de usuario o vista

Este módulo es la herramienta que por medio de la visualización de

imágenes y objetos, permite al usuario hacer uso de la herramienta
para realizar consultas relacionadas con el consumo del agua del
hogar, además es importante ofrecer una interfaz gráfica amigable
con el usuario, ofreciéndole facilidad en el momento de realizar el
formulario. Así este módulo da soporte gráfico a todos los demás
módulos que lo requieran, estableciendo una conexión con los
demás ofreciendo una interfaz gráfica estructurada para cada
JFrame utilizado.

2.2 Módulo de Núcleo

5
A este módulo lo componen los paquetes de gran relevancia del
proyecto, aquí se encuentran los algoritmos de búsqueda de
información, de procesamiento de información, de presentación de
resultados, procesos de gestión de información tanto el consumo
promedio diario y mensual de agua así como también el registro del
usuario con su respectiva localidad. Como su nombre lo indica, este
módulo es el núcleo de la herramienta de consulta y por tal motivo
en él se albergan los paquetes que permiten el correcto
funcionamiento de la herramienta. A continuación, se describen los
submódulos que componen al módulo:

Paquete de clases:

Este submódulo incluye las clases que modelan tanto la recolección

como la conversión de los datos, los cuales serán utilizados para
calcular los promedios de consumo y determinar si el hogar está
haciendo uso eficiente del agua. Esto proporciona una estructura
clara y lógica en la representación de los datos a través de las clases.
Es importante destacar que este submódulo constituye la base del
conocimiento en las clases del modelo y mantiene una relación con
el resto de paquetes.

Información del usuario:

En este submódulo se hace el registro del usuario con el nombre y la

localidad, esto es importante para determinar que fuente hídrica
usa el hogar del usuario y mostrar el estado actual de la misma.
Además, puede ser útil para una eventual actualización de la
aplicación, agregando una base de datos con las respuestas de cada
usuario registrado.

6
2.3 Módulo de Conexión

Este módulo es el encargado de realizar la respectiva conexión entre

los distintos JFrames, el cual prioriza que los datos se almacenes
correctamente. Con la implementación de este módulo se pretende
dar respuestas eficientes y eficaces a los diferentes datos ingresadas
por el usuario. Se conecta con el siguiente elemento:

Método “setDatos ()”:

Este método es el encargado de que en cada JFrame del formulario

se almacene la respuesta de cada pregunta y se envié las respuestas
al siguiente JFrame .

Ejemplo (Pregunta 1 y 2):

En este caso, el JFrame toma los datos de registro (Nombre y

Localidad) enviado por el menú y manda los mismos junto a la
respuesta p1 y p2 al siguiente JFrame.

7
3. ASPECTOS DE DISEÑO E IMPLEMENTACIÓN DEL PROYECTO

Para la implementación se utilizó lenguaje Java en Apache NetBeans, y

usando la herramienta JFrame se implementó toda la interfaz grafica
junto con la lógica para sacar promedios.

3.1 Implementación módulo interfaz gráfica

La interfaz se compone principalmente del menú, y un JFrame base

en cual es utilizado como plantilla para los demás
(DatosCompartidos.java).

3.2 Implementación módulo núcleo

El modulo núcleo se encuentra principalmente en el JFrame

“resultados.java”, el cual toma todos los datos y hace los cálculos
para sacar los promedios.

8
JFrame (resumen.java):

En este se toman los datos del método “setDatos” recolectados de

los JFrames anteriores y se imprimen en la interfaz para que el
usuario vea sus respuestas registradas.

JFrame (resultados.java):

En ese JFrame es donde ocurren todos los cálculos matemáticos

para sacar los promedios de consumo.

9
Métodos “Convertir respuestas”

Ya que al registrar las respuestas se guardan mediante texto, estos

métodos ayudan a convertir dichas respuestas en un valor con el
cual se pueden hacer operaciones.

Un ejemplo de este método es el siguiente:

10
El método convierte en un valor entero cada respuesta que se
encuentra en dicha pregunta, en este caso, la pregunta es sobre el
tiempo promedio en la ducha, y el método transforma la respuesta
al equivalente en litros.

3.2.1 Paquete clases

En este paquete de clases están todas y cada una de las clases que
representan la aplicación junto a la lógica para el correcto
funcionamiento:

11
El JFrame “Menu” es el primero en iniciarse (el Main) y la aplicación
va por cada una de las preguntas que se encuentran en los JFrames
P1, P2, P3 para posteriormente mostrar el resumen y por último los
resultados con todas las respuestas convertidas a un valor
numérico.

4. INSTALACIÓN DE LA APLICACIÓN

Para el correcto funcionamiento de la aplicación es necesario lo

12
4.1 Instalación JAVA

Para la aplicación se utilizó JDK 23, que se descarga por medio de la

página de “ORACLE”, el JDK es necesario para cualquier aplicación
que use lenguaje java.

Link:
https://www.oracle.com/java/technologies/downloads/#jdk23-
windows

4.2 Instalación aplicaciones adicionales para el programa

Para abrir el archivo “HidroSmart.zip” se debe hacer mediante

Apache NetBeans IDE 23, se puede descargar mediante la página
oficial de NetBeans, importante que sea la versión IDE 23 ya que
una versión diferente pude generar incompatibilidad.

Link:

https://netbeans.apache.org/front/main/index.html

13
14
15