Manual de usuario

1.0.0
28/11/13


























Manual de usuario

Componentes del equipo de desarrollo:

Nombre y Apellido Rol DNI e-mail
David Romero Alcaide Tcnico 28842171X davromalc@gmail.com




Historial de revisiones:

Fecha Versin Descripcin
28/11/13 1.0.0 Creacin del documento.
04/12/2013 1.1.0 Modificacin del documento.
10/12/2013 1.1.1 Verificacin del documento




2

Manual de usuario

ndice
1. Introduccin .................................................................................................................................. 4
2. Objetivos ......................................................................................................................................... 4
3. Gua de la instalacin ................................................................................................................. 4
4. Funcionamiento de la API ......................................................................................................... 4
4.1 Descripcin de la API 5
4.1.1 Funcionalidades ............................................................................................................ 5
4.1.2 Factora externa ............................................................................................................ 8
4.2 Gestin de errores 10
4.2.1 Errores producidos por Visual Basic en macros .............................................. 10
4.2.2 Errores producidos por CATIA ............................................................................... 11
1. Anexo .............................................................................................................................................. 13
1.1 Anexo 1: Aadir un mdulo a la interfaz de CATIA 13





3

Manual de usuario

1. Introduccin
Este documento es un manual de usuario en el cul se explica el uso que se le puede
dar a la API creada, como darle uso, su funcionamiento, la gestin de errores y otros
aspectos relacionados con la API.
2. Objetivos
La creacin de la API est basada en la idea de establecer una capa intermedia entre
CATIA y la API existente de CATIA. Esta capa tiene la funcin de simplificar la tarea de
interactuar con CATIA y hacer ms sencillo el uso de CATIA y sobre todo el uso de sus
macros.
3. Gua de la instalacin
Para la instalacin de este proyecto, API de Catia, se debe instalar la librera de
macros en CATIA. Para la instalacin de esta librera se deben realizar los siguientes pasos:
1. Obtener la librera en formato catvba
2. Ir a la barra de herramientas de CATIA y hacer clic en Tools, Macro, Macros, Macro
libraries, Add existing library... y seleccionar la librera mencionada en el punto
anterior.
3. Crear las carpetas C:\CATIA-API y C:\CATIA-API\Reports y copiar en la primera los
ficheros de configuracin que se listan a continuacin:
a. CATDUA.bat
b. CATDUACodeErrors.dat
c. confCATDUA.xml
d. VBCodeErrorsEn.dat
e. VBCodeErrors.dat
Con estos tres pasos ya tendramos instalada la api y se podran utilizar todas sus
funcionalidades, desde el propio software CATIA o desde la interfaz de macros para Visual
Basic que ofrece CATIA.
4. Funcionamiento de la API
El funcionamiento o uso de la API se consta de dos partes:
Uso de la API desde CATIA: Existen determinadas funcionalidades que son tiles
sobre el software CATIA directamente, es decir, a travs de una barra de
herramientas en CATIA
1


Uso de la API desde macros: Existen una serie de clases y funciones que nos pueden
ser tiles a la hora del manejo de macros ya que proporcionan funcionalidades
bastante interesantes a la hora de trabajar con macros. Estas funcionalidades las
mencionaremos en los siguientes apartados.

1
En el anexo I se mostrar cmo realizar esta accin.
4

Manual de usuario

4.1 Descripcin de la API
La especificacin de la API se basa en los macros que nos ofrece CATIA
para la automatizacin de tareas. Estos macros estn realizados en el lenguaje de
programacin Visual Basic en su versin nmero 6, por lo tanto para interactuar
con la API es necesario utilizar y conocer Visual Basic 6.

La API cuenta con los tres tipos de mdulos ofrecidos, formularios,
mdulos y clases de mdulo. Cada uno de estos mdulos nos ayudar a
interactuar con mayor facilidad con CATIA. Como ejemplo podramos citar un
formulario a travs del cual podamos buscar una cadena de texto en el rbol de
CATIA.
4.1.1 Funcionalidades

Todas las funcionalidades creadas han sido diseadas para
un uso sencillo, seguro y con posibilidad de ampliacin.
En esta seccin vamos a ver las funcionalidades comunes a
los elementos de CATIA CATPart y CATProduct.
Las funcionalidades que vamos a ver a continuacin y las
que veremos en los sub-apartados pertenecen a la clase Utilities, por lo
tanto para el uso de estas funcionalidades ser necesario crear en un
mdulo o en una clase una instancia de esta clase. A continuacin
mostramos un ejemplo de cmo realizar dicha instancia:


Dim utilities1 As Utilities
Set utilities1 = New Utilities
Dim part1 As Part
Set part1 = utilities1.createPart()

Las funcionalidades que vamos a analizar a continuacin
estn recogidas en mdulos para un uso ms simple y rpido desde CATIA.


Buscar en el rbol de CATIA

Esta funcionalidad nos permite buscar en el rbol de CATIA cualquier
coincidencia con la cadena de texto introducida. Las coincidencias las busca
en base a los siguientes criterios:
o Para Products: Busca en el nombre del Product y en el Product
Number
o Para Parts: Busca en el nombre de los Bodies, HybridBodies y
Sketches contenidos en los Parts.
Para su uso, ejecute el mdulo ModuleSearch

Obtener rea

Esta funcionalidad nos permite obtener el rea de una cara de una
superficie en metros cuadrados. La cara debe seleccionarse con el ratn por
el usuario.

Para su uso, ejecute el mdulo ModuleGetAreaFromSurface

5

Manual de usuario

Realizar fotografa

Esta funcionalidad nos permite realizar una captura de pantalla con el
fondo en blanco. Dicha captura tomar todo el contenido de la pantalla de
CATIA.

Para su uso, ejecute el mdulo ModuleTakePicture

4.1.1.1 Funcionalidades para Parts

Las siguientes operaciones estn diseadas para un uso desde el
mdulo de CATIA Part Design ya que son funcionalidades para CATParts.
La operacin de la generacin de un Bounding Box est adherida a un
mdulo para su adiccin a CATIA de una forma sencilla y rpida. El resto de
operaciones o funcionalidades se deben de ejecutar desde un macro en
cdigo.

Crear un crculo

Esta funcionalidad nos permite crear un crculo en cualquiera de los tres
planos, y con la posibilidad por parte del usuario de establecer las
coordenadas del origen del crculo as como su radio.

Crear un nuevo Part

Esta funcionalidad nos permite crear un nuevo CATParts y abrir la vista
del PartDesign.

Crear un nuevo Sketch

Esta funcionalidad nos permite crear un nuevo Sketch en base al plano que
se le indique como referencia.

Crear una Spline

Esta funcionalidad nos permite crear una lnea que pase por encima de
todos los puntos en dos dimensiones que se le pasen como parmetro.

Crear un Punto 2D

Esta funcionalidad nos permite crear un punto en dos dimensiones en el
Sketch que se desee, con las coordenadas que establezca el usuario.

Crear un Punto 3D

Esta funcionalidad nos permite crear un punto en tres dimensiones en
base a las coordenadas establecidas por el usuario.

Generar un Bounding Box

Esta funcionalidad nos permite crea el mnimo cubo con el menor volumen
en el que est contenido un objeto, es decir, crea el cubo mnimo que puede
alojar al objeto seleccionado.

6

Manual de usuario

Ejemplo:

Ms informacin en:

http://en.wikipedia.org/wiki/Minimum_bounding_box











Obtener el ngulo agudo entre dos lneas

Esta funcionalidad nos permite obtener el ngulo agudo formado por dos
lneas.

Obtener el ngulo entre tres puntos

Esta funcionalidad nos permite obtener el ngulo que se forma entres tres
puntos. Este ngulo se calcula en funcin de dos vectores que contienen a
los tres puntos. El primer vector contiene los dos primeros puntos y el
segundo vector contiene el segundo y el tercer punto.

4.1.1.2 Funcionalidades para Products

Aadir CATParts o CATProducts a un Product

Esta funcionalidad nos permite ir aadiendo CATParts o
CATProducts sin pausa a un Product ya creado. Con esta funcin se ha
querido agilizar esta tarea ya que para Products que contienen muchos
componentes resulta arduo y lento.

Esta funcionalidad est implementada en un mdulo para poder
utilizarla desde CATIA.

Mover un Product a lo largo de los tres ejes

Esta funcionalidad nos permite mover un Product a lo largo de los
tres ejes. Dentro de un Product podemos mover el componente entero
o si seleccionamos algn subcomponente podemos mover solo ese.



Esta funcionalidad contiene un formulario y est implementada en
un mdulo para poder utilizarla desde CATIA.




7

Manual de usuario







4.1.2 Factora externa
Esta idea est basada en la simplificacin y externalizacin de
creacin de objetos y figuras. La idea consiste en crear una serie de
objetos o figuras automticamente en base a un fichero de configuracin
introducido por el usuario.
La implementacin se ha realizado pensando en posibles
ampliaciones de la API, por eso se ha elegido XML como formato de
fichero para los archivos donde se almacenan los objetos.
El uso de este elemento de la API se ha considerado que debe
realizarse desde una barra de herramienta de CATIA, por eso se ha creado
un mdulo para su adiccin como comando a CATIA.
A continuacin mostramos ejemplos de la sintaxis que debe tener
el fichero de configuracin.
Como podemos ver en estos dos ejemplos, para declarar una
figura, se debe declarar un nodo del tipo <Figure>. Este nodo cuenta con
dos propiedades:







Ilustracin 1 Formulario que nos permite mover un Product
8

Manual de usuario


type: Indica el tipo de figura que
se desea crear. Actualmente solamente
estn disponibles los tipos Circle,
Point3D y Polygon que est
constituido de un conjunto de Point3D
unidos por lneas.

properties: Indica el nmero de
hijos que posee el nodo. Visto desde el
lado de diseo, indica el nmero de
propiedades de cada figura. Por
ejemplo, para la creacin de un circulo
son necesarios un Plano en el que
crearse, una coordenada X y otra
coordenada Y para situar el punto de
origen del circulo y un radio para el
propio radio del crculo.




En este ejemplo, podemos
ver como es la sintaxis para la
creacin de una figura que
contiene a otras figuras,
como en este caso que
estamos creando un
polgono, un polgono
construido sobre varios
puntos de tres dimensiones.

Cabe destacar el
parmetro properties del
primer nodo <Figure> ya que
nos indica que hay 20 nodos
hijos aunque esos nodos sean
del tipo Figure.




9

Manual de usuario

4.1.2.1 Figuras contempladas

A continuacin se muestra una lista con las posibles figuras a crear
en la actual versin de la API.

Circle
o Propiedades:
Coordenada X
Coordenada Y
Radio
Plano
Point 3D
o Propiedades:
Coordenada X
Coordenada Y
Coordenada Z
Polygon
o Propiedades:
Point 3D


4.2 Gestin de errores

En el diseo de la API se puso especial nfasis en la gestin de
errores debido a que la actual API oficial de CATIA ofrece mnimos
mecanismos para la gestin y tratamiento de errores. En esta API se han
analizado y gestionado los errores que se producen en el trabajo con el
software CATIA para poder realizar un tratamiento correcto de dichos
errores. Podemos diferenciar entre dos tipos de errores los cules son
definidos en los siguientes apartados.

4.2.1 Errores producidos por Visual Basic en macros

Estos errores son los ms comunes y se lanzan tanto por errores de
CATIA como por errores de sintaxis a la hora de procesar un macro para
CATIA. Para este tipo de errores se proporciona clases para tratamiento de
errores tanto en Parts como en Products.
Su funcionamiento es sencillo, cuando detectemos que estemos en
un fragmento de cdigo sensible a errores debemos introducir la
sentencia:

On Error GoTo Failed

Con esta sentencia indicamos que en caso de error la macro vaya a
la etiqueta Failed; el contenido de dicha etiqueta lo mostramos a
continuacin:


10

Manual de usuario


Failed:
Dim ErrorInPartProduced1 As ErrorInPartProduced
Set ErrorInPartProduced1 = New ErrorInPartProduced
ErrorInPartProduced1.message = El documento no es
un CATPart
ErrorInPartProduced1.Code = Err.Number
Dim errorTypes(2) As String
errorTypes = ErrorInPartProduced1.ErrorType.Types
Obtenemos los tipos de errores.
0 -> visual Basic
1 -> CATDUA
2 -> CATIA
ErrorInPartProduced1.ErrorType.TypeError =
errorTypes(2)
ErrorInPartProduced1.show

Con este bloque de cdigo definido para la etiqueta Failed
establecemos los pasos a seguir para la gestin y tratamiento de un error
producido. En el ejemplo se muestra un error para un CATPart aunque
tambin est disponible para CATProduct.
A continuacin detallamos el bloque de cdigo como una secuencia
de pasos a seguir.

1. Declarar la etiqueta Failed al final del cdigo sensible
2. Crear una instancia del error ya sea del tipo Part o Product
3. Establecer el mensaje o dejar vaco si no se conoce
4. Establecer el cdigo dado por el editor de macros
5. Establecer el tipo de error (Fuente del error: Visual Basic, CATIA
o CATDUA)
6. Mostrar el error al usuario

Si el mensaje no se introduce el sistema busca automticamente el
mensaje asociado al cdigo introducido. Este apunte se ve con mayor
profundidad en el siguiente apartado.
4.2.1.1 Lectura de errores desde ficheros de configuracin
Debido a la gran cantidad de errores que pueden lanzarse en una
aplicacin de este tipo, se ha implantado un sistema automtico de
bsqueda de mensajes de error en funcin del cdigo de error, con lo cual
el usuario en el aspecto de manejo de errores no tiene por qu preocuparse
por los mensajes si no lo desea.
Para que este aspecto funcione correctamente en la API es
necesario que los ficheros de configuracin estn instalados correctamente.

4.2.2 Errores producidos por CATIA

El software CATIA es una herramienta muy potente que nos
proporciona mltiples posibilidades a la hora de trabajar con ingeniera de
procesos o diseo de piezas o productos. Este conjunto de herramientas
necesita de una gran gestin de errores y para dicha gestin cuenta con la
herramienta CATDUA la cual explicaremos a en el siguiente apartado.
11

Manual de usuario

4.2.2.1. CATDUA

La herramienta CATDUA, tambin llamados Data Upward
Assistant, le permite tener un soporte para los cambios de nivel de CATIA,
hacer un diagnstico, y eventualmente una eliminacin de errores en los
datos de Versin de CATIA.
Cundo es til usar el "CATDUA"?
1


o Antes de recuperar datos externos
o Al editar un documento existente, en una nueva Release de
CATIA
o Cuando se rompen los links al abrir CATProducts
o Cuando tengamos incidentes al actualizar un componente
(por ejemplo, al hacer "Update" de un Sketch)
o Cuando en la ventana de los Edit-Link aparece: "some
documents are found but they have no references" (algunos
documentos encontrados no tienen ninguna referencia),
o Con problemas al abrir un documento (porque algunos
elementos han perdido sus enlaces)
En la API se ha desarrollado una funcionalidad capaz de ejecutar la
herramienta anlisis CATDUA a un fichero almacenado, con lo cual se
simplifica la tarea. Dicha funcionalidad se encuentra en el mdulo
ModuleAnalyzeByCATDUA. Tras el anlisis se muestra el resultado en un
informe en formato HTML para que el usuario compruebe su resultado y
tome las acciones que estime oportunas.
2


















1
Ms informacin en: http://catiadoc.free.fr/online/cfyugcatdua_C2/cfyugcatdua00.htm
2
Lista de cdigos devueltos por CATDUA http://www.muchocatia.es/Catdua/cfyugcatdua05.html
12

Manual de usuario

1. Anexo
1.1 Anexo 1: Aadir un mdulo a la interfaz de CATIA
En este anexo se mostrar secuencialmente como aadir funcionalidades al
entorno de trabajo de CATIA.
Pre-requisito: La funcionalidad a aadir debe encontrarse en un mdulo, es decir el
cdigo que se quiera automatizar en un solo icono debe encontrarse en un mdulo
propio de Visual Basic. Para este anexo se utilizar como ejemplo la funcionalidad
de realizar una fotografa.
Ejemplo del mdulo:
Sub CATMain()
Dim utilites1 As Utilities
Dim utilities1 = New Utilities
utilities1.takePicture
End Sub

1. En la interfaz principal de CATIA, hacemos clic con el botn derecho sobre
cualquier barra de herramientas
2. Aparecer un men contextual nuevo, hacemos clic con el botn izquierdo
en Customize
3. Se mostrar un nuevo men contextual con varias pestaas
a. (Opcional) Podramos crearnos una nueva barra de herramientas
seleccionando en la pestaa Toolbars e indicando el ttulo de la
nueva barra de herramientas
b. En la pestaa Commands, en la lista de la izquierda, seleccionamos
la opcin Macros.
c. Tras la seleccin anterior, la lista de la derecha se actualizar y se
mostrarn los mdulos disponibles.
d. Hacemos doble clic sobre el mdulo deseado
e. Editamos la personalizacin del mdulo. (Ttulo, Alias e icono)
4. Tras realizar con xito los pasos anteriores, debemos arrastrar desde la barra
de Commands el mdulo elegido a la barra de herramientas (Toolbars) en
la que se desee colocar el mdulo.
5. Por ltimo comprobamos que todo ha ido bien, cerrando todos los mens
contextuales y haciendo clic sobre el nuevo icono que se ha creado para el
mdulo.







13