Clase de Elemento [Guía de Usuario de Enterprise Architect]

Top Previous Next

Clase de Elemento

button_main button_prev button_next

Un elemento es la principal unidad de modelado, correspondiente a (por ejemplo) una Clase, Caso de uso, Nodo o Componente. Puede crear nuevos elementos, agregando a la colección de Elementos del Paquete. Una vez que haya creado un elemento, puede agregarlo a la Clase DiagramObject de un diagrama para incluirlo en el diagrama.

Los Elementos también tienen una colección de conectores. Cada entrada de esta colección indica una relación con otro elemento.

También hay algunas colecciones extendidas para administrar información adicional sobre el elemento, incluyendo propiedades tal como Valores Etiquetados, Problemas, Restricciones y Requisitos.

Tabla asociada en archivo .EAP t_object

Atributos del Elemento

Atributo

Tipo

Notas

Ver También

Abstracto

String

Lectura/Escritura

Indica si el elemento es Abstracto (1) o Concreto (0).

 

 

ActionFlags

String

Lectura/Escritura

Una estructura para sostener banderas que se ocupan de la semántica de la Acción.

 

 

Alias

String

Lectura/Escritura

Un alias opcional para este elemento.

 

 

AssociationClassConnectorID

Long

Sólo lectura

Si el elemento es una AssociationClass, AssociationClassConnectorID contiene el ID del Conector del conector de la Asociación respectiva.

CreateAssociationClass() (información sobre la creación de AssociationClasses desde elementos)

 

Atributos

Colección

Sólo lectura

Una colección de objetos de Atributo para el elemento actual; utilice las funciones AddNew y Eliminar para administrar los atributos.

 

Clase Atributo

Clase de Colección

AttributesEx

Colección

Sólo lectura

Una colección de objetos de Atributoperteneciente al elemento actual y sus elementos padres.

 

Clase Atributo

Clase de Colección

Autor

String

Lectura/Escritura

El autor del elemento.

 

Repositorio: Autores

BaseClasses

Colección

Sólo lectura

Una lista de Clases Base para este elemento, presentada como una colección para mayor comodidad.

 

Clase de Colección

ClassfierID

Long

Obsoleto

Vea ClassifierID.

 

 

ClassifierID

Long

Lectura/Escritura

El ElementID de un Clasificador asociado con este elemento; es decir, el tipo base.

Sólo válido para elementos de tipo de instancia (tal como Objeto o Secuencia).

 

 

ClassifierName

String

Lectura/Escritura

Nombre del Clasificador asociado (si lo hubiera).

 

 

ClassifierType

String

Sólo lectura

Tipo de Clasificador asociado.

 

 

Complejidad

String

Lectura/Escritura

Un valor de complejidad indicando cuan complejo es el elemento; utilizado para informes de métricas y estimación.

Los valores válidos son: 1 para Fácil, 2 para Medio, 3 para Difícil.

 

 

CompositeDiagram

Diagrama

Sólo lectura

Si el elemento es Compuesto, devuelve su diagrama asociado; de lo contrario, devuelve nulo.

 

Clase Diagrama

Conectores

Colección

Sólo lectura

Devuelve una colección que contiene los conectores a otros elementos.

 

Clase Conector

Clase de Colección

Restricciones

Colección

Sólo lectura

Una colección de objetos Restricción.

 

Clase Restricción

Clase de Colección

ConstraintsEx

Colección

Sólo lectura

Una Colección de objetos de Restricción perteneciente al elemento actual y sus elementos padres.

 

Clase Restricción

Clase de Colección

Creado

Fecha

Lectura/Escritura

La fecha en la que el elemento fue creado.

 

 

Propiedades Personalizadas

Colección

Sólo lectura

Lista de propiedades avanzadas para un elemento.

La colección de propiedades avanzadas difiere según el tipo de elemento; por ejemplo, una Acción y una Actividad tienen diferentes propiedades avanzadas.

Actualmente sólo pueden editarse desde la interfaz de usuario.

 

Colección de Propiedades Personalizadas

Diagramas

Colección

Sólo lectura

Devuelve una colección de sub-diagramas (diagramas hijos) adjunto a este elemento como se ve en la vista de árbol.

 

Clase Diagrama

Clase de Colección

Dificultad

String

Lectura/Escritura

Un nivel de dificultad asociado con este elemento para la estimación/métrica; sólo utilizable para tipos de elementos de Requisito, Cambo y Problema, de lo contrario son ignorados.

Los valores válidos son: Bajo, Medio, Alto.

 

 

Esfuerzos

Colección

Sólo lectura

Una colección de objetos Esfuerzo.

 

Clase Esfuerzo

Clase de Colección

ElementGUID

String

Sólo lectura

Un ID global único para este elemento; es decir, único a lo largo de todos los archivos del modelo.

 

 

ElementID

Long

Sólo lectura

El ID local del Elemento; válido para este archivo únicamente.

 

 

Elementos

Colección

Sólo lectura

Devuelve una colección de elementos hijos (sub-elementos) adjunto a este elemento como se ve en la vista de árbol.

 

Clase de Colección

EmbeddedElements

Colección

Sólo lectura

Una lista de elementos que se incrustan en este elemento, tal como Puertos, Partes, Pines y Conjuntos de Parámetros.

 

Colección de Elementos Embebidos

EventFlags

String

Lectura/Escritura

Un estructura para sostener una variedad de banderas que tengan que ver con señales o eventos.

 

 

ExtensionPoints

String

Lectura/Escritura

Puntos de extensión opcionales para un Caso de Uso como una lista separada por comas.

 

 

Archivos

Colección

Sólo lectura

Una colección de objetos Archivo .

Clase de Archivo

Clase de Colección

 

GenFile

String

Lectura/Escritura

El archivo asociado a este elemento para la generación de código y propósitos de sincronización; puede incluir etiquetas de expansión macro para una conversión local a ruta completa.

 

 

Genlinks

String

Lectura/Escritura

Se vincula a otras Clases descubiertas en el tiempo de revisión de código; conectores Padres y de Implementación únicamente.

 

 

GenType

String

Lectura/Escritura

El tipo de generación de código; por ejemplo, Java, C++, C#, VBNet, Visual Basic, Delphi.

 

 

Header1

Variante

Lectura/Escritura

Una cadena definida por el usuario para su inclusión como encabezado en los archivos de código fuente generados.

 

 

Header2

Variante

Lectura/Escritura

Igual que para el Encabezado1, pero utilizado en el archivo fuente CPP.

 

 

IsActive

Boolean

Lectura/Escritura

Un valor Booleano indicando si el elemento está activo o no

1 = Verdadero, 0 = Falso.

 

 

IsComposite

Boolean

Lectura/Escritura

Indica si el elemento es compuesto o no.

1 = Verdadero, 0 = Falso.

 

 

IsLeaf

Boolean

Lectura/Escritura

Un valor Booleano indicando si el elemento está activo o no

1 = Verdadero, 0 = Falso.

 

 

IsNew

Boolean

Lectura/Escritura

Un valor Booleano indicando si el elemento está activo o no

1 = Verdadero, 0 = Falso.

 

 

IsSpec

Boolean

Lectura/Escritura

Un valor Booleano indicando si el elemento está activo o no

1 = Verdadero, 0 = Falso.

 

 

Problemas

Colección

Sólo lectura

Colección de objetos Problema.

Clase Problema (Mantenimiento)

Clase de Colección

 

Bloqueado

Boolean

Lectura/Escritura

Indica si el elemento ha sido bloqueado contra nuevos cambios.

 

 

MetaType

String

Sólo lectura

El meta tipo específico de dominio del elemento, como se define por un estereotipo aplicado desde una Tecnología MDG

 

 

Métodos

Colección

Sólo lectura

Colección de objetos Método para el elemento actual.

 

Clase Método

Clase de Colección

MethodsEx

Colección

Sólo lectura

Una Colección de objetos de Método perteneciente al elemento actual y sus elementos padres.

 

Clase Método

Clase de Colección

Métricas

Colección

Sólo lectura

Colección de elementos de Métrica para el elemento actual.

 

Clase Métrica

Clase de Colección

MiscData

String

Sólo lectura

Esta propiedad de bajo nivel proporciona información sobre el contenido de los campos PDatax.

Estos campos de base de datos no están documentados, y los desarrolladores deben ganar la comprensión de estos campos a través de sus propios esfuerzos para utilizar esta propiedad.

MiscData está basado en cero, por lo tanto:

MiscData(0) corresponde a PData1

MiscData(1) a PData2

y así sucesivamente.

 

 

Modificado

Fecha

Lectura/Escritura

La fecha en la que el elemento fue modificado por última vez.

 

 

Multiplicidad

String

Lectura/Escritura

Valor de multiplicidad de este elemento.

 

 

Nombre

String

Lectura/Escritura

El nombre del elemento; debe ser único dentro del paquete actual.

 

 

Notas

String

Lectura/Escritura

Más texto descriptivo sobre el elemento.

 

 

ObjectType

ObjectType

Sólo lectura

Distingue objetos referidos a través de una interfaz de Envío.

 

ObjectType

PackageID

Long

Lectura/Escritura

Un ID local para el Paquete que contiene a este elemento.

 

 

ParentID

Long

Lectura/Escritura

Si este elemento es un hijo de otro, utilizado para configurar recuperar el ElementID del otro elemento; si no, devuelve 0.

 

 

Particiones

Colección

Sólo lectura

Lista de particiones lógicas en las que se puede dividir un elemento.

Sólo válido para los elementos que soportan particiones, tal como las Actividades y Estados.

 

Colección de Particiones

Persistencia

String

Lectura/Escritura

La persistencia asociada con este elemento; puede ser Persistente o Transitorio.

 

 

Fase

String

Lectura/Escritura

La fase en la que está programado para construirse este elemento; cualquier valor de cadena.

 

 

Prioridad

String

Lectura/Escritura

La prioridad de este elemento en comparación con otros elementos del proyecto; sólo se aplica a los tipos de Requisito, Cambio y Problema, de lo contrario son ignorados.

Los valores válidos son: Bajo, Medio y Alto.

 

 

Propiedades

Propiedades

Devuelve una lista de propiedades especializadas que se aplican al elemento que pueden llegar a no estar disponibles utilizando el modelo de automatización.

Las propiedades están deliberadamente indocumentados debido a su naturaleza oscura y porque están sujetas a cambios ya que se les hacen mejoras progresivas.

 

Propiedades

PropertyType

Long

Lectura/Escritura

El ElementID de un Tipo asociado con este elemento; sólo válido para elementos de Parte y Puerto.

 

 

PropertyTypeName

String

Lectura

El nombre de un Tipo asociado con este elemento; sólo válido para elementos de Puerto u Parte.

 

 

Realiza

Colección

Sólo lectura

Lista de interfaces realizadas por este elemento por conveniencia.

 

Clase de Colección

Requisitos

Colección

Sólo lectura

Colección de objetos de Requisito.

 

Clase de Requisito

Clase de Colección

RequirementsEx

Colección

Sólo lectura

Una Colección de objetos de Requisito perteneciente al elemento actual y sus elementos padres.

 

Clase de Requisito

Clase de Colección

Recursos

Colección

Sólo lectura

Colección de objetos Recurso para el elemento actual.

 

Clase Recurso

Clase de Colección

Riesgos

Colección

Sólo lectura

Colección de objetos de Riesgo.

 

Clase de Riesgo

Clase de Colección

RunState

String

Lectura/Escritura

La lista de tiempo de ejecución del objeto como una cadena.

 

 

Escenarios

Colección

Sólo lectura

Colección de objetos Escenario para el elemento actual.

 

Clase Escenario

Clase de Colección

StateTransitions

Colección

Sólo lectura

Lista de Transiciones de Estado que puede soportar un elemento; se aplica en particular a los elementos de Tiempo.

 

Clase de Colección

Colección de Transiciones

Estatus

String

Lectura/Escritura

Establece u Obtiene el estado, tal como Propuesto o Aprobado.

 

 

Estereotipo

String

Lectura/Escritura

El estereotipo de elemento principal; el primero de la lista de estereotipos que puede acceder utilizando el atributo StereotypeEx.

 

 

StereotypeEx

String

Lectura/Escritura

Todos los estereotipos aplicados del elemento en una lista separada por comas.

 

 

StyleEx

String

Lectura/Escritura

Configuraciones avanzadas de estilo; reservadas para el uso de Sparx Systems.

 

 

Subtipo

Long

Lectura/Escritura

Un subtipo numérico que califica el Tipo del elemento principal

Para Evento: 0 = Receptor, 1 = Remitente

Para Clase: 1 = Parametrizado, 2 = Instanciado, 3 = Ambos, 0 = Ninguno,

17 = Clase de Asociación

 

Si es 17, es porque una Clase de Asociación ha sido creada a través de la interfaz de usuario, MiscData(3) contiene el ID de la Asociación relacionada; ya que MiscData es de sólo lectura, no se puede crear una Clase de Asociación a través de la Interfaz de Automatización:

Para Nota: 1 = Nota vinculada al conector, 2 = Restricción vinculada al conector

Para StateNode: 100 = ActivityIntitial, 101 = ActivityFinal

Para Actividad: 0 = Actividad, 8 = Actividad compuesta (también establecido en 8 para otros elementos compuestos tal como Casos de Uso)

Para Sincronización: 0 = Horizontal, 1 = Vertical

 

Note que hay muchos más Tipos de lo indicado en los ejemplos anteriores.

 

Tipo

Espacio de Tabla

String

Lectura/Escritura

Espacio de Tabla asociado para un elemento de Tabla.

 

 

Etiqueta

String

Lectura/Escritura

Corresponde al campo de Palabras Clave en la interfaz de usuario de Enterprise Architect.

 

Configuraciones Generales

TaggedValues

Colección

Sólo lectura

Devuelve una colección de objetos de TaggedValue.

 

Clase TaggedValue

Clase de Colección

TaggedValuesEx

Colección

Sólo lectura

Devuelve una colección de objetos de TaggedValue pertenecientes al elemento actual y los elementos especializados o realizadas por el elemento actual.

 

Clase TaggedValue

Clase de Colección

TemplateParameters

Colección

Sólo lectura

Una colección de objetos TemplateParameter .

Clases Parametrizadas (Plantillas)

Clase de Parámetro de Plantilla

Clase de Colección

 

Pruebas

Colección

Sólo lectura

Una colección de objetos de Prueba para el elemento actual.

 

Clase de Prueba

Clase de Colección

TreePos

Long

Lectura/Escritura

Establece u Obtiene la posición del árbol.

 

 

Tipo

String

Lectura/Escritura

El tipo de elemento (tal como Clase, Componente).

Note que el Tipo es sensible a mayúsculas y minúsculas dentro de Enterprise Architect y deben contar con una mayúscula inicial (tipo apropiado); los tipos válidos son:

 

 

Acción

Actividad

ActivityPartition

ActivityRegion

Actor

Artefacto

Asociación

Límite

Cambio

Clase

Colaboración

Componente

Restricción

Decisión

DeploymentSpecification

DiagramFrame

EmbeddedElement

Entidad

EntryPoint

Evento

ExceptionHandler

ExitPoint

ExpansionNode

ExpansionRegion

Característica

GUIElement

 

InteractionFragment

InteractionOccurrence

InteractionState

Interfaz

InterruptibleActivityRegion

Problema

Nodo

Nota

Objeto

Paquete

Parámetro

Parte

Puerto

ProvidedInterface

Informe

RequiredInterface

Requisito

Pantalla

Secuencia

Estado

StateNode

Sincronización

Texto

TimeLine

UMLDiagram

Caso de Uso

 

 

Versión

String

Lectura/Escritura

La versión del elemento.

 

 

Visibilidad

String

Lectura/Escritura

El Alcance de este elemento dentro del paquete actual.

Los valores válidos son: Público, Privado, Protegido o Paquete.

 

 

 

Métodos del Elemento

Método

Tipo

Notas

Ver También

ApplyGroupLock (

string aGroupName)

Boolean

Aplica un bloqueo de grupo para el objeto del elemento, para el grupo especificado, de parte del usuario actual.

Devuelve verdadero si la operación es exitosa; devuelve falso si la operación no es exitosa. UtiliceGetLastError() para recuperar información de error.

Parámetros:

aGroupName: Cadena - el nombre del grupo de usuario para el cual configurar el bloqueo de grupo

 

 

ApplyUserLock ()

Boolean

Aplica un bloqueo de usuario para el objeto del elemento, para el usuario actual.

Devuelve verdadero si la operación es exitosa; devuelve falso si la operación no es exitosa. UtiliceGetLastError() para recuperar información de error.

 

 

CreateAssociationClass (

long ConnectorID)

Boolean

Hace a este elemento una AssociationClass de la Asociación con el ID del Conector proporcionado; el valor de retorno indica si la función fue exitosa en convertir el elemento a una AssociationClass.

Las AssociationClasses se crean sólo cuando:

El elemento actual es válido

El elemento actual es una Clase

El elemento actual todavía no es una AssociationClass

El conector especificado existe

El conector especificado es una Asociación

El conector especificado todavía no es un par de AssociationClass

El elemento actual no está en ningún extremo del conector especificado

 

Parámetros:

ConnectorID: Long - el ID del Conector de un conector de Asociación

 

UnlinkFromAssociation

DeleteLinkedDocument()

Boolean

Elimina el Documento Vinculado para el elemento. Este método no muestra una solicitud de confirmación.

Devuelve verdadero si un documento se ha eliminado.

 

 

GetBusinessRules()

String

Sólo lectura.

Devuelve todas las Reglas de Negocios para el elemento.

 

Reglas de Negocio de Modelo

GetLastError ()

String

Devuelve un valor de string describiendo el error más reciente que ocurrió en relación con este objeto.

 

 

GetLinkedDocument ()

String

Devuelve un valor de tipo String que contiene el elemento del contenido del documento vinculado, en formato RTF.

Si el elemento no contiene ningún documento vinculado, se devuelve una cadena vacía.

 

 

GetRelationSet (

EnumRelationSetType Type)

String

Devuelve una cadena que contiene una lista separada por comas de ElementIDs elementos relacionados directa-e indirectamente- basados en el tipo dado.

Recursivamente utilizando el mismo tipo de relación en todos los elementos que encuentra, recuperando todas las dependencias y sub-dependencias del elemento actual; por ejemplo, Objeto1 depende de Objeto2, que depende de Objeto3, por lo tanto, este método devuelve Objeto2 y Objeto3.

Para obtener sólo las relaciones directas del elemento, utilice en su lugar la colección Conector.

 

Tipo de Conjunto de Relación de Enum

Conector

GetStereotypeList ()

String

Devuelve una lista separada por comas de los estereotipos aliados a este elemento.

 

 

IsAssociationClass

Boolean

Devuelve si el elemento actual es o no una AssociationClass.

 

 

LoadLinkedDocument (

string Filename)

Boolean

Carga el documento RTF desde el archivo especificado hacia el documento vinculado del elemento.

Parámetros:

Nombre de Archivo: String - el nombre del archivo desde el cual cargar el documento RTF

 

 

Refresh ()

Vacío

Actualice las características del elemento en el Explorador de Proyectos.

Generalmente llamado después de agregar o eliminar atributos o métodos, cuando la interfaz de usuario es requerida también para estar actualizado.

 

 

ReleaseUserLock ()

Boolean

Libera un bloqueo de grupo o de bloqueo de usuario en el objeto de elemento.

Devuelve verdadero si la operación es exitosa; devuelve falso si la operación no es exitosa. UtiliceGetLastError() para recuperar información de error.

 

 

SaveLinkedDocument (

string Filename)

Boolean

Guarda el documento vinculado para este elemento en el archivo RTF especificado.

Parámetros:

Nombre de Archivo: String - el nombre del archivo RTF en el cual guardar el documento vinculado

 

 

SetAppearance (

long Scope,

long Item,

long Value)

Vacío

Configura la apariencia visual del elemento.

Parámetros:

Alcance: Long - Alcance de la apariencia establecida para modificar.

1 - Base (apariencia predeterminada a lo largo de todo el modelo)

 

Para configurar la apariencia del elemento (objeto de diagrama) en sólo un diagrama seleccionado, vea Configuración del Estilo en el tema Clase de DiagramObject

 

Ítem: Long - Característica de la apariencia para modificar.

0 – Color de Fondo

1 – Color de Fuente

2 – Color del Borde

3 – Grosor del Borde

 

Valor: Long - Valor para configurar la apariencia de

 

Clase DiagramObject

SetCompositeDiagram ()

 

Boolean

Configura el diagrama compuesto del elemento.

Parámetros:

GUID: String - el GUID del diagrama compuesto. Un GUID en blanco eliminará el enlace al diagrama compuesto

 

Elementos Compuestos

SetCreated (

Date NewVal)

Vacío

Obsoleto

Este método ya no es soportado.

 

 

SetModified (

Date NewVal)

Vacío

Obsoleto

Este método ya no es soportado.

 

 

SynchConstraints (

string Profile,

string Stereotype)

Boolean

Sincroniza las restricciones de un ítem de Perfil UML para este elemento, sólo si el estereotipo especificado ha sido aplicado.

Parámetros:

Perfil: String - Nombre del perfil que contiene el estereotipo

Estereotipo: String - Nombre del estereotipo de perfil para los cuales se deben sincronizar las restricciones predeterminadas

 

 

SynchTaggedValues (

string Profile,

string Stereotype)

 

Boolean

Sincroniza los Valores Etiquetados de un ítem de Perfil UML para este elemento, sólo si el estereotipo especificado ha sido aplicado.

Parámetros:

Perfil: String - Nombre del perfil que contiene el estereotipo

Estereotipo: String - Nombre del estereotipo de perfil para los cuales se deben sincronizar las etiquetas predeterminadas

 

 

UnlinkFromAssociation

Boolean

Realiza lo opuesto a CreateAssociationClass().

 

CreateAssociationClass()

Update ()

Boolean

Actualiza el objeto del elemento actual después de modificar o anexar un nuevo ítem.

Si se devuelve falso, revise la función GetLastError para más información.