RPG (Generador de Reportes en MATLAB)

JULIO 14, 2015

MATLAB REPORT GENERATOR RPG

EPN FIEE Quito - Ecuador

Indice I. Introduccion ......................................................................................................................................................................... 2 II. Objetivos .............................................................................................................................................................................. 2 III. CARACTERÍSTICAS ...................................................................................................................................................... 2 IV. ejecucion de comandos ..................................................................................................................................................... 3 A. Crear Informes ................................................................................................................................................................. 3 B. Generar Informes ............................................................................................................................................................. 3 C. Personalizar componentes de información ........................................................................................................................ 3 D. Creación de Informes Programáticos ................................................................................................................................ 3 E. Fundamentos de Formato de Informe ............................................................................................................................... 4 F. Crear Reportes basados en Forma ..................................................................................................................................... 4 G. Crear informes orientados a Objetos ................................................................................................................................. 4 V. Creacion de comandos .......................................................................................................................................................... 4 VI. Generacion de documentos ............................................................................................................................................... 5 VII. Ejemplo ............................................................................................................................................................................ 6

RPG Report Program Generator Carlos Chávez (Autor)

Cristian Amaguaña (Autor)

Escuela Politécnica Nacional Quito, Ecuador [email protected]

Escuela Politécnica Nacional Quito, Ecuador [email protected]

I. INTRODUCCION MATLAB Report Generator1 permite crear informes en formato de Microsoft Word, HTML o PDF los cuales presentan los resultados de sus programas de MATLAB y sus aplicaciones. Se puede utilizar los plantillas prediseñadas de Word y HTML, las mismas que son personalizables para diseñar informes con este formato. También se puede diseñar y crear informes basados en plantillas y normas de su organización, es decir plantillas personalizadas por el usuario. MATLAB Report Generator captura automáticamente los resultados y las cifras a través de múltiples funciones de MATLAB y los presenta en un solo informe. Esta muy útil herramienta que brinda MATLAB a sus usuarios interactúa con el usuario de forma simple ya que gracias a su interfaz gráfica se nos permite realizar acciones de formato y edición tal como si fuera un programa que hemos utilizado en el pasado. La interfaz de Matlab RPG puede ser llama desde el workspace de Matlab simplemente escribiendo la palabra en inglés: “report” y aparecerá la siguiente ventana:

Karen Paguanquiza (Autor) Escuela Politécnica Nacional Quito, Ecuador [email protected]

En esta ventana se puede ver las opciones que nos da el Matlab RPG, tales como crear, abrir, etc. La extensión que manejan los archivos de reporte es .rpt de report. Al igual que en otros lenguajes de programación; la documentación de código es indispensable para transmitir las ideas del programador hacia otro programador o simplemente hacia un usuario. Se puede decir que RGP de Matlab es el equivalente, por tomar un ejemplo, al JavaDoc del lenguaje de programación Java. Como sabemos al ver un reporte escrito y detallado es mucho más amigable al usuario y obviamente enteramente comprensible, es por eso que se ha creado este paquete de Matlab. II. OBJETIVOS 





Conocer el significado, uso y aplicación del RPG y aprender sobre el modo en que éste genera reportes en Matlab. Extraer los contenidos más valiosos sobre la investigación de RPG y realizar una explicación consistente y entendible del mismo. Demostrar con un ejemplo y ayuda visual el modo de operación de RPG implementado en Matlab. III. CARACTERÍSTICAS • El MATLAB Report Generator documenta automáticamente las tareas que se realizan en MATLAB, tales como el análisis y la visualización de datos y el desarrollo de algoritmos. • Se le permite ejecutar código MATLAB y capturar los gráficos y datos a medida que se producen.

Figura 1. Ventana”Report Explorer”

1. 2.

Se refiere también a las siglas RPG de Matlab. Lenguaje de programación imperativo diseñado para ingeniería.

• Puede utilizar las plantillas prediseñadas o crear una plantilla que incorpora sus propios estilos y normas.

• El MATLAB Report Generator facilita el intercambio de información y ayuda a mantener su documentación y especificaciones hasta la fecha con su flujo de trabajo.



• Permite la documentación pulsador de MATLAB



• Documentos funciones de MATLAB y secuencias de comandos y sus resultados, ya que se ejecutan



• Le permite crear y distribuir las plantillas de documentación

 

• Proporciona componentes extensibles y hojas de estilo



• Crea informes en varios formatos de documentación, incluyendo HTML, PDF, RTF, Microsoft Word, y XML • Permite la generación de documentación condicional a través de los componentes de la plantilla lógicas, tales como IF, THEN, ELSE. IV.

    

EJECUCION DE COMANDOS

A. Crear Informes Informe de configuración





rptlist.- Recuperar lista de todos los archivos de configuración del informe en ruta MATLAB



setedit.- Iniciar Explorador de informes

  

Informes de formato 



rptconvert.- Convertir archivos XML DocBook a formatos de documento admitidos



B. Generar Informes  report.- Generar informes de archivo de instalación informe  rptconvert.- Convertir archivos XML DocBook a formatos de documento admitidos



C. Personalizar componentes de información





compwiz.- Crea componentes MATLAB Informe Generator.

personalizados

D. Creación de Informes Programáticos   



mlreportgen.dom.Document.append.- Anexar DOM o MATLAB objeto del contenido del documento. mlreportgen.dom.Paragraph.append.- Anexar al párrafo. mlreportgen.dom.ExternalLink.append.Anexar elemento personalizado para enlace externo.

    

mlreportgen.dom.LinkTarget.append.Anexar contenido vincular objetivo. mlreportgen.dom.Paragraph.clone.Copiar el párrafo objeto. mlreportgen.dom.Document.open.Abrir documento. mlreportgen.dom.Document.close.-Cerrar documento. rptview.- Mostrar informe DOM. mlreportgen.dom.MessageDispatcher.getTheDispatc her.- Volver DOM mensaje despachador. mlreportgen.dom.MessageDispatcher.dispatch.Despacho DOM de mensaje de estado. mlreportgen.dom.Document.createTemplate.- Crear plantilla DOM. zipTemplate.- Paquete DOM HTML plantilla en archivo zip. unzipTemplate.- Descomprimir plantilla DOM. mlreportgen.dom.ProgressMessage.formatAsHTML .- Envolver mensaje en etiquetas en formato HTML. mlreportgen.dom.ProgressMessage.formatAsText.mensaje como texto. mlreportgen.dom.ProgressMessage.passesFilter.Determinar si el mensaje pasa filtro. mlreportgen.dom.Document.package.-Añadir archivos de piezas OPC para documentar paquete. mlreportgen.dom.Document.getCoreProperties.Obtener documento o plantilla propiedades básicas. mlreportgen.dom.Document.setCoreProperties.Añadir OPC de documento de salida o plantilla. mlreportgen.dom.Document.getMainPartPath.Retorno de parte principal del paquete de salida de documentos. mlreportgen.dom.Document.getOPCMainPart.Regreso parte principal del documento, documento de pieza, o plantilla. mlreportgen.dom.Document.getImagePrefix.Obtenga generó nombre de la imagen prefijo. mlreportgen.dom.Document.- Informe documento de definición. mlreportgen.dom.Text.- Objeto Texto. mlreportgen.dom.Paragraph.- Bloque con formato de texto (párrafo). mlreportgen.dom.Heading.- Párrafo de encabezado. mlreportgen.dom.OrderedList.Crear lista ordenada. mlreportgen.dom.UnorderedList.Lista (con viñetas) sin ordenar.

     

       

mlreportgen.dom.ListItem.- Crear elemento de lista ordenada o desordenada. mlreportgen.dom.Table.- Crear una tabla. mlreportgen.dom.FormalTable.- Tabla oficial. mlreportgen.dom.Image.- Crear imagen para ser incluido en el informe. mlreportgen.dom.Group.- Objetos de documento en grupo. mlreportgen.dom.CoreProperties.OPC de documento o plantilla con propiedades fundamentales. mlreportgen.dom.MessageDispatcher.DOM mensaje despachador. mlreportgen.dom.MessageEventData.Sostiene mensaje de evento desencadenante mensaje. mlreportgen.dom.MessageFilter.Filtro para controlar mensaje despachador. mlreportgen.dom.DebugMessage.- Depuración de mensaje. mlreportgen.dom.ErrorMessage.- Mensaje de error. mlreportgen.dom.ProgressMessage.- mensaje de progreso. mlreportgen.dom.WarningMessage.- Mensaje de advertencia. mlreportgen.dom.OPCPart.Documento para incluir en el paquete OPC.

E. Fundamentos de Formato de Informe    

mlreportgen.dom.Document.createTemplate.- Crear plantilla DOM. mlreportgen.dom.Container.clone.- Copiar objeto contenedor. mlreportgen.dom.Container.append.- Anexar DOM objeto de contenedor. mlreportgen.dom.Container.contenedores de objetos de documento.

G. Crear informes orientados a Objetos  mlreportgen.dom.Document.fill.- Llene los agujeros de documentos con contenido generado.  mlreportgen.dom.Document.- Informe documento de definición. V.

CREACION DE COMANDOS

A continuación se explicará un ejemplo con los pasos a seguir para la crear archivos que contengan generación de reportes personalizados. Para configurar el informe cuadrados magia, primero crear un archivo de configuración para guardar la configuración. A continuación, añadir objetos MATLAB, llamadas componentes, a la configuración para especificar el contenido de la memoria. Para crear el archivo de configuración de informe: 1.

Inicie una sesión de software MATLAB.

2.

Abra el Explorador de informes. Desde el MATLAB Toolstrip, en la pestaña de Aplicaciones, en el Database Connectivity y la sección Informes, haga clic en Generador de informes.

3.

Seleccione Archivo> Nuevo para crear un archivo de configuración de informe. La nueva configuración del informe tiene el nombre predeterminado Unnamed.rpt. En el panel Propiedades de la derecha: 

Para guardar el informe en la carpeta de trabajo actual, seleccione el directorio de trabajo actual de la lista Directorio.



Establecer formato de archivo para la web (HTML) para crear el informe como un archivo HTML.



En el cuadro de texto Reportar descripción, reemplazar el texto actual por el siguiente texto.

F. Crear Reportes basados en Forma  

  

mlreportgen.dom.Document.createTemplate.- Crear plantilla DOM. mlreportgen.dom.Document.moveToNextHole.Mueve el punto de documentos anexados para abrir la siguiente plantilla. mlreportgen.dom.Document.- Informe documento de definición. mlreportgen.dom.DocumentPart.Parte del Documento. mlreportgen.dom.Template.- Crear documento de plantilla.

Consejo: Copie y pegue este texto de la documentación HTML en el Explorador de informes. En este informe se crea una serie de cuadrados mágicos y las muestra como imágenes.

This report creates a series of magic squares and displays them as images. A magic square is a matrix in which the columns, rows, and diagonal all add up to the same number.

Nota: Cuando se cambia un campo del panel Propiedades, su color de fondo también cambia. Esto indica que hay cambios no aplicados a ese campo. Tan pronto como se realiza ninguna acción con otro componente, MATLAB Report Generator aplica los cambios, y el color de fondo se convierte en blanco de nuevo. 4.

Guarde el informe. Seleccione Archivo> Guardar como y el nombre de su informe de archivo de instalación magic_squares.rpt. El nuevo nombre de archivo aparece en el panel Contorno.

De aquí en adelante Matlab ofrece un sinnumero de componentes para llenar los nuevos reportes personalizados y en su mayoría funcionan en ambiente gráfico. Para tener una mejor comprension de esto, representaremos este proceso en la siguiente imagen.

VI.

GENERACION DE DOCUMENTOS

Una vez que haya seleccionado un archivo de instalación, usted puede generar un informe en el explorador de informe o de la línea de comandos MATLAB. Puede generar informes en formatos HTML, PDF, RTF, Microsoft Word y XML. Métodos de generar un informe Son tres maneras puede generar un informe:  Desde la línea de comando, mediante los Informe comando  Con la lista de archivos de configuración  Con el Editor de archivo de configuración Para generar un informe con el Editor de configuración del archivo, haga clic en el botón Informe, que se encuentra bajo el esquema de archivo de instalación en el Editor de configuración del archivo. Un informe que contiene los componentes enumerados en el archivo de configuración de esquema se generará en ningún fichero M, modelo Simulink, o Modelo Stateflow. Si bien el informe se encuentra en el proceso de generación, el botón cambia de Informe, el botón Stop y todos los demás controles (botones y menús) están inactivos. Además, como cada componente se ejecuta, se destaca en el contorno de archivos de configuración. Generación de informes de Limpieza Después de que el informe se terminó de generación, el generador de informes cierra todas las imágenes, modelos, ventanas Stateflow y asas Idioma de destino Compiler ™ (TLC) que se abrieron en el proceso de generación de informes. Detener la generación de informes Durante la generación de informes, el botón Informe cambios en el botón Detener. Para dejar la generación de informes, haga clic en el botón Detener, que se encuentra bajo la configuración de archivos de esquema en el editor de configuración del archivo. Control de Generación de Reportes Cuando se genera un informe con el Editor de configuración del archivo, usted tiene un conjunto de opciones que controlan aspectos de la generación de informes, por ejemplo, cómo el informe es generado, lo que parece, y si se muestra tras generación es completa. Puede configurar estas opciones utilizando el Editor de configuración del archivo.

Opciones de salida Son varias las opciones que usted puede controlar. Puede utilizar la ficha Opciones para el componente Informe para especificar:  El nombre y la ubicación del archivo de informe  El formato del informe y estilo  Si el archivo de configuración se guarda automáticamente en la generación de informes  Si se visualiza el informe después de que se genera  Se regeneran imágenes Ya sea  Una descripción del informe Nota: Para ver la ficha Opciones para el componente de informe, seleccione la primera componente en el esquema del archivo de configuración, que es el componente Report, y seleccione la ficha Opciones. Puede especificar cualquiera de las características de informes anteriores antes de generar el informe. Otras opciones Puede utilizar la ficha Estado Generación para especificar qué tipo de generación se muestran los mensajes. Puede utilizar la opción Crear archivo de registro del menú Archivo para generar un archivo de registro. Un archivo de registro es un archivo de texto que le permite ver la información del archivo de configuración y el informe información de generación. Ambas opciones se discuten en detalle más adelante en este capítulo. VII. EJEMPLO The Figure Loop le permite elaborar un informe que documenta varias ventanas de la figura. Cada vez que se ejecuta el componente del bucle de la figura, informa sobre una figura diferente. function hList=figloopfigures %FIGLOOPFIGURES creates figures for figloop-tutorial.rpt % FIGLOOPFIGURES creates five figures which are used by % the Report Generator setup file "figloop-tutorial.rpt". % To run this tutorial, type "setedit figloop-tutorial" % at the command prompt. % % Figure 1: Membrane Data % Figure 2: Invisible Membrane Data % Figure 3: An Application % Figure 4: An Invisible Application % Figure 5: Peaks Data % % Figures 2 and 4 are invisible. % Figures 3 and 4 have HandleVisibility='off' % Figure 5 is the current figure %

% FIGLOOPFIGURES deletes any existing figures which have % tag 'peaks' 'app' or 'membrane' % Copyright (c) 1997-2000 by The MathWorks, Inc. % $Revision: 1.3 $ $Date: 2000/04/28 20:33:02 $

%delete existing figures with used tag names allFigs=allchild(0); delete([findall(allFigs,'flat','tag','membrane');... findall(allFigs,'flat','tag','peaks');... findall(allFigs,'flat','tag','app')]); figName={'Membrane Data' 'Invisible Membrane Data' 'An Application' 'An Invisible Application' 'Peaks Data'}; figTag={'membrane' 'membrane' 'app' 'app' 'peaks'}; figVisible={'on' 'off' 'on' 'off' 'on'}; figHandleVisible={'on' 'on' 'off' 'off' 'on'}; for i=1:length(figName) hList(i)=figure('Name',figName{i},... 'Tag',figTag{i},... 'HandleVisibility',figHandleVisible{i},... 'Visible','off',... 'Units','points',... 'Position',[90+30*i 230-30*i 200 200]); end

LocalMakeMembrane(hList(1)); LocalMakeMembrane(hList(2)); LocalMakeApplication(hList(3),'Push Me'); LocalMakeApplication(hList(4),'Invisible'); LocalMakePeaks(hList(5)); set(hList,{'Visible'},figVisible); set(0,'CurrentFigure',hList(5)); drawnow

%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%%%%%%% function LocalMakeMembrane(h) ax=axes('Parent',h,... 'Xlim',[0 31],... 'Ylim',[0 31],... 'Xgrid','on',... 'Ygrid','on',... 'Zgrid','on',... 'View',[-37.5 35]); surface(membrane,'Parent',ax);

'Units','normalized',... 'Position',[0 0 1 1]); surface(pData,... 'Parent',ax,... 'FaceLighting','gouraud',... 'edgecolor','none'); light('Parent',ax);

VIII. IX.

Cifras en el informe Membrane Data

%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%%%%%%% function LocalMakeApplication(h,btnString) figWd=200; figHt=200; btn=uicontrol('Parent',h,... 'String',btnString,... 'FontSize',18,... 'Units','points'); btnExtent=get(btn,'Extent'); btnHt=btnExtent(4)+10; btnWd=btnExtent(3)+10; cbString=sprintf('set(gcbo,''Position'',[rand(1)*%0.2g rand(1)*%0.2g %0.2g %0.2g])',... figWd-btnWd-10,figHt-btnHt-10,btnWd,btnHt);

Name Membrane Data

HandleVisibility on

Tag

Visible

membrane

on

Datos de membrana invisible

set(btn,... 'Position',[10 10 btnWd btnHt],... 'Callback',cbString);

%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%%%%%%% function LocalMakePeaks(h) pSize=49; pData=peaks(pSize); ax=axes('Parent',h,... 'View',[-37.5 30],... 'Visible','off',... 'Xlim',[0 pSize],... 'Ylim',[0 pSize],... 'Zlim',[min(min(pData)) max(max(pData))],...

Name Invisible Membrane Data

HandleVisibility on

Tag

Visible

membrane

Una Aplicación

off

Name An Application

HandleVisibility off

Name An Invisible HandleVisibility off Application

Tag

Visible

Tag

app

on

app

Visible

off

Una aplicación Invisible REFERENCES Report Generator For use with Matlab and Simulikn[1]. The sentence punctuation follows the bracket [2]. Tomado de la website de MathWorks. [1]

[2]

MathWorks Inc, Version 1, 1999. – [Online] Disponible en: http://dali.feld.cvut.cz/ucebna/matlab/pdf_doc/rptgen/rptgen.pdf 24 Prime Park Way, Natic, MA, USA MathWorks Inc, Examples Online, 2015. – [Online] Disponible en: http://www.mathworks.com/help/rptgen/examples.html 24 Prime Park Way, Natic, MA, USA