Clase de Proyecto

Atributo

Tipo

Notas

ObjectType

ObjectType

Sólo lectura

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

Método

Tipo

Notas

Ver También

CancelValidation ()

Void

Cancela un proceso de validación.

Validación de Modelo

CanValidate ()

Boolean

Devuelve un valor para indicar que el componente de Validación del Modelo está cargado.

CreateBaseline (

string PackageGUID,

string Version,

string Notes)

Boolean

Crea una Línea de Base para un determinado paquete.

Parámetros:

CreateBaselineEx (

string PackageGUID,

string Version,

string Notes,

EA.CreateBaselineFlag Flags)

Boolean

Crea una Línea de Base de un determinado paquete, con una bandera para excluir el contenido del paquete debajo del primer nivel.

Parámetros:

Crear Líneas Base

EA.CreateBaselineFlag

DefineRule (

string CategoryID,

EA.EnumMVErrorType ErrorType,

string ErrorMessage

String

Define las reglas individuales que se pueden realizar durante la validación del modelo. Debe ser llamado una vez para cada regla de el manejador de transmisión EA_OnInitializeUserRules.

El valor de retorno es una Regla, la cual puede ser utilizada para fines de referencia cuando una regla individual es ejecutada por Enterprise Architect durante la validación del modelo.

Vea el Ejemplo de Validación del Modelo para un ejemplo detallado del uso de este método.

Parámetros:

EA_OnInitializeUserRules

Ejemplo de Validación de Modelos

DefineRuleCategory

PublishResult

DefineRuleCategory (

string CategoryName)

String

Define una categoría de reglas que pueden ser realizadas durante la validación del modelo (generalmente hay una categoría por Add-In). Debe ser llamado una vez para desde el manejador de transmisión EA_OnInitializeUserRules.

El valor de retorno es un CategoryId que debe ser pasado al método DefineRule.

Vea el Ejemplo de Validación del Modelo para un ejemplo detallado del uso de este método.

Parámetros:

EA_OnInitializeUserRules

DefineRule

Ejemplo de Validación de Modelos

DeleteBaseline (string BaselineGUID)

Boolean

Elimina una Línea de Base, identificada por el BaselineGUID, desde el repositorio.

Parámetros:

DoBaselineCompare (

s

tring PackageGUID,

string Baseline,

string ConnectString)

String

Realiza una comparación Línea de Base utilizando el GUID del paquete proporcionado y el GUID de la Línea de Base (obtenido de la lista de resultados desde GetBaselines).

Opcionalmente puede incluir la cadena de conexión necesaria para encontrar la Línea de Base si existe en un archivo de modelo distinto.

Este método devuelve un archivo de registro del estado de todos los elementos encontrados y comparados en el procedimiento de diferencia. Puede utilizar esta información de registro como entrada a DoBaselineMerge - combinando automáticamente la información de la Línea de Base.

Parámetros:

GetBaselines

DoBaselineMerge

DoBaselineMerge (

string PackageGUID,

string Baseline,

string MergeInstructions,

string ConnectString)

String

Realiza una combinación de lotes basados en instrucciones contenidas en un archivo XML (MergeInstructions). Puede proporcionar una cadena de conexión opcional si la Línea de Base está localizada en otro modelo.

En el archivo MergeInstructions, cada nodo MergeItem proporciona el GUID de un ítem diferenciado desde el registro de diferencia XML. Como la combinación es unidireccional y accionada de sólo una manera posible, no se requieren argumentos adicionales. Enterprise Architect elige el procedimiento correcto basado en los resultados de Diferencia.

<Merge>

<MergeItem guid="{XXXXXX}" />

<MergeItem guid="{XXXXXX}" />

</Merge>

Alternativamente, puede proporcionar un único Mergeitem con un GUID de RestoreAll. En este caso, Enterprise Architect procesa por lotes TODAS las diferencias.

<Merge>

<MergeItem guid="RestoreAll" changed="true" baselineOnly="true" modelOnly="true" moved="true" fullRestore="false" />

</Merge>

Parámetros:

DoBaselineCompare()

EnumDiagramElements (

string DiagramGUID)

protected abstract: String

Obtiene una lista XML de todos los elementos de un diagrama.

Parámetros:

EnumDiagrams (

string PackageGUID)

protected abstract: String

Obtiene una lista XML de todos los diagramas de un paquete determinado.

Parámetros:

EnumElements (

string PackageGUID)

protected abstract: String

Obtiene una lista XML de todos los elementos de un paquete determinado.

Parámetros:

EnumLinks (

string ElementGUID)

protected abstract: String

Obtiene una lista XML de conectores para un elemento determinado.

Parámetros:

EnumPackages (

string PackageGUID)

protected abstract: String

Obtiene una lista XML de paquetes hijos dentro de un paquete padre.

Parámetros:

EnumProjects ()

protected abstract: String

Obtiene una lista de proyectos en el archivo actual; corresponde a Modelos en el Repositorio.

Modelos

EnumViews ()

protected abstract: String

Enumera las Vistas de un proyecto. Devuelto como un documento XML.

EnumViewEx (

string ProjectGUID)

protected abstract: String

Obtiene una lista de Vistas en el proyecto actual.

Parámetros:

Exit ()

protected abstract: String

Sale de la instancia actual de Enterprise Architect; esta función se mantiene por razones de compatibilidad con versiones anteriores y nunca debe ser llamado.

Enterprise Architect sale automáticamente cuando ya no está usando ninguno de los objetos proporcionados.

ExportPackageXMI (

string PackageGUID,

enumXMIType XMIType,

long DiagramXML,

long DiagramImage,

long FormatXML,

long UseDTD,

string FileName)

protected abstract: String

Exporta XMI para un paquete determinado.

Parámetros:

XMIType Enum

ExportPackageXMIEx (

string PackageGUID,

enumXMIType XMIType,

long DiagramXML,

long DiagramImage,

long FormatXML,

long UseDTD,

string FileName,

ea.ExportPackageXMIFlag Flags)

protected abstract: String

Exporta XMI para un determinado paquete, con una bandera para determinar si la exportación incluye el contenido del paquete debajo del primer nivel.

Parámetros:

Contenido de Paquete

XMIType Enum

Exportar Bandera XMI de Paquete

GenerateClass (

string ElementGUID,

string ExtraOptions)

Boolean

Genera el código para una única Clase.

Parámetros:

GenerateDiagramFromScenario (

string ElementGUID,

EnumScenarioDiagramType DiagramType,

long OverwriteExistingDiagram)

Boolean

Genera varios diagramas de la Especificación Estructurada de un elemento.

Parámetros:

ScenarioDiagramType Enum

GenerateElementDDL (

string ElementGUID,

string FileName,

string ExtraOptions)

Boolean

Genera DDL para un elemento

Por ejemplo:

owner=true;pkfkconstraints=true;commentlevel=3;

Parámetros:

GeneratePackage (

string PackageGUID,

string ExtraOptions)

Boolean

Genera el código para todas las Clases dentro de un paquete.

Por ejemplo:

recurse=1;overwrite=1;dir=C:\

Parámetros:

GeneratePackageDDL (

string PackageGUID,

string FileName,

string ExtraOptions)

Boolean

Genera DDL para un paquete.

Por ejemplo:

owner=true;pkfkconstraints=true;commentlevel=3;

singlefile=true;includechild=true;

Parámetros:

GenerateTestFromScenario (

string ElementGUID,

EnumScenarioTestType TestType)

Boolean

Genera una Prueba Interna o una Prueba Externa desde la Especificación Estructurada de un elemento.

Parámetros:

Generar Casos de Prueba

ScenarioTestType Enum

GenerateWSDL(

string WSDLComponentGUID,

string Filename,

string Encoding,

string ExtraOptions)

Boolean

Genera WSDL para el Componente estereotipado WSDL especificado.

Parámetros:

Servicios Web - WSDL

GenerateXSD (

string PackageGUID,

string FileName,

string Encoding,

string Options)

Boolean

Crea un esquema XML para un paquete, especificado por su GUID. Devuelve verdadero si es exitoso.

Parámetros:

GetBaselines (

string PackageGUID,

string ConnectString)

String

Devuelve una lista (en formato XML) de Líneas de Base asociadas con el GUID del paquete proporcionado. Opcionalmente, puede proporcionar una cadena de conexión para obtener Líneas de Base desde el mismo paquete, pero localizado en un archivo de modelo distinto (o DBMS).

Parámetros:

GetDiagram (

string DiagramGUID)

protected abstract: String

Obtiene los detalles del diagrama, en formato XML.

Parámetros:

GetElement (

string ElementGUID)

protected abstract: String

Obtiene XML para el elemento determinado.

Parámetros:

GetElementConstraints (

string ElementGUID)

protected abstract: String

Obtiene restricciones para un elemento, en formato XML.

Parámetros:

GetElementEffort (

string ElementGUID)

protected abstract: String

Obtiene esfuerzos para un elemento, en formato XML.

Parámetros:

GetElementFiles (

string ElementGUID)

protected abstract: String

Obtiene métricas para un elemento, en formato XML.

Parámetros:

GetElementMetrics (

string ElementGUID)

protected abstract: String

Obtiene archivos para un elemento, en formato XML.

Parámetros:

GetElementProblems (

string ElementGUID)

protected abstract: String

Obtiene una lista de problemas asociados con un elemento, en formato XML.

Parámetros:

GetElementProperties (

string ElementGUID)

protected abstract: String

Obtiene valores Etiquetados para un elemento, en formato XML.

Parámetros:

GetElementRequirements (

string ElementGUID)

protected abstract: String

Obtiene una lista de requisitos para un elemento, en formato XML.

Parámetros:

GetElementResources (

string ElementGUID)

protected abstract: String

Obtiene una lista de recursos para un elemento, en formato XML.

Parámetros:

GetElementRisks (

string ElementGUID)

protected abstract: String

Obtiene una lista de riesgos asociados con un elemento, en formato XML.

Parámetros:

GetElementScenarios (

string ElementGUID)

protected abstract: String

Obtiene una lista de escenarios para un elemento, en formato XML.

Parámetros:

GetElementTests (

string ElementGUID)

protected abstract: String

Obtiene una lista de pruebas para un elemento, en formato XML.

Parámetros:

GetFileNameDialog (

string Filename,

string FilterString,

long FilterIndex,

long Flags,

string InitialDirectory,

long OpenOrSave)

String

Abre una ventana estándar de Abrir Archivo o Guardar Como y devuelve una cadena que contiene la ruta completa del archivo seleccionado en caso de éxito. Devuelve una cadena vacía si la ventana fue cancelada.

Por ejemplo:

Filename = ""

FilterString = "CSV Files (*.csv)|*.csv|All Files (*.*)|*.*||"

Filterindex = 1

Flags = &H2 'OFN_OVERWRITEPROMPT

InitialDirectory = ""

OpenOrSave = 1

filepath = Project.GetFileNameDialog (Filename, FilterString, Filterindex, Flags, InitialDirectory, OpenOrSave)

En este ejemplo, la ventana Guardar Como le solicitará un archivo CSV.

Parámetros:

GetLastError ()

protected abstract: String

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

GetLink (

string LinkGUID)

protected abstract: String

Obtiene los detalles del conector, en formato XML.

Parámetros:

GUIDtoXML (

string GUID)

String

Cambia un GUID interno a la forma utilizada en XML.

Parámetros:

ImportDirectory (

string PackageGUID,

string Language,

string DirectoryPath,

string ExtraOptions)

Boolean

Importa un directorio de código fuente al modelo.

Parámetros:

ImportFile (

string PackageGUID,

string Language,

string FileName,

string ExtraOptions)

Boolean

Importa un archivo individual o un módulo binario al modelo, en un paquete por importación de estilo del espacio de nombres.

Parámetros:

Utilice el valor "DNPE" para importar un módulo binario; esto importa un ensamblado de .Net o un archivo Java .class, pero no un archivo .jar.

ImportPackageXMI (

string PackageGUID,

string Filename,

long ImportDiagrams,

long StripGUID)

String

Importa un archivo XMI en un punto del árbol.

Parámetros:

Si la cadena es de tipo nombre de archivo se interpreta como un archivo fuente; en caso contrario, la cadena se importa como texto XML.

Devuelve una cadena vacía si fue exitoso, o devuelve un mensaje de error si hubo un fallo.

LayoutDiagram (

string DiagramGUID,

long LayoutStyle)

Boolean

Obsoleto. Es recomendable que sea utilizado LayoutDiagramEx en su lugar.

Llama a la función para diseñar automáticamente un diagrama de manera jerárquica. Sólo se recomienda para los diagramas de Clases y Objetos.

Parámetros:

LayoutDiagramEx (

string DiagramGUID,

long LayoutStyle,

long Iterations,

long LayerSpacing,

long ColumnSpacing,

boolean SaveToDiagram)

Boolean

Llama a la función para diseñar automáticamente un diagrama de manera jerárquica. Sólo se recomienda para los diagramas de Clases y Objetos.

LayoutStyle acepta las siguientes opciones

lsDiagramDefault

lsProgramDefault

lsCycleRemoveGreedy

lsCycleRemoveDFS

lsLayeringLongestPathSink

lsLayeringLongestPathSource

lsLayeringOptimalLinkLength

IsInitializeNaive

IsInitializeDFSOut

IsInitializeDFSIn

lsCrossReduceAggressive

lsLayoutDirectionUp

lsLayoutDirectionDown

lsLayoutDirectionLeft

lsLayoutDirectionRight

Parámetros:

ConstLayoutStyles Enum

LoadControlledPackage (

string PackageGUID)

String

Carga un paquete que ha sido marcado y configurado como controlado. Los detalles del nombre de archivo se almacenan en los datos del control de paquetes.

Parámetros:

LoadDiagram (

string DiagramGUID)

protected abstract: Boolean

Carga un diagrama por su GUID.

Parámetro:

GUIDtoXML

LoadProject (

string FileName)

protected abstract: Boolean

Carga un archivo de proyecto de Enterprise Architect.

No utilice este método si ha accedido a la interfaz del Proyecto desde el Repositorio, que ya ha cargado un archivo.

Parámetros:

Migrate (

string GUID,

string SourceType,

string DestinationType)

Void

Migra un modelo (o de una parte de un modelo) desde un formato BPMN o SysML a un formato actualizado.

Parámetros:

MigrateToBPMN11 (

string GUID,

string Type)

Void

Migra cada construcción BPMN 1.0 en un paquete o elemento (incluyendo elementos, atributos, diagramas y conectores) a BPMN 1.1.

Parámetros

Migrar a BPEL es posible sólo en las ediciones Ultimate o de Ingeniería de Negocios y Software de Enterprise Architect.

ProjectTransfer (

string SourceFilePath,

string TargetFilePath,

string LogFilePath)

Boolean

Transfiere el proyecto de un archivo .EAP o DBMS a un archivo .EAP.

Parámetros:

En automatización, el archivo de destino no tiene que existir; la ruta del archivo es suficiente. Enterprise Architect crea un nuevo, archivo fuente Base.EAP vacío y le transfiere la fuente.

PublishResult (

string CategoryID,

EA.EnumMVErrorType ErrorType,

string ErrorMessage)

String

Devuelve los resultados de cada regla que puede ser realizada durante la validación del modelo. Debe ser llamado una vez para cada regla de el manejador de transmisión EA_OnInitializeUserRules.

El valor de retorno es una Regla, la cual puede ser utilizada para fines de referencia cuando una regla individual es ejecutada por Enterprise Architect durante la validación del modelo.

Vea el Ejemplo de Validación del Modelo para un ejemplo detallado del uso de este método.

Parámetros:

EA_OnInitializeUserRules

Ejemplo de Validación de Modelos

DefineRuleCategory

PutDiagramImageOnClipboard (

string DiagramGUID,

long Type)

protected abstract: Boolean

Copia una imagen del diagrama especificado al portapapeles.

Parámetros:

PutDiagramImageToFile (

string Diagram GUID,

string FileName,

long Type)

protected abstract: Boolean

Guarda una imagen del diagrama especificado en el archivo.

Parámetros:

ReloadProject ()

protected abstract: Boolean

Volver a cargar el proyecto actual.

Este es un método conveniente para actualizar el actual proyecto cargado (en caso de cambios en el archivo .EAP).

RunModelSearch (

string Search,

string SearchTerm,

bool ShowInEA)

Void

Invoca el componente de la Búsqueda de Modelo.

Parámetros:

Búsqueda Modelo

Clase Repositorio (una llamada diferente para Ejecutar la Búsqueda de Modelo)

RunReport (

string PackageGUID,

string TemplateName,

string Filename)

protected abstract: Void

Ejecuta un informe de documento nombrado.

Parámetros:

Generar Documentación

Documentos Virtuales

RunHTMLReport (

string PackageGUID,

string ExportPath,

string ImageFormat,

string Style,

string Extension)

String

Ejecuta un informe HTML (como en el caso de Documentación | Documentación HTML cuando hace clic derecho en un paquete en el Explorador del Proyectos).

Parámetros:

Crear un Informe HTML

Documentos Maestros y Documentos Modelo

SaveControlledPackage (

string PackageGUID)

String

Guarda un paquete que se ha configurado como un paquete controlado, de XMI. Sólo se requiere el GUID del paquete, Enterprise Architect recoge el resto de la información de control del paquete.

Parámetro:

SaveDiagramImageToFile (

string Filename)

protected abstract: String

Guarda una imagen del diagrama del diagrama actual para en el archivo.

Parámetros:

ShowWindow (

long Show)

protected abstract: Void

Muestra u oculta la interfaz de Usuario de Enterprise Architect.

Parámetros:

SynchronizeClass (

string ElementGUID,

string ExtraOptions)

Boolean

Sincroniza una Clase con el último código fuente.

Parámetros:

SynchronizePackage (

string PackageGUID,

string ExtraOptions)

Boolean

Sincroniza cada Clase en un paquete con el último código fuente.

Parámetros:

TransformElement (

string TransformName,

string ElementGUID,

string TargetPackage,

string ExtraOptions)

Boolean

Transforma un elemento en un Paquete

Parámetros:

TransformPackage (

string TransformName,

string SourcePackage,

string TargetPackage,

string ExtraOptions)

Boolean

Ejecuta una transformación en el contenido de un paquete.

Parámetros:

ValidateDiagram (

string DiagramGUID)

Boolean

Invoca el componente de Validación del Modelo de Enterprise Architect, luego valida el diagrama y elementos (para corregir) y los elementos y conectores dentro del diagrama.

La Salida puede ser vista a través de Vista | Salida del Sistema > Validación del Modelo.

Devuelve un valor booleano para indicar el éxito o el fracaso del proceso, independientemente de los resultados de la validación.

Parámetros:

Validación de Modelo

ValidateElement (

string ElementGUID)

Boolean

Invoca el componente de Validación del Modelo de Enterprise Architect, luego valida el elemento y todos los elementos, diagramas, conectores, atributos y operaciones hijos.

La Salida puede ser vista a través de Vista | Salida del Sistema > Validación del Modelo.

Devuelve un valor booleano para indicar el éxito o el fracaso del proceso, independientemente de los resultados de la validación.

Parámetros:

ValidatePackage (

string PackageGUID)

Boolean

Invoca el componente de Validación del Modelo de Enterprise Architect, luego valida el paquete y todos los sub-paquetes, elementos, conectores y diagramas dentro de él.

La Salida puede ser vista a través de Vista | Salida del Sistema > Validación del Modelo.

Devuelve un valor booleano para indicar el éxito o el fracaso del proceso, independientemente de los resultados de la validación.

Parámetros:

XMLtoGUID (

string GUID)

String

Cambia un GUID en formato XML para que sea la forma utilizada dentro de Enterprise Architect.

Parámetros:

•

Todos estos métodos requieren GUIDs de entrada en formato XML; utilice GUIDtoXML para cambiar el GUID de Enterprise Architect a un GUID XML

•

GUIDtoXML