diff --git a/_data/pages.yml b/_data/pages.yml index f2f0f2fb6..3fffbc571 100644 --- a/_data/pages.yml +++ b/_data/pages.yml @@ -34,6 +34,8 @@ - title: Nightly file: ref-doc/nightly/index #---TAG--- + - title: 3.3.3 + file: ref-doc/3.3.3/index - title: 3.3.2 file: ref-doc/3.3.2/index - title: 3.3.1 diff --git a/ref-doc/3.3.3/images/DBResult.png b/ref-doc/3.3.3/images/DBResult.png new file mode 100644 index 000000000..a763544dc Binary files /dev/null and b/ref-doc/3.3.3/images/DBResult.png differ diff --git a/ref-doc/3.3.3/images/DBTemplate.png b/ref-doc/3.3.3/images/DBTemplate.png new file mode 100644 index 000000000..fd15ae920 Binary files /dev/null and b/ref-doc/3.3.3/images/DBTemplate.png differ diff --git a/ref-doc/3.3.3/images/Edit Documentation Configuration menu.png b/ref-doc/3.3.3/images/Edit Documentation Configuration menu.png new file mode 100644 index 000000000..09f127e18 Binary files /dev/null and b/ref-doc/3.3.3/images/Edit Documentation Configuration menu.png differ diff --git a/ref-doc/3.3.3/images/Edit Template Properties menu.png b/ref-doc/3.3.3/images/Edit Template Properties menu.png new file mode 100644 index 000000000..858eb253c Binary files /dev/null and b/ref-doc/3.3.3/images/Edit Template Properties menu.png differ diff --git a/ref-doc/3.3.3/images/Extracting information.png b/ref-doc/3.3.3/images/Extracting information.png new file mode 100644 index 000000000..8dbd9b128 Binary files /dev/null and b/ref-doc/3.3.3/images/Extracting information.png differ diff --git a/ref-doc/3.3.3/images/Field edition.png b/ref-doc/3.3.3/images/Field edition.png new file mode 100644 index 000000000..b66a1edff Binary files /dev/null and b/ref-doc/3.3.3/images/Field edition.png differ diff --git a/ref-doc/3.3.3/images/Field visualization edition (copie).png b/ref-doc/3.3.3/images/Field visualization edition (copie).png new file mode 100644 index 000000000..b66a1edff Binary files /dev/null and b/ref-doc/3.3.3/images/Field visualization edition (copie).png differ diff --git a/ref-doc/3.3.3/images/Field visualization.png b/ref-doc/3.3.3/images/Field visualization.png new file mode 100644 index 000000000..962c579bd Binary files /dev/null and b/ref-doc/3.3.3/images/Field visualization.png differ diff --git a/ref-doc/3.3.3/images/Formatting template.png b/ref-doc/3.3.3/images/Formatting template.png new file mode 100644 index 000000000..a2d3c0f1b Binary files /dev/null and b/ref-doc/3.3.3/images/Formatting template.png differ diff --git a/ref-doc/3.3.3/images/Generate Documentation menu.png b/ref-doc/3.3.3/images/Generate Documentation menu.png new file mode 100644 index 000000000..8c93feb84 Binary files /dev/null and b/ref-doc/3.3.3/images/Generate Documentation menu.png differ diff --git a/ref-doc/3.3.3/images/Generation Configuration Wizard1.png b/ref-doc/3.3.3/images/Generation Configuration Wizard1.png new file mode 100644 index 000000000..c2f6ba85a Binary files /dev/null and b/ref-doc/3.3.3/images/Generation Configuration Wizard1.png differ diff --git a/ref-doc/3.3.3/images/Generation Configuration Wizard2.png b/ref-doc/3.3.3/images/Generation Configuration Wizard2.png new file mode 100644 index 000000000..fa708925b Binary files /dev/null and b/ref-doc/3.3.3/images/Generation Configuration Wizard2.png differ diff --git a/ref-doc/3.3.3/images/Import Wizard Selection.png b/ref-doc/3.3.3/images/Import Wizard Selection.png new file mode 100644 index 000000000..f0fa350d1 Binary files /dev/null and b/ref-doc/3.3.3/images/Import Wizard Selection.png differ diff --git a/ref-doc/3.3.3/images/Import menu.png b/ref-doc/3.3.3/images/Import menu.png new file mode 100644 index 000000000..d5d8fa4c9 Binary files /dev/null and b/ref-doc/3.3.3/images/Import menu.png differ diff --git a/ref-doc/3.3.3/images/Initialize Documentation Configuration menu.png b/ref-doc/3.3.3/images/Initialize Documentation Configuration menu.png new file mode 100644 index 000000000..8cb224ad3 Binary files /dev/null and b/ref-doc/3.3.3/images/Initialize Documentation Configuration menu.png differ diff --git a/ref-doc/3.3.3/images/Interpreter view1.png b/ref-doc/3.3.3/images/Interpreter view1.png new file mode 100644 index 000000000..4ec4700f2 Binary files /dev/null and b/ref-doc/3.3.3/images/Interpreter view1.png differ diff --git a/ref-doc/3.3.3/images/Interpreter view2.png b/ref-doc/3.3.3/images/Interpreter view2.png new file mode 100644 index 000000000..09e44d20e Binary files /dev/null and b/ref-doc/3.3.3/images/Interpreter view2.png differ diff --git a/ref-doc/3.3.3/images/Interpreter view3.png b/ref-doc/3.3.3/images/Interpreter view3.png new file mode 100644 index 000000000..e7fb35ef2 Binary files /dev/null and b/ref-doc/3.3.3/images/Interpreter view3.png differ diff --git a/ref-doc/3.3.3/images/Interpreter view4.png b/ref-doc/3.3.3/images/Interpreter view4.png new file mode 100644 index 000000000..79b7129ad Binary files /dev/null and b/ref-doc/3.3.3/images/Interpreter view4.png differ diff --git a/ref-doc/3.3.3/images/Interpreter view5.png b/ref-doc/3.3.3/images/Interpreter view5.png new file mode 100644 index 000000000..d4d8a42ec Binary files /dev/null and b/ref-doc/3.3.3/images/Interpreter view5.png differ diff --git a/ref-doc/3.3.3/images/Interpreter view6.png b/ref-doc/3.3.3/images/Interpreter view6.png new file mode 100644 index 000000000..73110d228 Binary files /dev/null and b/ref-doc/3.3.3/images/Interpreter view6.png differ diff --git a/ref-doc/3.3.3/images/Interpreter view7.png b/ref-doc/3.3.3/images/Interpreter view7.png new file mode 100644 index 000000000..223378d3b Binary files /dev/null and b/ref-doc/3.3.3/images/Interpreter view7.png differ diff --git a/ref-doc/3.3.3/images/M2Doc Generate Template menu.png b/ref-doc/3.3.3/images/M2Doc Generate Template menu.png new file mode 100644 index 000000000..01aca2e72 Binary files /dev/null and b/ref-doc/3.3.3/images/M2Doc Generate Template menu.png differ diff --git a/ref-doc/3.3.3/images/M2Doc Update Document menu.png b/ref-doc/3.3.3/images/M2Doc Update Document menu.png new file mode 100644 index 000000000..5bf460628 Binary files /dev/null and b/ref-doc/3.3.3/images/M2Doc Update Document menu.png differ diff --git a/ref-doc/3.3.3/images/M2DocWorkflow.png b/ref-doc/3.3.3/images/M2DocWorkflow.png new file mode 100644 index 000000000..d3377f2b8 Binary files /dev/null and b/ref-doc/3.3.3/images/M2DocWorkflow.png differ diff --git a/ref-doc/3.3.3/images/Main steps.png b/ref-doc/3.3.3/images/Main steps.png new file mode 100644 index 000000000..66a54339e Binary files /dev/null and b/ref-doc/3.3.3/images/Main steps.png differ diff --git a/ref-doc/3.3.3/images/New Project Wizard1.png b/ref-doc/3.3.3/images/New Project Wizard1.png new file mode 100644 index 000000000..2fd0074c8 Binary files /dev/null and b/ref-doc/3.3.3/images/New Project Wizard1.png differ diff --git a/ref-doc/3.3.3/images/New Project Wizard2.png b/ref-doc/3.3.3/images/New Project Wizard2.png new file mode 100644 index 000000000..f01495812 Binary files /dev/null and b/ref-doc/3.3.3/images/New Project Wizard2.png differ diff --git a/ref-doc/3.3.3/images/New Project Wizard3.png b/ref-doc/3.3.3/images/New Project Wizard3.png new file mode 100644 index 000000000..3a8cae9b0 Binary files /dev/null and b/ref-doc/3.3.3/images/New Project Wizard3.png differ diff --git a/ref-doc/3.3.3/images/New Project Wizard4.png b/ref-doc/3.3.3/images/New Project Wizard4.png new file mode 100644 index 000000000..badfe880e Binary files /dev/null and b/ref-doc/3.3.3/images/New Project Wizard4.png differ diff --git a/ref-doc/3.3.3/images/New Project Wizard5.png b/ref-doc/3.3.3/images/New Project Wizard5.png new file mode 100644 index 000000000..ea27944df Binary files /dev/null and b/ref-doc/3.3.3/images/New Project Wizard5.png differ diff --git a/ref-doc/3.3.3/images/New Project Wizard6.png b/ref-doc/3.3.3/images/New Project Wizard6.png new file mode 100644 index 000000000..2f3c11e48 Binary files /dev/null and b/ref-doc/3.3.3/images/New Project Wizard6.png differ diff --git a/ref-doc/3.3.3/images/New Project Wizard7.png b/ref-doc/3.3.3/images/New Project Wizard7.png new file mode 100644 index 000000000..59f215bb7 Binary files /dev/null and b/ref-doc/3.3.3/images/New Project Wizard7.png differ diff --git a/ref-doc/3.3.3/images/New Project Wizard8.png b/ref-doc/3.3.3/images/New Project Wizard8.png new file mode 100644 index 000000000..478fec0c5 Binary files /dev/null and b/ref-doc/3.3.3/images/New Project Wizard8.png differ diff --git a/ref-doc/3.3.3/images/New Template Wizard1.png b/ref-doc/3.3.3/images/New Template Wizard1.png new file mode 100644 index 000000000..222b5c942 Binary files /dev/null and b/ref-doc/3.3.3/images/New Template Wizard1.png differ diff --git a/ref-doc/3.3.3/images/New Template Wizard2.png b/ref-doc/3.3.3/images/New Template Wizard2.png new file mode 100644 index 000000000..1c3f53157 Binary files /dev/null and b/ref-doc/3.3.3/images/New Template Wizard2.png differ diff --git a/ref-doc/3.3.3/images/New Template Wizard3.png b/ref-doc/3.3.3/images/New Template Wizard3.png new file mode 100644 index 000000000..53ea34db3 Binary files /dev/null and b/ref-doc/3.3.3/images/New Template Wizard3.png differ diff --git a/ref-doc/3.3.3/images/New Template Wizard4.png b/ref-doc/3.3.3/images/New Template Wizard4.png new file mode 100644 index 000000000..ea27944df Binary files /dev/null and b/ref-doc/3.3.3/images/New Template Wizard4.png differ diff --git a/ref-doc/3.3.3/images/New Template Wizard5.png b/ref-doc/3.3.3/images/New Template Wizard5.png new file mode 100644 index 000000000..2f3c11e48 Binary files /dev/null and b/ref-doc/3.3.3/images/New Template Wizard5.png differ diff --git a/ref-doc/3.3.3/images/New Template Wizard6.png b/ref-doc/3.3.3/images/New Template Wizard6.png new file mode 100644 index 000000000..e4c9331c3 Binary files /dev/null and b/ref-doc/3.3.3/images/New Template Wizard6.png differ diff --git a/ref-doc/3.3.3/images/Open with menu.png b/ref-doc/3.3.3/images/Open with menu.png new file mode 100644 index 000000000..98f7db149 Binary files /dev/null and b/ref-doc/3.3.3/images/Open with menu.png differ diff --git a/ref-doc/3.3.3/images/Package selection dialog.png b/ref-doc/3.3.3/images/Package selection dialog.png new file mode 100644 index 000000000..10cf55290 Binary files /dev/null and b/ref-doc/3.3.3/images/Package selection dialog.png differ diff --git a/ref-doc/3.3.3/images/Service selection dialog.png b/ref-doc/3.3.3/images/Service selection dialog.png new file mode 100644 index 000000000..66300dea8 Binary files /dev/null and b/ref-doc/3.3.3/images/Service selection dialog.png differ diff --git a/ref-doc/3.3.3/images/Service token selection dialog.png b/ref-doc/3.3.3/images/Service token selection dialog.png new file mode 100644 index 000000000..e66c34b1a Binary files /dev/null and b/ref-doc/3.3.3/images/Service token selection dialog.png differ diff --git a/ref-doc/3.3.3/images/TechnicalArchitecture.png b/ref-doc/3.3.3/images/TechnicalArchitecture.png new file mode 100644 index 000000000..261b63af8 Binary files /dev/null and b/ref-doc/3.3.3/images/TechnicalArchitecture.png differ diff --git a/ref-doc/3.3.3/images/Template Import Wizard1.png b/ref-doc/3.3.3/images/Template Import Wizard1.png new file mode 100644 index 000000000..7fef3206b Binary files /dev/null and b/ref-doc/3.3.3/images/Template Import Wizard1.png differ diff --git a/ref-doc/3.3.3/images/Template Import Wizard2.png b/ref-doc/3.3.3/images/Template Import Wizard2.png new file mode 100644 index 000000000..0f0ebfde0 Binary files /dev/null and b/ref-doc/3.3.3/images/Template Import Wizard2.png differ diff --git a/ref-doc/3.3.3/images/Template Properties Wizard1 with included tokens.png b/ref-doc/3.3.3/images/Template Properties Wizard1 with included tokens.png new file mode 100644 index 000000000..47a6f36de Binary files /dev/null and b/ref-doc/3.3.3/images/Template Properties Wizard1 with included tokens.png differ diff --git a/ref-doc/3.3.3/images/Template Properties Wizard1.png b/ref-doc/3.3.3/images/Template Properties Wizard1.png new file mode 100644 index 000000000..5157748fd Binary files /dev/null and b/ref-doc/3.3.3/images/Template Properties Wizard1.png differ diff --git a/ref-doc/3.3.3/images/Template Properties Wizard2.png b/ref-doc/3.3.3/images/Template Properties Wizard2.png new file mode 100644 index 000000000..0bf6e70d5 Binary files /dev/null and b/ref-doc/3.3.3/images/Template Properties Wizard2.png differ diff --git a/ref-doc/3.3.3/images/Validate Documentation menu.png b/ref-doc/3.3.3/images/Validate Documentation menu.png new file mode 100644 index 000000000..7125e47f9 Binary files /dev/null and b/ref-doc/3.3.3/images/Validate Documentation menu.png differ diff --git a/ref-doc/3.3.3/images/Variable definition.png b/ref-doc/3.3.3/images/Variable definition.png new file mode 100644 index 000000000..d0b28f132 Binary files /dev/null and b/ref-doc/3.3.3/images/Variable definition.png differ diff --git a/ref-doc/3.3.3/images/m2doc-overview.png b/ref-doc/3.3.3/images/m2doc-overview.png new file mode 100644 index 000000000..a5901001a Binary files /dev/null and b/ref-doc/3.3.3/images/m2doc-overview.png differ diff --git a/ref-doc/3.3.3/index.md b/ref-doc/3.3.3/index.md new file mode 100644 index 000000000..e48df7084 --- /dev/null +++ b/ref-doc/3.3.3/index.md @@ -0,0 +1,655 @@ +--- +layout: article +title: Reference Documentation +subtitle: 3.3.3 +relativePath: ../.. +--- + +# Table of Content + +Following you will find the reference documentation corresponding to the **3.3.3** version. +If you need an other version use one of our [released versions]({{page.relativePath}}/download/#all-versions). + +* TOC +{:toc} + +## Overview + +The M2Doc project provides Word document (.docx files) generation based on a document template and [EMF](https://www.eclipse.dev/modeling/emf/) models. + +The overall approach consists in creating templates in the [OOXML](https://en.wikipedia.org/wiki/Office_Open_XML) format where static text authoring benefits from the WYSIWYG capabilities of Microsoft Word. Dynamic parts are inserted using a dedicated vocabulary of [OOXML](https://en.wikipedia.org/wiki/Office_Open_XML) fields code. Fields are mainly used to insert page numbers, references, etc. M2Doc makes use of them to describe documentation generation directives. This allows a total separation between the document and the M2Doc directives. + +![Overview]({{page.relativePath}}/ref-doc/3.3.3/images/m2doc-overview.png) + +As an example, here is a fragment of a M2Doc template used to generate the documentation of a database model: + +![DB Template]({{page.relativePath}}/ref-doc/3.3.3/images/DBTemplate.png) + +The generation looks like this: + +![DB Result]({{page.relativePath}}/ref-doc/3.3.3/images/DBResult.png) + +The template language makes an extensive use of the [Acceleo Query Language](https://www.eclipse.dev/acceleo/documentation/aql.html) which provides a full-fledged, extensible model query language and engine. +The M2Doc templates can be [validated](index.html#validating-a-generation-setup). If errors are found, an annotated templates is produced describing the problems found. + +### Principles + +* Definition of model entry points + * Declaration of variables (see the [Template properties wizard](index.html#template-properties-wizard) section) + * Mapping with model elements (see the [Generation configuration wizard](index.html#generation-configuration-wizard) section) + +![Variable definition]({{page.relativePath}}/ref-doc/3.3.3/images/Variable%20definition.png "Variable definition.") + +* Extraction of information by navigating the model (see the [Template authoring](index.html#template-authoring) section) + * From the entry points + * Using model relations + +![Extracting information]({{page.relativePath}}/ref-doc/3.3.3/images/Extracting%20information.png "Extracting information.") + +* Formatting of the output information + * Using Microsoft Word functionalities + +![Formatting template]({{page.relativePath}}/ref-doc/3.3.3/images/Formatting%20template.png "Formatting template.") + +### Main steps + +* Definition of content, navigation, and format (see the [Template authoring](index.html#template-authoring) section) +* Declaration of variables (see the [Template properties wizard](index.html#template-properties-wizard) section) +* Mapping of variables with model elements, definition of input model and output file (see the [Generation configuration wizard](index.html#generation-configuration-wizard) section) +* Generation of output document (see the [Generate a document](index.html#generating-a-document) section) + +![Main steps]({{page.relativePath}}/ref-doc/3.3.3/images/Main%20steps.png "Main steps.") + +### M2Doc roles + +Ready to try M2Doc! You might have one of the following roles: + +#### Template user + +You already have the template and want to generate the document: + +* see [Generate a document](index.html#generating-a-document) +* see [Maven](index.html#maven) (optional) + +#### Template developer + +You want to create your own template: + +* see [Template authoring](index.html#template-authoring) +* see [Provide new services](index.html#providing-new-services) (optional) +* see [Validating a generation](index.html#validating-a-generation-setup) (optional) +* see [Template testing](index.html#template-testing) (optional) + +#### Integrator + +You want to provide document generation in your own project using M2Doc: + +* see [Using M2Doc programmatically](index.html#using-m2doc-programmatically) +* see [Using AQL programmatically](https://www.eclipse.dev/acceleo/documentation/aql.html#UsingAQLprogrammatically) (optional) + +## Architecture + +The main workflow: + +![M2Doc Workflow]({{page.relativePath}}/ref-doc/3.3.3/images/M2DocWorkflow.png) + +The template is parsed in an internal representation (the AST). From here you can bind the variables to their values, using elements from a model for instance and evaluate the template to generate the output document. An added benefit of using M2Doc is the hability to [validate](index.html#validating-a-generation-setup) a template to produce an annotated template containing informations, warnings and errors the template might contain. + +The architecture of M2Doc is organized around three building blocks: +* [Apache POI](https://poi.apache.org/) for the parsing and generation of [OOXML](https://en.wikipedia.org/wiki/Office_Open_XML) documents +* [AQL](https://www.eclipse.dev/acceleo/documentation/aql.html) for querying the models +* [EMF](https://www.eclipse.dev/modeling/emf/) as a general platform + +![Technical architecture]({{page.relativePath}}/ref-doc/3.3.3/images/TechnicalArchitecture.png) + + +## Generating a document + +To generate a document you will need at least a template file (.docx file) and a generation configuration model (.genconf file). If you don’t have the template you can read the [template authoring](index.html#template-authoring) section. To create a generation model file you can read the [initialize generation](index.html#initializing-a-generation-configuration) section. + +### Launching a generation + +To launch a generation you can right click on the generation configuration model (.genconf file) or the Generation object and select the «Generate Documentation menu» as shown here: + +![The Generate Documentation menu.]({{page.relativePath}}/ref-doc/3.3.3/images/Generate%20Documentation%20menu.png "The Generate Documentation menu.") + +You can also use the «M2Doc Generate Template» menu on the template that is referenced by one or more generation configuration models (.genconf file): + +![The M2Doc Generate Template menu.]({{page.relativePath}}/ref-doc/3.3.3/images/M2Doc%20Generate%20Template%20menu.png "The M2Doc Generate Template menu.") + +Or the «M2Doc Update Document» menu on the generated document that is referenced by one or more generation configuration models (.genconf file): + +![The M2Doc Update Document menu.]({{page.relativePath}}/ref-doc/3.3.3/images/M2Doc%20Update%20Document%20menu.png "The M2Doc Generate Document menu.") + +If you don’t have the the generation model configuration file you can create it using the [initialize generation](index.html#initializing-a-generation-configuration) section. + +### Initializing a generation configuration + +To initialize a generation configuration you will need a template file (.docx file). If you don’t have the template you can read the [template authoring](index.html#template-authoring) section. + +Right click on the template file and select the «Initialize Documentation Configuration» menu: + +![The Initialize Documentation Configuration menu.]({{page.relativePath}}/ref-doc/3.3.3/images/Initialize%20Documentation%20Configuration%20menu.png "The Initialize Documentation Configuration menu.") + +To edit the created generation model file you can use the [Generation configuration wizard](index.html#generation-configuration-wizard). + +### Validating a generation setup + +To validate a generation setup (template plus generation configuration) you can right click on the generation configuration model (.genconf file) or the Generation object and select the «Validate Documentation menu» as shown here: + +![The Validate Documentation menu.]({{page.relativePath}}/ref-doc/3.3.3/images/Validate%20Documentation%20menu.png "The Validate Documentation menu.") + +If you don’t have the the generation configuration model file you can create it using the [initialize generation](index.html#initializing-a-generation-configuration) section. If the validation succeeds with no informations, warnings, or errors you will be prompted. If something went wrong a .docx file with the name of the template and suffixed with «info», «warning», or «error» will be created. This new file contains details of the validation issues. The template is *not* modified. + +### Generation configuration wizard + +You can access the generation configuration wizard in two different ways, one for creating it and one for further edition when the .genconf file already exists. + +To create and initialize the generation configuration, select the template .docx file to use for generation and right click on it: + +![The Initialize Documentation Configuration menu.]({{page.relativePath}}/ref-doc/3.3.3/images/Initialize%20Documentation%20Configuration%20menu.png "The Initialize Documentation Configuration menu.") + +To edit an existing generation configuration .genconf file you can select the .genconf file and right click on it: + +![The Edit Documentation Configuration menu.]({{page.relativePath}}/ref-doc/3.3.3/images/Edit%20Documentation%20Configuration%20menu.png "The Edit Documentation Configuration menu.") + +At this point you should be on the first page of the generation configuration wizard: + +![The Generation Configuration Wizard.]({{page.relativePath}}/ref-doc/3.3.3/images/Generation%20Configuration%20Wizard1.png "The Generation Configuration Wizard.") + +On this page you can select the path of the generation configuration .genconf file. It can be changed to create a copy of an existing file for instance. Other file paths are relative to the generation configuration file. This allow to move a folder containing all the files needed for a generation without breaking the generation configuration. The template can be selected from the workspace or the [Template registry](index.html#template-registry). In the later case the path will be absolute to reference the template in the deployed plug-ins. + +The next page of the wizard is dedicated to variables and binding values to them: + +![The Generation Configuration Wizard.]({{page.relativePath}}/ref-doc/3.3.3/images/Generation%20Configuration%20Wizard2.png "The Generation Configuration Wizard.") + +To reference new values you can load new resources using the `Load resource` button. Note the `Options (expert)` tab that allow to set advanced options to find values from a Sirius session for instance. + +If you are using M2Doc with [Sirius](https://www.eclipse.dev/sirius/), [Obeo Designer](https://www.obeodesigner.com/en/), [Obeo Designer Team](https://www.obeodesigner.com/en/collaborative-features), [Capella](https://mbse-capella.org/), or [Team for Capella](https://www.obeosoft.com/en/capella-professional-offer), you need to set the SiriusSession option. This will allow you to use [Sirius services](index.html#services) like exporting diagrams as images: + +![SiriusSession Option.]({{page.relativePath}}/capella/images/SiriusSession%20Option.png "SiriusSession Option.") + +Setting this option should allow you to select model elements for each model variable you have in your template. By default the first element matching the declared type of the variable will be selected, but you can edit the value by selecting the variable and using the edit button: + +![Edit Variable.]({{page.relativePath}}/capella/images/Edit%20Variable.png "Edit Variable.") + +When the `Finish` button is pushed the generation configuration file is created or edited. + +You can also use M2Doc with [Team for Capella](https://www.obeosoft.com/en/capella-professional-offer) or [Obeo Designer Team](https://www.obeodesigner.com/en/collaborative-features). If you had existing .genconf files before you shared your project to Team for Capella or Obeo Designer Team, you will need to edit them. + +First you need to change the SiriusSession since the .aird file has been renamed. You should need to add "team" like this: + +* In-Flight Entertainment System.aird + +becomes: + +* In-Flight Entertainment System.team.aird + +Secondly you will need to set the value of your model variables since the model has been moved to the Team server. By default the first element matching the declared type of the variable will be selected, but you can edit the value by selecting the variable and using the edit button: + +![Edit Variable.]({{page.relativePath}}/capella/images/Edit%20Variable.png "Edit Variable.") + +You will see your model to select the value from: + +![Select Variable Value.]({{page.relativePath}}/capella/images/Select%20Variable%20Value.png "Select Variable Value.") + + +## Template authoring + +You need to have a model already to be able to generate a document with M2Doc. Then you can [create a project](index.html#new-project-wizard) or if you already have a project, you can [create a template](index.html#new-template-wizard). + +### New project wizard + +This wizard allows to create all needed artifacts: + +- an Eclipse project +- a default template +- the genconf file + +You only need your model as input. + +To launch the wizard right click in the project exporer and select new project: + +![The New project Wizard.]({{page.relativePath}}/ref-doc/3.3.3/images/New%20Project%20Wizard1.png "The New project Wizard.") + +Then select M2Doc project in the M2Doc category: + +![The New project Wizard.]({{page.relativePath}}/ref-doc/3.3.3/images/New%20Project%20Wizard2.png "The New project Wizard.") + +Enter your project name and click next: + +![The New project Wizard.]({{page.relativePath}}/ref-doc/3.3.3/images/New%20Project%20Wizard3.png "The New project Wizard.") + +Enter your template name and click next: + +![The New project Wizard.]({{page.relativePath}}/ref-doc/3.3.3/images/New%20Project%20Wizard4.png "The New project Wizard.") + +Select the main variable value and name then click next: + +![The New project Wizard.]({{page.relativePath}}/ref-doc/3.3.3/images/New%20Project%20Wizard5.png "The New project Wizard.") + +![The New project Wizard.]({{page.relativePath}}/ref-doc/3.3.3/images/New%20Project%20Wizard6.png "The New project Wizard.") + +The last page of the wizard is dedicated to file pathes: + +![The New project Wizard.]({{page.relativePath}}/ref-doc/3.3.3/images/New%20Project%20Wizard7.png "The New project Wizard.") + +NOTE: you can also start the generation on finish. + +### New template wizard + +This wizard creates a simple template from a model. + +To launch the wizard right click in the project exporer and select new other: + +![The New template Wizard.]({{page.relativePath}}/ref-doc/3.3.3/images/New%20Template%20Wizard1.png "The New template Wizard.") + +Then select new template in the M2Doc category and click next: + +![The New template Wizard.]({{page.relativePath}}/ref-doc/3.3.3/images/New%20Template%20Wizard2.png "The New template Wizard.") + +Enter your template name: + +![The New template Wizard.]({{page.relativePath}}/ref-doc/3.3.3/images/New%20Template%20Wizard3.png "The New template Wizard.") + +Select the main variable value and name then click next: + +![The New template Wizard.]({{page.relativePath}}/ref-doc/3.3.3/images/New%20Template%20Wizard4.png "The New template Wizard.") + +![The New template Wizard.]({{page.relativePath}}/ref-doc/3.3.3/images/New%20Template%20Wizard5.png "The New template Wizard.") + +The template is created after clicking finish: + +![The New template Wizard.]({{page.relativePath}}/ref-doc/3.3.3/images/New%20Template%20Wizard6.png "The New template Wizard.") + +### M2Doc interpreter view + +The M2Doc interpreter view provides completion for [AQL](https://www.eclipse.dev/acceleo/documentation/aql.html) expressions in the context of a generation model (.genconf file). To create a generation model file you can read the [initialize generation](index.html#initializing-a-generation-configuration) section. + +To open the M2Doc interpreter view, select the Windows / Show View / Other... : + +![M2Doc Interpreter View.]({{page.relativePath}}/ref-doc/3.3.3/images/Interpreter%20view1.png "M2Doc Interpreter View.") + +Then select the M2Doc interpreter in the M2Doc category: + +![M2Doc Interpreter View.]({{page.relativePath}}/ref-doc/3.3.3/images/Interpreter%20view2.png "M2Doc Interpreter View.") + +To start using the view, you need to select a generation model (.genconf file): + +![M2Doc Interpreter View.]({{page.relativePath}}/ref-doc/3.3.3/images/Interpreter%20view3.png "M2Doc Interpreter View.") + +Select your generation model (.genconf file) in the following dialog: + +![M2Doc Interpreter View.]({{page.relativePath}}/ref-doc/3.3.3/images/Interpreter%20view4.png "M2Doc Interpreter View.") + +You can then start typing [AQL](https://www.eclipse.dev/acceleo/documentation/aql.html) expressions and use CTRL+SPACE for completion: + +![M2Doc Interpreter View.]({{page.relativePath}}/ref-doc/3.3.3/images/Interpreter%20view5.png "M2Doc Interpreter View.") + +Note that you have access to variables declared in your template and also to a variable named «selection» that contains the current selected element. + +You can also use the reload command to refresh the generation context, for instance when the template is modified or the source code of your services is modified: + +![M2Doc Interpreter View.]({{page.relativePath}}/ref-doc/3.3.3/images/Interpreter%20view6.png "M2Doc Interpreter View.") + +When an error/warning/info is detected, you can over the message to highlight the corresponding part of the expression: + +![M2Doc Interpreter View.]({{page.relativePath}}/ref-doc/3.3.3/images/Interpreter%20view7.png "M2Doc Interpreter View.") + +### Syntax + +The template should be edited using your Microsoft Word document editor. M2Doc uses Word fields to declare dynamic elements. To make fields visible during the edition of your template in Microsoft Word, use `ALT+F9`. To insert a new field, use `CTRL+F9`. + +All syntax elements of M2Doc should be placed into fields using `ALT+F9` to show fields and `CTRL+F9` to insert a new field. M2Doc is an imperative template language built on top of [AQL](https://www.eclipse.dev/acceleo/documentation/aql.html) for querying. The language supports type inference and can be extended using [custom services](index.html#providing-new-services). + +In order to create your [AQL](https://www.eclipse.dev/acceleo/documentation/aql.html) expressions with completion and see the result for a selected object you can use the [M2Doc interpreter](index.html#m2doc-interpreter-view). + +In the following explanations `{` and `}` will denote a Word field. + +Note that fields are also used by Microsoft Word page number, table of contents, ... Switching from field visualization mode to field edition mode will change the visualization of the document: + +![Fields edition.]({{page.relativePath}}/ref-doc/3.3.3/images/Field%20edition.png "Fields edition.") + +`ALT+F9` + +![Fields visualization.]({{page.relativePath}}/ref-doc/3.3.3/images/Field%20visualization.png "Fields visualization.") + +#### Comment ([example](https://github.com/ObeoNetwork/M2Doc/tree/3.3.3/tests/org.obeonetwork.m2doc.tests/resources/comment/nominal)) + +A simple comment, nothing is generated. It can be used to add specific text style to your document without having the text generated. The style can then be used later in the template. + +`{m:comment any text}` + +If you want to use a variable named 'comment' you can use an extra space after 'm:'. + +#### Comment block ([example](https://github.com/ObeoNetwork/M2Doc/tree/3.3.3/tests/org.obeonetwork.m2doc.tests/resources/comment/commentBlockNominal)) + +A comment block, the commented block is not generated. It can be used to add specific text or table style, or numbering to your document without having the text or table generated. The style or numbering can then be used later in the template. + +`{m:commentblock any text}` + +`...commented block...` + +`{m:endcommentblock}` + +If you want to use a variable named 'commentblock' or 'endcommentblock' you can use an extra space after 'm:'. + +#### Static statement + +Anything that is not a M2Doc field is generated as is. + +#### Query ([example](https://github.com/ObeoNetwork/M2Doc/tree/3.3.3/tests/org.obeonetwork.m2doc.tests/resources/query/nominal)) + +The [AQL expression](https://www.eclipse.dev/acceleo/documentation/aql.html) is evaluated and its result is inserted in the generated document. [M2Doc services](index.html#services) and [provided services](index.html#providing-new-services) can be used. Some [specific return types](index.html#special-return-types) will be interpreted by M2Doc. + +`{m:AQL expression}` + +#### Conditional ([example](https://github.com/ObeoNetwork/M2Doc/tree/3.3.3/tests/org.obeonetwork.m2doc.tests/resources/conditional/nominal)) + +If the condition is true the «then block» is inserted in the generated document. if it’s false and the «else if» condition is true the «else if block» is inserted. if all condition are false the «else block» is inserted. You can have zero or more «elseif blocks», zero or one «else block». All [AQL expressions](https://www.eclipse.dev/acceleo/documentation/aql.html) should evaluate to a Boolean. + +`{m:if AQL expression}` + +`...then block...` + +`{m:elseif AQL expression}` + +`...else if block...` + +`{m:else}` + +`...else block...` + +` {m:endif}` + +If you want to use a variable named 'elseif', 'else', 'endif' you can use an extra space after 'm:'. You can also use the AQL if exression if you add a space after 'm:'. + +#### Repetition ([example](https://github.com/ObeoNetwork/M2Doc/tree/3.3.3/tests/org.obeonetwork.m2doc.tests/resources/repetition/nominal)) + +Generates the «repetition block» for each value of the [AQL expression](https://www.eclipse.dev/acceleo/documentation/aql.html). + +`{m:for variable | AQL expression} ...repetition block... {m:endfor}` + +If you want to use a variable named 'for' or 'endfor' you can use an extra space after 'm:'. + +#### Let ([example](https://github.com/ObeoNetwork/M2Doc/tree/3.3.3/tests/org.obeonetwork.m2doc.tests/resources/repetition/nominal)) + +Declares a variable named «variable» with the result of the [AQL expression](https://www.eclipse.dev/acceleo/documentation/aql.html) as its value. The variable is accessible in the «let block». + +`{m:let variable = AQL expression} ...let block... {m:endlet}` + +If you want to use a variable named 'endlet' you can use an extra space after 'm:'. You can also use the AQL let exression if you add a space after 'm:'. + +#### Bookmark ([example](https://github.com/ObeoNetwork/M2Doc/tree/3.3.3/tests/org.obeonetwork.m2doc.tests/resources/bookmark/nominal)) + +Generates a bookmark with the result of the [AQL expression](https://www.eclipse.dev/acceleo/documentation/aql.html) as identifier and the «bookmark block» as content. + +`{m:bookmark AQL expression} ...bookmark block... {m:endbookmark}` + +If you want to use a variable named 'bookmark' or 'endbookmark' you can use an extra space after 'm:'. + +#### Link ([example](https://github.com/ObeoNetwork/M2Doc/tree/3.3.3/tests/org.obeonetwork.m2doc.tests/resources/bookmark/nominal)) + +Generates a link to the [bookmark](index.html#bookmark-examplehttpsgithubcomobeonetworkm2doctree3.3.3testsorgobeonetworkm2doctestsresourcesbookmarknominal) with the given identifier and text. + +`{m:link AQL expression AQL expression}` + +The first [AQL expression](https://www.eclipse.dev/acceleo/documentation/aql.html) id the identifier and the second one is the text to display. +If you want to use a variable named 'link' you can use an extra space after 'm:'. + +#### User Documentation ([example](https://github.com/ObeoNetwork/M2Doc/tree/3.3.3/tests/org.obeonetwork.m2doc.tests/resources/userDoc/nominal)) + +Generates a user content block in the resulting document. If the generated document exists and already has a user content with the same id the previous user content is preserved, otherwise the «userdoc block» is generated. + +`{m:userdoc AQL expression} ...user block... {m:enduserdoc}` + +If a user content exists in a previously generated document and the id is not re-generated, the user content will by removed from the generated document and saved in a «lost» file. +If you want to use a variable named 'userdoc' or 'enduserdoc' you can use an extra space after 'm:'. + +#### Template construct ([example](https://github.com/ObeoNetwork/M2Doc/tree/3.3.3/tests/org.obeonetwork.m2doc.tests/resources/template/nominal)) + +A template construct is basically a block of template with parameters that can be called like a service. When the template construct is called its contents is inserted after all dynamic parts have been interpreted by M2Doc. + +`{m:template myTemplate(a : Integer, b : Integer)} ...template block... {m:endtemplate}` + +This template can be called as follow using a simple [query](index.html#query-example): + +`{m:1.myTemplate(3)}` + +If you want more examples of M2Doc syntax you can have a look at the nominal cases in [unit tests](https://github.com/ObeoNetwork/M2Doc/tree/3.3.3/tests/org.obeonetwork.m2doc.tests/resources). +If you want to use a variable named 'template' or 'endtemplate' you can use an extra space after 'm:'. + +### Services + +All [AQL services](https://www.eclipse.dev/acceleo/documentation/aql.html#LanguageReference) are available. On top of that, specific services are provided by M2Doc. See the following reference documentation. If you don’t find your needs in this list, you can [provide custom services](index.html#providing-new-services). + +* [Boolean services]({{page.relativePath}}/ref-doc/3.3.3/m2doc_service_booleanservices.html) +* [Document services]({{page.relativePath}}/ref-doc/3.3.3/m2doc_service_documentservices.html) +* [EObject services]({{page.relativePath}}/ref-doc/3.3.3/m2doc_service_m2doceobjectservices.html) +* [Excel services]({{page.relativePath}}/ref-doc/3.3.3/m2doc_service_excelservices.html) +* [HTML services]({{page.relativePath}}/ref-doc/3.3.3/m2doc_service_m2dochtmlservices.html) +* [Image services]({{page.relativePath}}/ref-doc/3.3.3/m2doc_service_imageservices.html) +* [Link services]({{page.relativePath}}/ref-doc/3.3.3/m2doc_service_linkservices.html) +* [Prompt services]({{page.relativePath}}/ref-doc/3.3.3/m2doc_service_promptservices.html) +* [Prompt services (SWT)]({{page.relativePath}}/ref-doc/3.3.3/m2doc_service_swtpromptservices.html) +* [Pagination services]({{page.relativePath}}/ref-doc/3.3.3/m2doc_service_paginationservices.html) +* [Sirius services]({{page.relativePath}}/ref-doc/3.3.3/m2doc_service_m2docsiriusservices.html) (Note: M2Doc versions 1.1.0 and above are compatible with [Obeo Designer Team Edition](https://www.obeodesigner.com/en/collaborative-features).) + * you will have to add the following packages nsURI (see [Template properties wizard](index.html#template-properties-wizard) section): http://www.eclipse.org/sirius/1.1.0, http://www.eclipse.org/sirius/diagram/1.1.0, and/or http://www.eclipse.org/sirius/diagram/sequence/2.0.0. +* [Wikitext services]({{page.relativePath}}/ref-doc/3.3.3/m2doc_service_m2docwikitextservices.html) (exprerimental) + +Services specific to the [M2Doc Capella extensions](../../capella/): + +* [Capella extensions]({{page.relativePath}}/ref-doc/3.3.3/m2doc_service_m2docgenservices.html) +* [Capella semantic browser]({{page.relativePath}}/ref-doc/3.3.3/m2doc_service_semanticbrowserservices.html) + +NOTE: you will have to manually import the two services classes or select the "Capella" package in the [Template properties wizard](index.html#template-properties-wizard): + +* org.obeonetwork.capella.m2doc.aql.queries.M2DocGenServices +* org.obeonetwork.capella.m2doc.aql.queries.SemanticBrowserServices + +### Template properties wizard + +The template propeties wizard allows to configure the template. You will be able to add or remove used metamodels (nsURI), service classes, you will also be able to specify the type of the variable used as input of your template. + +To open the template properties wizard, you can select a template .docx file and right click on it: + +![The Edit Template properties menu.]({{page.relativePath}}/ref-doc/3.3.3/images/Edit%20Template%20Properties%20menu.png "The Edit Template properties menu.") + +The first page of the wizard let you select template metamodels and services packages. + +![The Edit Template properties wizard.]({{page.relativePath}}/ref-doc/3.3.3/images/Template%20Properties%20Wizard1.png "The Edit Template properties wizard.") + +When a service package is included in one or more other service packages you can have the following page: + +![The Edit Template properties wizard.]({{page.relativePath}}/ref-doc/3.3.3/images/Template%20Properties%20Wizard1%20with%20included%20tokens.png "The Edit Template properties wizard.") + +In this example, the "other test token" is included in the "test token". "other test token" can't be deselected without deselecting "test token". + +Note you can also use the `nsURI (expert)` and `Services (expert)` to select metamodels and services manually. + +The second page is dedicated to variable declarations. The list of declarations is initialized from the variable used in the template. + +![The Edit Template properties wizard.]({{page.relativePath}}/ref-doc/3.3.3/images/Template%20Properties%20Wizard2.png "The Edit Template properties wizard.") + +The M2Doc version to use with this template can be changed on this page. Not having this property set will trigger a warning while [validating](index.html#validating-a-generation-setup) with M2Doc 2.0.0 or above. + +### Template custom properties + +You can use the [Template properties wizard](index.html#template-properties-wizard). But you can also edit them using your Microsoft Word document editor (see [this page](https://support.office.com/en-us/article/View-or-change-the-properties-for-an-Office-file-21d604c2-481e-4379-8e54-1dd4622c6b75?CorrelationId=866914c3-b0b5-42e8-aeb2-e9f7bcc216e2&ui=en-US&rs=en-US&ad=US&ocmsassetID=HA010047524)). This section will describe possible properties name and value used by M2Doc. + +#### M2Doc version custom properties + +To define the version of M2Doc to use with this template you can set a custom property as follow + +* Name: `m:M2DocVersion` +* Value: **M2Doc version** + +For example: + +* Name: `m:M2DocVersion` +* Value: `2.0.0` + +Not having this property set will trigger a warning while [validating](index.html#validating-a-generation-setup) with M2Doc 2.0.0 or above. + +#### Variable custom properties + +To define variables you can set a custom property as follow + +* Name: `m:var:`**variable name** +* Value: **variable type** + +For example: + +* Name: `m:var:self` +* Value: `ecore::EPackage` + +#### Package custom properties + +To use new EMF packages for typing you can add the following custom property: + +* Name: `m:uri:`**EPackage nsURI** +* Value: + +For example: + +* Name: `m:uri:https://www.eclipse.org/uml2/5.0.0/UML` +* Value: + +#### Service custom properties + +To import a service class with a [default constructor](index.html#default-constructor). To use a service class with a custom constructor you can read the [custom constructor](index.html#custom-constructor) section. + +* Name: `m:import:`**qualified class name** +* Value: **bundle symbolic name** + +For example: + +* Name: `m:import:org.obeonetwork.m2doc.rcptt.a.ServiceClassA` +* Value: `org.obeonetwork.m2doc.rcptt.a` + +## Providing new services + +You can extends M2Doc by adding services to your templates using the [Template properties wizard](index.html#template-properties-wizard). A service is a simple Java method with at least one parameter and a return value. + +### Service class + +There are two cases for the class containing the service: either it has a [default constructor](index.html#default-constructor), or it has a [constructor with a parameter](index.html#custom-constructor). + +#### Default constructor + +When the class has no explicit constructor or the constructor doesn’t have any parameters. In this case you don’t need any specific development except for your service method. You can have a look at [specific return types](index.html#special-return-types) if you want to insert images, table, etc... To use your services in your template simply add them through the [Template properties wizard](index.html#template-properties-wizard). + +#### Custom constructor + +When there is an explicit constructor with at least a parameter M2Doc can’t instantiate your class since there is no default constructor. You need to implement the [IServicesConfigurator](https://github.com/ObeoNetwork/M2Doc/blob/3.3.3/plugins/org.obeonetwork.m2doc/src/org/obeonetwork/m2doc/services/configurator/IServicesConfigurator.java) interface. This interface link one or more options in the generation configuration to the service class in order to instantiate it. You need to use the org.obeonetwork.m2doc.ide.servicesConfigurator extension point to declare your implementation of [IServicesConfigurator](https://github.com/ObeoNetwork/M2Doc/blob/3.3.3/plugins/org.obeonetwork.m2doc/src/org/obeonetwork/m2doc/services/configurator/IServicesConfigurator.java). If you want to use your implementation in standalone you can register it programmatically using M2DocUtils.registerServicesConfigurator(). + +An example of implementation can be found in the [Sirius](https://www.eclipse.dev/sirius/) integration plug-in see the class [SiriusServiceConfigurator](https://github.com/ObeoNetwork/M2Doc/blob/3.3.3/plugins/org.obeonetwork.m2doc.sirius/src/org/obeonetwork/m2doc/sirius/services/configurator/SiriusServiceConfigurator.java) and the extension in the [plugin.xml](https://github.com/ObeoNetwork/M2Doc/blob/3.3.3/plugins/org.obeonetwork.m2doc.sirius/plugin.xml). + +### Special return types + +The M2Doc evaluation engine converts any object to a string in order to insert it in the generated document. To add flexibility in the produced document we chose to expose some special types to service creators. Those types are [MElement](https://github.com/ObeoNetwork/M2Doc/blob/3.3.3/plugins/org.obeonetwork.m2doc/src/org/obeonetwork/m2doc/element/MElement.java) and allow directly inserting document artifacts: + +* [MPagination](https://github.com/ObeoNetwork/M2Doc/blob/3.3.3/plugins/org.obeonetwork.m2doc/src/org/obeonetwork/m2doc/element/MPagination.java) to insert a table of contents, a new page, a new paragraph, a new column, or a new text wrapping. +* [MBookmark](https://github.com/ObeoNetwork/M2Doc/blob/3.3.3/plugins/org.obeonetwork.m2doc/src/org/obeonetwork/m2doc/element/MBookmark.java) to insert a new bookmark or a reference to a bookmark. +* [MHyperLink](https://github.com/ObeoNetwork/M2Doc/blob/3.3.3/plugins/org.obeonetwork.m2doc/src/org/obeonetwork/m2doc/element/MHyperLink.java) to insert a new link to an [URL](https://en.wikipedia.org/wiki/URL). +* [MImage](https://github.com/ObeoNetwork/M2Doc/blob/3.3.3/plugins/org.obeonetwork.m2doc/src/org/obeonetwork/m2doc/element/MImage.java) to insert a new image. +* [MTable](https://github.com/ObeoNetwork/M2Doc/blob/3.3.3/plugins/org.obeonetwork.m2doc/src/org/obeonetwork/m2doc/element/MTable.java) to insert a new table. +* [MText](https://github.com/ObeoNetwork/M2Doc/blob/3.3.3/plugins/org.obeonetwork.m2doc/src/org/obeonetwork/m2doc/element/MText.java) to insert styled text. +* [MList](https://github.com/ObeoNetwork/M2Doc/blob/3.3.3/plugins/org.obeonetwork.m2doc/src/org/obeonetwork/m2doc/element/MList.java) to insert a list of [MElement](https://github.com/ObeoNetwork/M2Doc/blob/3.3.3/plugins/org.obeonetwork.m2doc/src/org/obeonetwork/m2doc/element/MElement.java). + +Default implementations are also provided by M2Doc in [this package](https://github.com/ObeoNetwork/M2Doc/tree/3.3.3/plugins/org.obeonetwork.m2doc/src/org/obeonetwork/m2doc/element/impl). + +## Extension points + +### Services and packages token + +The services and packages token extension point org.obeonetwork.m2doc.ide.services.register can be used to reference a set of [service classes](index.html#default-constructor) and packages using a token name. This token can be selected using «Select tokens» menu in the [Template properties wizard](index.html#template-properties-wizard). You can find an example of this extension point [here](https://github.com/ObeoNetwork/M2Doc/blob/3.3.3/tests/org.obeonetwork.m2doc.ide.tests/plugin.xml). + +### Template registry + +It's possible to package your templates and deploy them in Eclipse plugins. To register them you can use the extension point org.obeonetwork.m2doc.ide.templates.register, ther is an example [here](https://github.com/ObeoNetwork/M2Doc/blob/3.3.3/tests/org.obeonetwork.m2doc.ide.tests/plugin.xml). + +#### Import registered template + +Once a template is registered (see the [Template registry](index.html#template-registry) section), you can import it in the workspace for further modifications for instance: + +Select the template import wizard: + +![The import menu.]({{page.relativePath}}/ref-doc/3.3.3/images/Import%20menu.png "The import menu.") + +![Import Wizard Selection.]({{page.relativePath}}/ref-doc/3.3.3/images/Import%20Wizard%20Selection.png "Import Wizard Selection.") + +![Select a template.]({{page.relativePath}}/ref-doc/3.3.3/images/Template%20Import%20Wizard1.png "Select a template.") + +![Select the target folder.]({{page.relativePath}}/ref-doc/3.3.3/images/Template%20Import%20Wizard2.png "Select the target folder.") + + +## Template testing + +To simplify unit testing while developing M2Doc, a [JUnit](https://junit.org/junit4/) test suite has been implemented. It uses a given folder as input and lists each sub directory following a naming pattern as a test case. You can use the same test suite for your own tests. An example of the test suite implementation [QueryTests](https://github.com/ObeoNetwork/M2Doc/blob/3.3.3/tests/org.obeonetwork.m2doc.tests/src/org/obeonetwork/m2doc/tests/QueryTests.java) with the folder [resources/query](https://github.com/ObeoNetwork/M2Doc/tree/3.3.3/tests/org.obeonetwork.m2doc.tests/resources/query). + +## Maven + +You can launch your generation using [Maven](https://maven.apache.org/) and [Tycho](https://eclipse.org/tycho/). An example is available [here](https://github.com/ObeoNetwork/M2Doc/tree/3.3.3/releng/generate-with-maven). You may probably need to have a look at the [pom.xml](https://github.com/ObeoNetwork/M2Doc/blob/3.3.3/releng/generate-with-maven/myModelToDocx/pom.xml) file. To launch the build and the generation you can simply use the following command: + +`mvn clean verify` + +## Using M2Doc programmatically + +This section is for developers wanting to integrate M2Doc in their own project. It will show how to use the main features of M2Doc programmatically. Since M2Doc uses AQL for expressions it can be useful to have a look at [Using AQL programmatically](https://www.eclipse.dev/acceleo/documentation/aql.html#UsingAQLprogrammatically). + +### Parsing + +The following sample code shows how to load a template .docx file using M2Doc: + +{% highlight Java %} +final URI templateURI = ...; // the URI of the template + +// can be empty, if you are using a Generation use GenconfUtils.getOptions(generation) +final Map options = ...; +List exceptions = new ArrayList<>(); + +final ResourceSet resourceSetForModels = M2DocUtils.createResourceSetForModels(exceptions , key, new ResourceSetImpl(), options); + +// if you are using a Generation use GenconfUtils.getQueryEnvironment(resourceSetForModels, generation) +final IQueryEnvironment queryEnvironment = M2DocUtils.getQueryEnvironment(resourceSetForModels, templateURI, options); // delegate to IServicesConfigurator + +final IClassProvider classProvider = new ClassProvider(this.getClass().getClassLoader()); // use M2DocPlugin.getClassProvider() when running inside Eclipse +try (DocumentTemplate template = M2DocUtils.parse(resourceSetForModels.getURIConverter(), templateURI, queryEnvironment, classProvider, monitor)) { + // use the template +} finally { + M2DocUtils.cleanResourceSetForModels(key, resourceSetForModels); +} +{% endhighlight %} + +### Validation + +The validation is optional: + +{% highlight Java %} +final ValidationMessageLevel validationLevel = M2DocUtils.validate(template, queryEnvironment, monitor); +if (validationLevel != ValidationMessageLevel.OK) { + final URI validationResulURI = ...; // some place to serialize the result of the validation + M2DocUtils.serializeValidatedDocumentTemplate(resourceSetForModels.getURIConverter(), documentTemplate, validationResulURI); +} +{% endhighlight %} + +### Generation + +The generation will produce the final document where M2Doc template is evaluated against the given variables. There are two levels of API for the generation: directly from the DocumentTemplate or from the Generation. + +#### Core generation API + +{% highlight Java %} +final Map variables = ...; // your variables and values +final URI outputURI = ...; // some place to serialize the result of the generation +M2DocUtils.generate(template, queryEnvironment, variables, resourceSetForModels, outputURI, monitor); +{% endhighlight %} + +#### Generation configuration API + +{% highlight Java %} +final Generation generation = ...; // load from a serialized EMF model or create in memory +final IClassProvider classProvider = new ClassProvider(this.getClass().getClassLoader()); // use M2DocPlugin.getClassProvider() when running inside Eclipse +GenconfUtils.generate(generation, classProvider, monitor); +{% endhighlight %} diff --git a/ref-doc/3.3.3/m2doc_service_booleanservices.md b/ref-doc/3.3.3/m2doc_service_booleanservices.md new file mode 100644 index 000000000..5e454b587 --- /dev/null +++ b/ref-doc/3.3.3/m2doc_service_booleanservices.md @@ -0,0 +1,59 @@ +--- +layout: article-services +title: BooleanServices +subtitle: 3.3.3 +relativePath: ../.. +--- + + + +# BooleanServices + +Services available for Booleans. See [document examples](https://github.com/ObeoNetwork/M2Doc/tree/3.3.3/tests/org.obeonetwork.m2doc.tests/resources/booleanServices). + +* TOC +{:toc} + +## boolean.check() : String + +Returns "X" for boolean true. + +### Parameter + +* **value**: The boolean value + +### Example + +* true.check() + * X +* false.check() + * + +## boolean.yesNo() : String + +Returns "Yes" for boolean true, "No" otherwise. + +### Parameter + +* **value**: The boolean value + +### Example + +* true.yesNo() + * Yes +* false.yesNo() + * No + + + diff --git a/ref-doc/3.3.3/m2doc_service_documentservices.md b/ref-doc/3.3.3/m2doc_service_documentservices.md new file mode 100644 index 000000000..322179ba3 --- /dev/null +++ b/ref-doc/3.3.3/m2doc_service_documentservices.md @@ -0,0 +1,620 @@ +--- +layout: article-services +title: DocumentServices +subtitle: 3.3.3 +relativePath: ../.. +--- + + + +# DocumentServices + +Services available to manipulate the document ifself: title, version, .... + +* TOC +{:toc} + +## boolean.addDocumentProperty(String) : void + +Adds a custom property with the given name and boolean value. + +### Parameter + +* **value**: The boolean value. +* **propertyName**: The custom property name. + +### Example + +* true.addDocumentProperty('myBoolean') + * Adds a custom propery named myBoolean with the value true. + +## double.addDocumentProperty(String) : void + +Adds a custom property with the given name and double value. + +### Parameter + +* **value**: The double value. +* **propertyName**: The custom property name. + +### Example + +* myDouble.addDocumentProperty('myDouble') + * Adds a custom propery named myDouble with the reveiver value. + +## float.addDocumentProperty(String) : void + +Adds a custom property with the given name and float value. + +### Parameter + +* **value**: The float value. +* **propertyName**: The custom property name. + +### Example + +* myFloat.addDocumentProperty('myFloat') + * Adds a custom propery named myFloat with the reveiver value. + +## int.addDocumentProperty(String) : void + +Adds a custom property with the given name and integer value. + +### Parameter + +* **value**: The integer value. +* **propertyName**: The custom property name. + +### Example + +* myInteger.addDocumentProperty('myInteger') + * Adds a custom propery named myInteger with the reveiver value. + +## String.addDocumentProperty(String) : void + +Adds a custom property with the given name and string value. + +### Parameter + +* **value**: The string value. +* **propertyName**: The custom property name. + +### Example + +* 'Some Value'.addDocumentProperty('myString') + * Adds a custom propery named myString with the reveiver value. + +## long.addDocumentProperty(String) : void + +Adds a custom property with the given name and long value. + +### Parameter + +* **value**: The long value. +* **propertyName**: The custom property name. + +### Example + +* myLong.addDocumentProperty('myLong') + * Adds a custom propery named myLong with the reveiver value. + +## String.documentPropertyIsNumber() : boolean + +Tells if the value of the custom property with the given name is a number. + +### Parameter + +* **propertyName**: The custom property name. + +### Example + +* 'MyProperty'.getDocumentPropertyAsLong() + * The property value as long. + +## Object.getDocumentAppVersion() : String + +Gets the document appplication version. + +### Parameter + +* **reveiver**: Any receiver object. + +### Example + +* ''.getDocumentAppVersion() + * The document appplication version. + +## Object.getDocumentApplication() : String + +Gets the document application. + +### Parameter + +* **reveiver**: Any receiver object. + +### Example + +* ''.getDocumentApplication() + * The document application. + +## Object.getDocumentCategory() : String + +Gets the document category. + +### Parameter + +* **reveiver**: Any receiver object. + +### Example + +* ''.getDocumentCategory() + * The document category. + +## Object.getDocumentCompany() : String + +Gets the document company. + +### Parameter + +* **reveiver**: Any receiver object. + +### Example + +* ''.getDocumentCompany() + * The document company. + +## Object.getDocumentContentStatus() : String + +Gets the document content status. + +### Parameter + +* **reveiver**: Any receiver object. + +### Example + +* ''.getDocumentContentStatus() + * The document content status. + +## Object.getDocumentContentType() : String + +Gets the document content type. + +### Parameter + +* **reveiver**: Any receiver object. + +### Example + +* ''.getDocumentContentType() + * The document content type. + +## Object.getDocumentCreator() : String + +Gets the document creator. + +### Parameter + +* **reveiver**: Any receiver object. + +### Example + +* ''.getDocumentCreator() + * The document creator. + +## Object.getDocumentDescription() : String + +Gets the document description. + +### Parameter + +* **reveiver**: Any receiver object. + +### Example + +* ''.getDocumentDescription() + * The document description. + +## Object.getDocumentIdentifier() : String + +Gets the document identifier. + +### Parameter + +* **reveiver**: Any receiver object. + +### Example + +* ''.getDocumentIdentifier() + * The document identifier. + +## Object.getDocumentKeywords() : String + +Gets the document keywords. + +### Parameter + +* **reveiver**: Any receiver object. + +### Example + +* ''.getDocumentKeywords() + * The document keywords. + +## Object.getDocumentManager() : String + +Gets the document manager. + +### Parameter + +* **reveiver**: Any receiver object. + +### Example + +* ''.getDocumentManager() + * The document manager. + +## String.getDocumentPropertyAsBoolean() : boolean + +Gets the value of the custom property with the given name as boolean. + +### Parameter + +* **propertyName**: The custom property name. + +### Example + +* 'MyProperty'.getDocumentPropertyAsBoolean() + * The property value as boolean. + +## String.getDocumentPropertyAsDouble() : double + +Gets the value of the custom property with the given name as double. + +### Parameter + +* **propertyName**: The custom property name. + +### Example + +* 'MyProperty'.getDocumentPropertyAsDouble() + * The property value as double. + +## String.getDocumentPropertyAsFloat() : float + +Gets the value of the custom property with the given name as float. + +### Parameter + +* **propertyName**: The custom property name. + +### Example + +* 'MyProperty'.getDocumentPropertyAsFloat() + * The property value as float. + +## String.getDocumentPropertyAsInteger() : int + +Gets the value of the custom property with the given name as integer. + +### Parameter + +* **propertyName**: The custom property name. + +### Example + +* 'MyProperty'.getDocumentPropertyAsInteger() + * The property value as integer. + +## String.getDocumentPropertyAsLong() : long + +Gets the value of the custom property with the given name as long. + +### Parameter + +* **propertyName**: The custom property name. + +### Example + +* 'MyProperty'.getDocumentPropertyAsLong() + * The property value as long. + +## String.getDocumentPropertyAsString() : String + +Gets the value of the custom property with the given name as string. + +### Parameter + +* **propertyName**: The custom property name. + +### Example + +* 'MyProperty'.getDocumentPropertyAsString() + * The property value as string. + +## Object.getDocumentRevision() : String + +Gets the document revision. + +### Parameter + +* **reveiver**: Any receiver object. + +### Example + +* ''.getDocumentRevision() + * The document revision. + +## Object.getDocumentSubject() : String + +Gets the document subject. + +### Parameter + +* **reveiver**: Any receiver object. + +### Example + +* ''.getDocumentSubject() + * The document subject. + +## Object.getDocumentTitle() : String + +Gets the document title. + +### Parameter + +* **reveiver**: Any receiver object. + +### Example + +* ''.getDocumentTitle() + * The document title. + +## Object.getDocumentVersion() : String + +Gets the document version. + +### Parameter + +* **reveiver**: Any receiver object. + +### Example + +* ''.getDocumentVersion() + * The document version. + +## String.hasDocumentProperty() : boolean + +Tells if the custom property with the given name exists. + +### Parameter + +* **propertyName**: The custom property name. + +### Example + +* 'MyProperty'.getDocumentPropertyAsString() + * The property value as string. + +## String.removeDocumentProperty() : void + +Removes a custom property with the given name. + +### Parameter + +* **propertyName**: The custom property name. + +### Example + +* 'MyProperty'.removeDocumentCustomProperty() + * Removes a custom propery named MyProperty. + +## String.setDocumentAppVersion() : void + +Sets the document appplication version. + +### Parameter + +* **value**: The value. + +### Example + +* 'My AppVersion'.setDocumentAppVersion() + * Sets the document appplication version to My AppVersion. + +## String.setDocumentApplication() : void + +Sets the document application. + +### Parameter + +* **value**: The value. + +### Example + +* 'My Application'.setDocumentApplication() + * Sets the document application to My Application. + +## String.setDocumentCategory() : void + +Sets the document category. + +### Parameter + +* **value**: The value. + +### Example + +* 'My Category'.setDocumentCategory() + * Sets the document category to My Category. + +## String.setDocumentCompany() : void + +Sets the document company. + +### Parameter + +* **value**: The value. + +### Example + +* 'My Company'.setDocumentCompany() + * Sets the document company to My Company. + +## String.setDocumentContentStatus() : void + +Sets the document content status. + +### Parameter + +* **value**: The value. + +### Example + +* 'My ContentStatus'.setDocumentContentStatus() + * Sets the document content status to My ContentStatus. + +## String.setDocumentContentType() : void + +Sets the document content type. + +### Parameter + +* **value**: The value. + +### Example + +* 'My ContentType'.setDocumentContentType() + * Sets the document content type to My ContentType. + +## String.setDocumentCreator() : void + +Sets the document creator. + +### Parameter + +* **value**: The value. + +### Example + +* 'My Creator'.setDocumentCreator() + * Sets the document creator to My Creator. + +## String.setDocumentDescription() : void + +Sets the document description. + +### Parameter + +* **value**: The value. + +### Example + +* 'My Description'.setDocumentDescription() + * Sets the document description to My Description. + +## String.setDocumentIdentifier() : void + +Sets the document identifier. + +### Parameter + +* **value**: The value. + +### Example + +* 'My Identifier'.setDocumentIdentifier() + * Sets the document identifier to My Identifier. + +## String.setDocumentKeywords() : void + +Sets the document keywords. + +### Parameter + +* **value**: The value. + +### Example + +* 'My Keywords'.setDocumentKeywords() + * Sets the document keywords to My Keywords. + +## String.setDocumentManager() : void + +Sets the document manager. + +### Parameter + +* **value**: The value. + +### Example + +* 'My Manager'.setDocumentManager() + * Sets the document manager to My Manager. + +## String.setDocumentRevision() : void + +Sets the document revision. + +### Parameter + +* **value**: The value. + +### Example + +* 'My Revision'.setDocumentRevision() + * Sets the document revision to My Revision. + +## String.setDocumentSubject() : void + +Sets the document subject. + +### Parameter + +* **value**: The value. + +### Example + +* 'My Subject'.setDocumentSubject() + * Sets the document subject to My Subject. + +## String.setDocumentTitle() : void + +Sets the document title. + +### Parameter + +* **value**: The value. + +### Example + +* 'My Title'.setDocumentTitle() + * Sets the document title to My Title. + +## String.setDocumentVersion() : void + +Sets the document version. + +### Parameter + +* **value**: The value. + +### Example + +* 'My Version'.setDocumentVersion() + * Sets the document version to My Version. + + + diff --git a/ref-doc/3.3.3/m2doc_service_excelservices.md b/ref-doc/3.3.3/m2doc_service_excelservices.md new file mode 100644 index 000000000..d2c54fadb --- /dev/null +++ b/ref-doc/3.3.3/m2doc_service_excelservices.md @@ -0,0 +1,62 @@ +--- +layout: article-services +title: ExcelServices +subtitle: 3.3.3 +relativePath: ../.. +--- + + + +# ExcelServices + +Services available for Excel. See [document examples](https://github.com/ObeoNetwork/M2Doc/tree/3.3.3/tests/org.obeonetwork.m2doc.tests/resources/excelServices). + +* TOC +{:toc} + +## String.asTable(String, String, String) : org.obeonetwork.m2doc.element.MTable + +Insert a table from an Excel .xlsx file. + +### Parameter + +* **uri**: The Excel .xlsx file uri, it can be relative to the template +* **sheetName**: The sheet name +* **topLeftCellAdress**: The top left cell address +* **bottomRightCellAdress**: The bottom right cell address + +### Example + +* 'excel.xlsx'.asTable('Feuil1', 'C3', 'F7') + * insert the table from 'excel.xlsx' + +## String.asTable(String, String, String, String) : org.obeonetwork.m2doc.element.MTable + +Insert a table from an Excel .xlsx file. + +### Parameter + +* **uri**: The Excel .xlsx file uri, it can be relative to the template +* **sheetName**: The sheet name +* **topLeftCellAdress**: The top left cell address +* **bottomRightCellAdress**: The bottom right cell address +* **languageTag**: The language tag for the locale + +### Example + +* 'excel.xlsx'.asTable('Feuil1', 'C3', 'F7', 'fr-FR') + * insert the table from 'excel.xlsx' + + + diff --git a/ref-doc/3.3.3/m2doc_service_imageservices.md b/ref-doc/3.3.3/m2doc_service_imageservices.md new file mode 100644 index 000000000..f3758faea --- /dev/null +++ b/ref-doc/3.3.3/m2doc_service_imageservices.md @@ -0,0 +1,199 @@ +--- +layout: article-services +title: ImageServices +subtitle: 3.3.3 +relativePath: ../.. +--- + + + +# ImageServices + +Services available for Images. See [document examples](https://github.com/ObeoNetwork/M2Doc/tree/3.3.3/tests/org.obeonetwork.m2doc.tests/resources/imageServices). + +* TOC +{:toc} + +## String.asImage() : org.obeonetwork.m2doc.element.MImage + +Convert a String representing an URI to an Image. + +### Parameter + +* **uri**: The Image uri, it can be relative to the template + +### Example + +* 'image.png'.asImage() + * insert the image 'image.png' + +## String.asImage(String) : org.obeonetwork.m2doc.element.MImage + +Convert a String representing an URI to an Image and specify the image format of the input. + +### Parameter + +* **uri**: The Image uri, it can be relative to the template +* **format**: the image format: BMP, DIB, EMF, EPS, GIF, JPG, JPEG, PICT, PNG, SVG, TIFF, WMF, WPG + +### Example + +* 'image'.asImage('jpg') + * insert the image as a jpg image + +## org.obeonetwork.m2doc.element.MElement.fitAll(Integer, Integer, boolean) : org.obeonetwork.m2doc.element.MElement + +Fits all Images of the given MElement in the given rectangle width and height. + +### Parameter + +* **element**: The MElement +* **width**: The width to fit +* **height**: The height to fit +* **zoomIn**: The image will be zoomed in if smaller + +### Example + +* myImage.fitAll(200, 300, false) + * will fit all images in a rectangle (width=200, height=300) if the original image size is smaller it will not be zoomed in + +## org.obeonetwork.m2doc.element.MImage.fit(Integer, Integer) : org.obeonetwork.m2doc.element.MImage + +Fits the Image in the given rectangle width and height. same as myImage.fit(width, height, true) + +### Parameter + +* **image**: The Image +* **width**: The width to fit +* **height**: The height to fit + +### Example + +* myImage.fit(200, 300) + * will fit the image in a rectangle (width=200, height=300) + +## org.obeonetwork.m2doc.element.MImage.fit(Integer, Integer, boolean) : org.obeonetwork.m2doc.element.MImage + +Fits the Image in the given rectangle width and height. + +### Parameter + +* **image**: The Image +* **width**: The width to fit +* **height**: The height to fit +* **zoomIn**: The image will be zoomed in if smaller + +### Example + +* myImage.fit(200, 300, false) + * will fit the image in a rectangle (width=200, height=300) if the original image size is smaller it will not be zoomed in + +## org.obeonetwork.m2doc.element.MImage.getHeight() : Integer + +Gets the height of the image. + +### Parameter + +* **image**: The Image + +### Example + +* myImage.getHeight() + * 300 + +## org.obeonetwork.m2doc.element.MImage.getWidth() : Integer + +Gets the width of the image. + +### Parameter + +* **image**: The Image + +### Example + +* myImage.getWidth() + * 300 + +## org.obeonetwork.m2doc.element.MImage.resize(Double) : org.obeonetwork.m2doc.element.MImage + +Resizes the Image by the given factor. + +### Parameter + +* **image**: The Image +* **factor**: The resize factor + +### Example + +* myImage.resize(0.5) + * will resize the image by a factor 0.5 + +## org.obeonetwork.m2doc.element.MImage.rotate(Integer) : org.obeonetwork.m2doc.element.MImage + +Rotates the Image by the given angle in degres. + +### Parameter + +* **image**: The Image +* **angle**: The angle in degres + +### Example + +* myImage.rotate(90) + * will rotate the image by an angle of 90 degres + +## org.obeonetwork.m2doc.element.MImage.setConserveRatio(Boolean) : org.obeonetwork.m2doc.element.MImage + +Sets the conserve ratio of the image. + +### Parameter + +* **image**: The Image +* **conserve**: A Boolean + +### Example + +* myImage.setConserveRatio(false) + * set the conserve ratio to false + +## org.obeonetwork.m2doc.element.MImage.setHeight(Integer) : org.obeonetwork.m2doc.element.MImage + +Sets the height of the image. + +### Parameter + +* **image**: The Image +* **height**: The height + +### Example + +* myImage.setHeight(300) + * set the height to 300 + +## org.obeonetwork.m2doc.element.MImage.setWidth(Integer) : org.obeonetwork.m2doc.element.MImage + +Sets the width of the image. + +### Parameter + +* **image**: The Image +* **width**: The width + +### Example + +* myImage.setWidth(300) + * set the witdh to 300 + + + diff --git a/ref-doc/3.3.3/m2doc_service_linkservices.md b/ref-doc/3.3.3/m2doc_service_linkservices.md new file mode 100644 index 000000000..7368c2996 --- /dev/null +++ b/ref-doc/3.3.3/m2doc_service_linkservices.md @@ -0,0 +1,101 @@ +--- +layout: article-services +title: LinkServices +subtitle: 3.3.3 +relativePath: ../.. +--- + + + +# LinkServices + +Services available for links. See [document examples](https://github.com/ObeoNetwork/M2Doc/tree/3.3.3/tests/org.obeonetwork.m2doc.tests/resources/linkServices). + +* TOC +{:toc} + +## String.asBookmarkRef(String) : org.obeonetwork.m2doc.element.MBookmark + +Converts a String to a bookmark reference + +### Parameter + +* **text**: The label of the bookmark reference +* **id**: The ID of the bookmark reference + +### Example + +* 'Artifact1'.asBookmarkRef('Art1') + * a bookmark reference with the ID 'Art1' the label 'Artifact1' + +## String.asBookmarkRef(String, boolean) : org.obeonetwork.m2doc.element.MBookmark + +Converts a String to a bookmark reference + +### Parameter + +* **text**: The label of the bookmark reference +* **id**: The ID of the bookmark reference +* **optional**: If true, this reference will only generate the text if the corresponding bookmark doesn't exists + +### Example + +* 'Artifact1'.asBookmarkRef('Art1', true) + * a bookmark reference with the ID 'Art1' the label 'Artifact1' only if a bookmark with ID 'Art1' exists, otherwise only the label 'Artifact1' + +## String.asBookmark(String) : org.obeonetwork.m2doc.element.MBookmark + +Converts a String to a bookmark declaration + +### Parameter + +* **text**: The label of the bookmark declaration +* **id**: The ID of the bookmark declaration + +### Example + +* 'Definition of Artifact1'.asBookmark('Art1') + * a bookmark with the ID 'Art1' the label 'Definition of Artifact1' + +## String.asLink(String) : org.obeonetwork.m2doc.element.MHyperLink + +Converts a String to an hyperlink + +### Parameter + +* **text**: The label of the link +* **url**: The destination of the link + +### Example + +* 'My website'.asLink('https://www.example.org') + * a link to https://www.example.org with the label My website + +## String.asLink(String, String) : org.obeonetwork.m2doc.element.MHyperLink + +Converts a String to an hyperlink + +### Parameter + +* **text**: The label of the link +* **url**: The destination of the link +* **toolTip**: The tool tip of the link + +### Example + +* 'My website'.asLink('https://www.example.org', 'My tool tip') + * a link to https://www.example.org with the label My website with a tool tip + + + diff --git a/ref-doc/3.3.3/m2doc_service_m2doceobjectservices.md b/ref-doc/3.3.3/m2doc_service_m2doceobjectservices.md new file mode 100644 index 000000000..faf4380fe --- /dev/null +++ b/ref-doc/3.3.3/m2doc_service_m2doceobjectservices.md @@ -0,0 +1,55 @@ +--- +layout: article-services +title: M2DocEObjectServices +subtitle: 3.3.3 +relativePath: ../.. +--- + + + +# M2DocEObjectServices + +Services available for EObject. + +* TOC +{:toc} + +## EObject.getImage() : org.obeonetwork.m2doc.element.MImage + +Gets the image of the ILabelProvider for the given EObject. + +### Parameter + +* **eObj**: The EObject + +### Example + +* myEClass.getImage() + * the MImage for the given EObject + +## EObject.getText() : String + +Gets the text of the ILabelProvider for the given EObject. + +### Parameter + +* **eObj**: The EObject + +### Example + +* myEClass.getText() + * MyEClass -> MySuperClass + + + diff --git a/ref-doc/3.3.3/m2doc_service_m2docgenservices.md b/ref-doc/3.3.3/m2doc_service_m2docgenservices.md new file mode 100644 index 000000000..4aa9e58d5 --- /dev/null +++ b/ref-doc/3.3.3/m2doc_service_m2docgenservices.md @@ -0,0 +1,192 @@ +--- +layout: article-services +title: M2DocGenServices +subtitle: 3.3.3 +relativePath: ../.. +--- + + + +# M2DocGenServices + +Services available for Capella extensions. + +* TOC +{:toc} + +## org.polarsys.capella.core.data.information.DataPkg.getAllDataPkgs() : Sequence{org.polarsys.capella.core.data.information.DataPkg} + +Return recursively all the data subpackages of the given data package. + +### Parameter + +* **dataPkg**: The given data package + +### Example + +* myDataPkg.getAllDataPkgs() + * a list of all data subpackages + +## org.polarsys.capella.core.data.cs.InterfacePkg.getAllSubInterfacesCount() : int + +Compute the amount of contained interface subpackages. + +### Parameter + +* **interfacePkg**: The given interface package + +### Example + +* myInterfacePkg.getAllSubInterfacesCount() + * the number of contained interface subpackages + +## org.polarsys.capella.core.data.fa.ComponentExchange.getCeDirection(org.polarsys.capella.core.data.cs.Component) : String + +Return the component exchange direction (UNSET/IN/OUT/INOUT) for the given component. + +### Parameter + +* **ce**: The given component exchange +* **component**: The given component + +### Example + +* myDataPkg.getDataPkgQualifiedName(myComponent) + * 'UNSET' or 'IN' or 'OUT' or 'INOUT' + +## org.polarsys.capella.core.data.information.DataPkg.getDataPkgQualifiedName() : String + +Compute a "qualified name" of the given data package. The root of the qualified name is the upper level data package. + +### Parameter + +* **dataPkg**: The given data package + +### Example + +* myDataPkg.getDataPkgQualifiedName() + * the qualified name of the data package + +## org.polarsys.capella.core.data.fa.ComponentExchange.getDestinationComponent(org.polarsys.capella.core.data.cs.Component) : String + +Return the component at the other end of the given component exchange and component. + +### Parameter + +* **ce**: The given component exchange +* **component**: The given component + +### Example + +* myDataPkg.getDataPkgQualifiedName(myComponent) + * the component at the other end of the given component exchange and component + +## org.polarsys.kitalpha.emde.model.ExtensibleElement.getExtensions(OrderedSet{EClass}) : Sequence{EObject} + +Return the list of extension of the given types for the given extensible element. + +### Parameter + +* **element**: The given extensible element +* **eClasses**: the extension EClasses + +### Example + +* myExtensibleElement.getExtensions({some::Extension1 | some::Extension2}) + * the list of extension of the given types for the given extensible element + +## org.polarsys.kitalpha.emde.model.ExtensibleElement.getExtensions(EClass) : Sequence{EObject} + +Return the list of extension of the given type for the given extensible element. + +### Parameter + +* **element**: The given extensible element +* **eCls**: the extension EClass + +### Example + +* myExtensibleElement.getExtensions(some::Extension) + * the list of extension of the given type for the given extensible element + +## org.polarsys.capella.core.data.cs.InterfacePkg.getInterfaceSubPkg() : Sequence{org.polarsys.capella.core.data.cs.InterfacePkg} + +Return recursively all the interface subpackages of the given interface packages. + +### Parameter + +* **interfacePkg**: The given interface package + +### Example + +* myInterfacePkg.getInterfaceSubPkg() + * a list of all interface subpackages + +## org.eclipse.sirius.viewpoint.DRepresentation.isVisibleInDoc() : boolean + +Tell if the given DRepresentation is visible in documentation. + +### Parameter + +* **rep**: The given DRepresentation + +### Example + +* myDRepresentation.isVisibleInDoc({some::Extension1 | some::Extension2}) + * true if the given DRepresentation is visible in documentation, false otherwise + +## org.eclipse.sirius.viewpoint.DRepresentation.isVisibleInLM() : boolean + +Tell if the given DRepresentation is visible in LM. + +### Parameter + +* **rep**: The given DRepresentation + +### Example + +* myDRepresentation.isVisibleInDoc({some::Extension1 | some::Extension2}) + * true if the given DRepresentation is visible in LM, false otherwise + +## org.obeonetwork.m2doc.element.MElement.reduceAllImages(Integer, Integer) : org.obeonetwork.m2doc.element.MElement + +Reduces all MImages from the given MElement to a maximum of the given size. Smaller images will not be changed. + +### Parameter + +* **element**: The given MElement +* **width**: The maximum width +* **height**: The maximum height + +### Example + +* myMElement.reduceAllImages(200, 300) + * all reduced MImages from the given MElement + +## org.obeonetwork.m2doc.element.MElement.replaceLink(EObject) : org.obeonetwork.m2doc.element.MElement + +Replace the MLink uri from the given MElement to reference document bookmarks. + +### Parameter + +* **element**: The given MElement +* **reference**: a reference EObject to reteive the Sirius Session + +### Example + +* myMElement.replaceLink(eObj) + * replaced the MLink uri from the given MElement to reference document bookmarks + + + diff --git a/ref-doc/3.3.3/m2doc_service_m2dochtmlservices.md b/ref-doc/3.3.3/m2doc_service_m2dochtmlservices.md new file mode 100644 index 000000000..a99fa008b --- /dev/null +++ b/ref-doc/3.3.3/m2doc_service_m2dochtmlservices.md @@ -0,0 +1,96 @@ +--- +layout: article-services +title: M2DocHTMLServices +subtitle: 3.3.3 +relativePath: ../.. +--- + + + +# M2DocHTMLServices + +Services available for HTML insertion. + +* TOC +{:toc} + +## String.fromHTMLBodyString() : Sequence{org.obeonetwork.m2doc.element.MElement} + +Returns a Sequence of MElement corresponding to the given body String. + +### Parameter + +* **bodyString**: The body String. + +### Example + +* '

Starting with M2Doc

'.fromHTMLBodyString() + * The Sequence of MElement corresponding to the given HTML String. + +## String.fromHTMLBodyString(String) : Sequence{org.obeonetwork.m2doc.element.MElement} + +Returns a Sequence of MElement corresponding to the given body String. + +### Parameter + +* **bodyString**: The HTML body. +* **baseURI**: The base URI to use for link and images resolving. + +### Example + +* '

Starting with M2Doc

'.fromHTMLBodyString('http://www.m2doc.org/') + * The Sequence of MElement corresponding to the given body String. + +## String.fromHTMLString() : Sequence{org.obeonetwork.m2doc.element.MElement} + +Returns a Sequence of MElement corresponding to the given HTML String. + +### Parameter + +* **htmlString**: The HTML document. + +### Example + +* 'Sample HTML for test purpose

Starting with M2Doc

').fromHTMLString() + * The Sequence of MElement corresponding to the given HTML String. + +## String.fromHTMLString(String) : Sequence{org.obeonetwork.m2doc.element.MElement} + +Returns a Sequence of MElement corresponding to the given HTML String. + +### Parameter + +* **htmlString**: The HTML document. +* **baseURI**: The base URI to use for link and images resolving. + +### Example + +* 'Sample HTML for test purpose

Starting with M2Doc

'.fromHTMLString('http://www.m2doc.org/') + * The Sequence of MElement corresponding to the given HTML String. + +## String.fromHTMLURI() : Sequence{org.obeonetwork.m2doc.element.MElement} + +Returns a Sequence of MElement corresponding to the given web page. + +### Parameter + +* **uriStr**: The URI. + +### Example + +* 'http://www.m2doc.org/'.fromHTMLURI() + * The Sequence of MElement corresponding to the given web page. + + + diff --git a/ref-doc/3.3.3/m2doc_service_m2docsiriusservices.md b/ref-doc/3.3.3/m2doc_service_m2docsiriusservices.md new file mode 100644 index 000000000..91dd18257 --- /dev/null +++ b/ref-doc/3.3.3/m2doc_service_m2docsiriusservices.md @@ -0,0 +1,453 @@ +--- +layout: article-services +title: M2DocSiriusServices +subtitle: 3.3.3 +relativePath: ../.. +--- + + + +# M2DocSiriusServices + +Services available for Sirius. You will have to set the "SiriusSession" option in the generation configuration. It must contains the .aird file URI. See [document examples](https://github.com/ObeoNetwork/M2Doc/tree/3.3.3/tests/org.obeonetwork.m2doc.sirius.tests/resources/m2DocSiriusServices). In addition, you can force the refresh of all representation with option "SiriusForceRefresh" set to "true". Note this option might have an impact on memory usage, calls to services with the refresh parameter should be prefered. You can also use the two following options to define the size of the exported images from Sirius diagrams: "SiriusScalingPolicy" that can be one of: WORKSPACE_DEFAULT, AUTO_SCALING, NO_SCALING, AUTO_SCALING_IF_LARGER and "SiriusScaleLevel" and integer. + +* TOC +{:toc} + +## EObject.asImageByRepresentationDescriptionName(String) : Sequence{org.obeonetwork.m2doc.element.MImage} + +Gets the Sequence of images for the diagrams associated to the given EObject with the given description name. + +### Parameter + +* **eObject**: Any eObject that is in the session where to search +* **representationDescriptionName**: the name of the searched representation description + +### Example + +* ePackage.asImageByRepresentationDescriptionName('class diagram') + * Sequence{image1, image2} + +## EObject.asImageByRepresentationDescriptionName(String, boolean) : Sequence{org.obeonetwork.m2doc.element.MImage} + +Gets the Sequence of images for the diagrams associated to the given EObject with the given description name. + +### Parameter + +* **eObject**: Any eObject that is in the session where to search +* **representationDescriptionName**: the name of the searched representation description +* **refresh**: true to refresh the representation + +### Example + +* ePackage.asImageByRepresentationDescriptionName('class diagram', true) + * Sequence{image1, image2} + +## EObject.asImageByRepresentationDescriptionName(String, boolean, OrderedSet{String}) : Sequence{org.obeonetwork.m2doc.element.MImage} + +Gets the Sequence of images for the diagrams associated to the given EObject with the given description name. + +### Parameter + +* **eObject**: Any eObject that is in the session where to search +* **representationDescriptionName**: the name of the searched representation description +* **refresh**: true to refresh the representation +* **layerNames**: the OrderedSet of layer names to activate + +### Example + +* ePackage.asImageByRepresentationDescriptionName('class diagram', true, OrderedSet{'Layer 1', 'Layer 2'}) + * Sequence{image1, image2} + +## EObject.asImageByRepresentationDescriptionName(String, String, boolean) : Sequence{org.obeonetwork.m2doc.element.MImage} + +Gets the Sequence of images for the diagrams associated to the given EObject with the given description name. + +### Parameter + +* **eObject**: Any eObject that is in the session where to search +* **representationDescriptionName**: the name of the searched representation description +* **format**: the image format: BMP, GIF, JPG, JPEG, PNG, SVG +* **refresh**: true to refresh the representation + +### Example + +* ePackage.asImageByRepresentationDescriptionName('class diagram', 'JPG', true) + * Sequence{image1, image2} + +## EObject.asImageByRepresentationDescriptionName(String, String, boolean, OrderedSet{String}) : Sequence{org.obeonetwork.m2doc.element.MImage} + +Gets the Sequence of images for the diagrams associated to the given EObject with the given description name. + +### Parameter + +* **eObject**: Any eObject that is in the session where to search +* **representationDescriptionName**: the name of the searched representation description +* **format**: the image format: BMP, GIF, JPG, JPEG, PNG, SVG +* **refresh**: true to refresh the representation +* **layerNames**: the OrderedSet of layer names to activate + +### Example + +* ePackage.asImageByRepresentationDescriptionName('class diagram', 'JPG', true, OrderedSet{'Layer 1', 'Layer 2'}) + * Sequence{image1, image2} + +## String.asImageByRepresentationName() : org.obeonetwork.m2doc.element.MImage + +Insert the image of the given representation name. + +### Parameter + +* **representationName**: the name of the searched representation + +### Example + +* 'MyEPackage class diagram'.asImageByRepresentationName() + * insert the image + +## String.asImageByRepresentationName(boolean) : org.obeonetwork.m2doc.element.MImage + +Insert the image of the given representation name. + +### Parameter + +* **representationName**: the name of the searched representation +* **refresh**: true to refresh the representation + +### Example + +* 'MyEPackage class diagram'.asImageByRepresentationName(true) + * insert the image after refreshing the representation + +## String.asImageByRepresentationName(boolean, OrderedSet{String}) : org.obeonetwork.m2doc.element.MImage + +Insert the image of the given representation name. + +### Parameter + +* **representationName**: the name of the searched representation +* **refresh**: true to refresh the representation +* **layerNames**: the OrderedSet of layer names to activate + +### Example + +* 'MyEPackage class diagram'.asImageByRepresentationName(true, OrderedSet{'Layer 1', 'Layer 2'}) + * insert the image + +## String.asImageByRepresentationName(String) : org.obeonetwork.m2doc.element.MImage + +Insert the image of the given representation name. + +### Parameter + +* **representationName**: the name of the searched representation +* **format**: the image format: BMP, GIF, JPG, JPEG, PNG, SVG + +### Example + +* 'MyEPackage class diagram'.asImageByRepresentationName('JPG') + * insert the image + +## String.asImageByRepresentationName(String, boolean) : org.obeonetwork.m2doc.element.MImage + +Insert the image of the given representation name. + +### Parameter + +* **representationName**: the name of the searched representation +* **format**: the image format: BMP, GIF, JPG, JPEG, PNG, SVG +* **refresh**: true to refresh the representation + +### Example + +* 'MyEPackage class diagram'.asImageByRepresentationName('JPG', true) + * insert the image after refreshing the representation + +## String.asImageByRepresentationName(String, boolean, OrderedSet{String}) : org.obeonetwork.m2doc.element.MImage + +Insert the image of the given representation name. + +### Parameter + +* **representationName**: the name of the searched representation +* **format**: the image format: BMP, GIF, JPG, JPEG, PNG, SVG +* **refresh**: true to refresh the representation +* **layerNames**: the OrderedSet of layer names to activate + +### Example + +* 'MyEPackage class diagram'.asImageByRepresentationName('JPG, 'true, OrderedSet{'Layer 1', 'Layer 2'}) + * insert the image + +## org.eclipse.sirius.viewpoint.DRepresentation.asImage() : org.obeonetwork.m2doc.element.MImage + +Insert the image of the given representation if it's a diagram. + +### Parameter + +* **representation**: the DRepresentation + +### Example + +* dRepresentation.asImage() + * insert the image of the given representation if it's a diagram + +## org.eclipse.sirius.viewpoint.DRepresentation.asImage(boolean) : org.obeonetwork.m2doc.element.MImage + +Insert the image of the given representation if it's a diagram. + +### Parameter + +* **representation**: the DRepresentation +* **refresh**: true to refresh the representation + +### Example + +* dRepresentation.asImage(true) + * insert the image of the given representation after refreshing it if it's a diagram + +## org.eclipse.sirius.viewpoint.DRepresentation.asImage(boolean, OrderedSet{String}) : org.obeonetwork.m2doc.element.MImage + +Insert the image of the given representation if it's a diagram. + +### Parameter + +* **representation**: the DRepresentation +* **refresh**: true to refresh the representation +* **layerNames**: the OrderedSet of layer names to activate + +### Example + +* dRepresentation.asImage(true, OrderedSet{'Layer 1', 'Layer 2'}) + * insert the image of the given representation if it's a diagram + +## org.eclipse.sirius.viewpoint.DRepresentation.asImage(String) : org.obeonetwork.m2doc.element.MImage + +Insert the image of the given representation if it's a diagram. + +### Parameter + +* **representation**: the DRepresentation +* **format**: the image format: BMP, GIF, JPG, JPEG, PNG, SVG + +### Example + +* dRepresentation.asImage() + * insert the image of the given representation if it's a diagram + +## org.eclipse.sirius.viewpoint.DRepresentation.asImage(String, boolean) : org.obeonetwork.m2doc.element.MImage + +Insert the image of the given representation if it's a diagram. + +### Parameter + +* **representation**: the DRepresentation +* **format**: the image format: BMP, GIF, JPG, JPEG, PNG, SVG +* **refresh**: true to refresh the representation + +### Example + +* dRepresentation.asImage('JPG', true) + * insert the image of the given representation after refreshing it if it's a diagram + +## org.eclipse.sirius.viewpoint.DRepresentation.asImage(String, boolean, OrderedSet{String}) : org.obeonetwork.m2doc.element.MImage + +Insert the image of the given representation if it's a diagram. + +### Parameter + +* **representation**: the DRepresentation +* **format**: the image format: BMP, GIF, JPG, JPEG, PNG, SVG +* **refresh**: true to refresh the representation +* **layerNames**: the OrderedSet of layer names to activate + +### Example + +* dRepresentation.asImage('JPG', true, OrderedSet{'Layer 1', 'Layer 2'}) + * insert the image of the given representation if it's a diagram + +## EObject.asTableByRepresentationDescriptionName(String) : Sequence{org.obeonetwork.m2doc.element.MTable} + +Gets the Sequence of tables for the tables associated to the given EObject with the given description name (with header styles). + +### Parameter + +* **eObject**: Any eObject that is in the session where to search +* **representationDescriptionName**: the name of the searched representation description (with header styles) + +### Example + +* ePackage.asTableByRepresentationDescriptionName('dependency table') + * Sequence{table1, table2} + +## EObject.asTableByRepresentationDescriptionName(String, boolean) : Sequence{org.obeonetwork.m2doc.element.MTable} + +Gets the Sequence of tables for the tables associated to the given EObject with the given description name. + +### Parameter + +* **eObject**: Any eObject that is in the session where to search +* **representationDescriptionName**: the name of the searched representation description +* **withHeader**: true to had header styles, false otherwise + +### Example + +* ePackage.asTableByRepresentationDescriptionName('dependency table', false) + * Sequence{table1, table2} + +## String.asTableByRepresentationName() : org.obeonetwork.m2doc.element.MTable + +Insert the table of the given representation name (with header styles). + +### Parameter + +* **representationName**: the name of the searched representation (with header styles) + +### Example + +* 'MyEPackage class diagram'.asTableByRepresentationName() + * insert the table + +## String.asTableByRepresentationName(boolean) : org.obeonetwork.m2doc.element.MTable + +Insert the table of the given representation name. + +### Parameter + +* **representationName**: the name of the searched representation +* **withHeader**: true to add header styles, false otherwise + +### Example + +* 'MyEPackage class diagram'.asTableByRepresentationName(false) + * insert the table + +## org.eclipse.sirius.table.metamodel.table.DTable.asTable() : org.obeonetwork.m2doc.element.MTable + +Insert the table of the given representation table (with header styles). + +### Parameter + +* **representation**: the DTable + +### Example + +* dTable.asTable() + * insert the table of the given representation table (with header styles) + +## org.eclipse.sirius.table.metamodel.table.DTable.asTable(boolean) : org.obeonetwork.m2doc.element.MTable + +Insert the table of the given representation table. + +### Parameter + +* **representation**: the DTable +* **withHeader**: true to add header styles, false otherwise + +### Example + +* dTable.asTable(false) + * insert the table of the given representation table + +## Object.availableRepresentations() : org.obeonetwork.m2doc.element.MTable + +List all available DRepresentation in a table. + +### Parameter + +* **obj**: Any object + +### Example + +* ''.availableRepresentations() + * the table listing available DRepresentation + +## String.computeAndConvertPathsToHtmlFromOriginal(EObject) : String + +Transforms the serialized text to a text that will be used for html page. This method only changes the image paths. It also ensures that the image is available at the modified location + +### Parameter + +* **htmlString**: The HTML text +* **context**: An EObject context + +## org.eclipse.sirius.viewpoint.DRepresentation.getDescriptor() : org.eclipse.sirius.viewpoint.DRepresentationDescriptor + +Gets the DRepresentationDescriptor of the given DRepresentation. + +### Parameter + +* **representation**: the representation + +### Example + +* myDiagram.getDescriptor().name + * the name of the DRepresentationDescriptor + +## EObject.isRepresentationDescriptionName(String) : boolean + +Returns true if the arguments are not null, the eObject is in a session and there's a representation description with the specified name in it that is associated to the specified eObject. Returns false otherwise. + +### Parameter + +* **eObject**: Any eObject that is in the session where to search +* **representationDescriptionName**: the name of the searched representation description + +### Example + +* ePackage.isRepresentationDescriptionName('class diagram') + * True + +## String.isRepresentationName() : boolean + +Returns true if the arguments are not null, there's a representation with the specified name in the Sirius session. Returns false otherwise. + +### Parameter + +* **representationName**: the name of the searched representation + +### Example + +* 'MyEPackage class diagram'.isRepresentationName() + * True + +## EObject.representationByDescriptionName(String) : Sequence{org.eclipse.sirius.viewpoint.DRepresentation} + +Gets the Sequence DRepresentation associated to the given EObject with the given description name. + +### Parameter + +* **eObject**: Any eObject that is in the session where to search +* **representationDescriptionName**: the name of the searched representation description + +### Example + +* ePackage.asImageByRepresentationDescriptionName('class diagram') + * Sequence{dRepresentation1, dRepresentation2} + +## String.representationByName() : org.eclipse.sirius.viewpoint.DRepresentation + +Gets the DRepresentation of the given representation name. + +### Parameter + +* **representationName**: the name of the searched representation + +### Example + +* 'MyEPackage class diagram'.asImageByRepresentationName() + * dRepresentation1 + + + diff --git a/ref-doc/3.3.3/m2doc_service_m2docwikitextservices.md b/ref-doc/3.3.3/m2doc_service_m2docwikitextservices.md new file mode 100644 index 000000000..c1895f4c5 --- /dev/null +++ b/ref-doc/3.3.3/m2doc_service_m2docwikitextservices.md @@ -0,0 +1,309 @@ +--- +layout: article-services +title: M2DocWikiTextServices +subtitle: 3.3.3 +relativePath: ../.. +--- + + + +# M2DocWikiTextServices + +Services available for WikiText insertion. + +* TOC +{:toc} + +## String.fromAsciiDocString() : Sequence{org.obeonetwork.m2doc.element.MElement} + +Returns a Sequence of MElement corresponding to the given AsciiDoc String. + +### Parameter + +* **markupContents**: The markup contents. + +### Example + +* 'The First Chapter\n-----------------'.fromAsciiDocString() + * The Sequence of MElement corresponding to the given AsciiDoc String. + +## String.fromAsciiDocString(String) : Sequence{org.obeonetwork.m2doc.element.MElement} + +Returns a Sequence of MElement corresponding to the given AsciiDoc String. + +### Parameter + +* **markupContents**: The markup contents. +* **baseURI**: The base URI to use for link and images resolving. + +### Example + +* 'The First Chapter\n-----------------'.fromAsciiDocString('https://www.m2doc.org/') + * The Sequence of MElement corresponding to the given AsciiDoc String. + +## String.fromAsciiDocURI() : Sequence{org.obeonetwork.m2doc.element.MElement} + +Returns a Sequence of MElement corresponding to the given AsciiDoc contents at the given URI. + +### Parameter + +* **srcURI**: The markup contents URI. + +### Example + +* 'contents.txt'.fromAsciiDocString() + * The Sequence of MElement corresponding to the given AsciiDoc contents at the given URI. + +## String.fromConfluenceString() : Sequence{org.obeonetwork.m2doc.element.MElement} + +Returns a Sequence of MElement corresponding to the given Confluence String. + +### Parameter + +* **markupContents**: The markup contents. + +### Example + +* 'h1. The First Chapter'.fromConfluenceString() + * The Sequence of MElement corresponding to the given Confluence String. + +## String.fromConfluenceString(String) : Sequence{org.obeonetwork.m2doc.element.MElement} + +Returns a Sequence of MElement corresponding to the given Confluence String. + +### Parameter + +* **markupContents**: The markup contents. +* **baseURI**: The base URI to use for link and images resolving. + +### Example + +* 'h1. The First Chapter'.fromConfluenceString('https://www.m2doc.org/') + * The Sequence of MElement corresponding to the given Confluence String. + +## String.fromConfluenceURI() : Sequence{org.obeonetwork.m2doc.element.MElement} + +Returns a Sequence of MElement corresponding to the given Confluence contents at the given URI. + +### Parameter + +* **srcURI**: The markup contents URI. + +### Example + +* 'contents.txt'.fromConfluenceString() + * The Sequence of MElement corresponding to the given Confluence contents at the given URI. + +## String.fromMarkdownString() : Sequence{org.obeonetwork.m2doc.element.MElement} + +Returns a Sequence of MElement corresponding to the given Markdown String. + +### Parameter + +* **markupContents**: The markup contents. + +### Example + +* 'The First Chapter\n================='.fromMarkdownString() + * The Sequence of MElement corresponding to the given Markdown String. + +## String.fromMarkdownString(String) : Sequence{org.obeonetwork.m2doc.element.MElement} + +Returns a Sequence of MElement corresponding to the given Markdown String. + +### Parameter + +* **markupContents**: The markup contents. +* **baseURI**: The base URI to use for link and images resolving. + +### Example + +* 'The First Chapter\n================='.fromMarkdownString('https://www.m2doc.org/') + * The Sequence of MElement corresponding to the given Markdown String. + +## String.fromMarkdownURI() : Sequence{org.obeonetwork.m2doc.element.MElement} + +Returns a Sequence of MElement corresponding to the given Markdown contents at the given URI. + +### Parameter + +* **srcURI**: The markup contents URI. + +### Example + +* 'contents.txt'.fromMarkdownString() + * The Sequence of MElement corresponding to the given Markdown contents at the given URI. + +## String.fromMediaWikiString() : Sequence{org.obeonetwork.m2doc.element.MElement} + +Returns a Sequence of MElement corresponding to the given MediaWiki String. + +### Parameter + +* **markupContents**: The markup contents. + +### Example + +* '== The First Chapter =='.fromMediaWikiString() + * The Sequence of MElement corresponding to the given MediaWiki String. + +## String.fromMediaWikiString(String) : Sequence{org.obeonetwork.m2doc.element.MElement} + +Returns a Sequence of MElement corresponding to the given MediaWiki String. + +### Parameter + +* **markupContents**: The markup contents. +* **baseURI**: The base URI to use for link and images resolving. + +### Example + +* '== The First Chapter =='.fromMediaWikiString('https://www.m2doc.org/') + * The Sequence of MElement corresponding to the given MediaWiki String. + +## String.fromMediaWikiURI() : Sequence{org.obeonetwork.m2doc.element.MElement} + +Returns a Sequence of MElement corresponding to the given MediaWiki contents at the given URI. + +### Parameter + +* **srcURI**: The markup contents URI. + +### Example + +* 'contents.txt'.fromMediaWikiString() + * The Sequence of MElement corresponding to the given MediaWiki contents at the given URI. + +## String.fromTWikiString() : Sequence{org.obeonetwork.m2doc.element.MElement} + +Returns a Sequence of MElement corresponding to the given TWiki String. + +### Parameter + +* **markupContents**: The markup contents. + +### Example + +* '---+ The First Chapter'.fromTWikiString() + * The Sequence of MElement corresponding to the given TWiki String. + +## String.fromTWikiString(String) : Sequence{org.obeonetwork.m2doc.element.MElement} + +Returns a Sequence of MElement corresponding to the given TWiki String. + +### Parameter + +* **markupContents**: The markup contents. +* **baseURI**: The base URI to use for link and images resolving. + +### Example + +* '---+ The First Chapter'.fromTWikiString('https://www.m2doc.org/') + * The Sequence of MElement corresponding to the given TWiki String. + +## String.fromTWikiURI() : Sequence{org.obeonetwork.m2doc.element.MElement} + +Returns a Sequence of MElement corresponding to the given TWiki contents at the given URI. + +### Parameter + +* **srcURI**: The markup contents URI. + +### Example + +* 'contents.txt'.fromTWikiString() + * The Sequence of MElement corresponding to the given TWiki contents at the given URI. + +## String.fromTextileString() : Sequence{org.obeonetwork.m2doc.element.MElement} + +Returns a Sequence of MElement corresponding to the given Textile String. + +### Parameter + +* **markupContents**: The markup contents. + +### Example + +* 'h1. The First Chapter'.fromTextileString() + * The Sequence of MElement corresponding to the given Textile String. + +## String.fromTextileString(String) : Sequence{org.obeonetwork.m2doc.element.MElement} + +Returns a Sequence of MElement corresponding to the given Textile String. + +### Parameter + +* **markupContents**: The markup contents. +* **baseURI**: The base URI to use for link and images resolving. + +### Example + +* 'h1. The First Chapter'.fromTextileString('https://www.m2doc.org/') + * The Sequence of MElement corresponding to the given Textile String. + +## String.fromTextileURI() : Sequence{org.obeonetwork.m2doc.element.MElement} + +Returns a Sequence of MElement corresponding to the given Textile contents at the given URI. + +### Parameter + +* **srcURI**: The markup contents URI. + +### Example + +* 'contents.txt'.fromTextileString() + * The Sequence of MElement corresponding to the given Textile contents at the given URI. + +## String.fromTracWikiString() : Sequence{org.obeonetwork.m2doc.element.MElement} + +Returns a Sequence of MElement corresponding to the given TracWiki String. + +### Parameter + +* **markupContents**: The markup contents. + +### Example + +* '= The First Chapter ='.fromTracWikiString() + * The Sequence of MElement corresponding to the given TracWiki String. + +## String.fromTracWikiString(String) : Sequence{org.obeonetwork.m2doc.element.MElement} + +Returns a Sequence of MElement corresponding to the given TracWiki String. + +### Parameter + +* **markupContents**: The markup contents. +* **baseURI**: The base URI to use for link and images resolving. + +### Example + +* '= The First Chapter ='.fromTracWikiString('https://www.m2doc.org/') + * The Sequence of MElement corresponding to the given TracWiki String. + +## String.fromTracWikiURI() : Sequence{org.obeonetwork.m2doc.element.MElement} + +Returns a Sequence of MElement corresponding to the given TracWiki contents at the given URI. + +### Parameter + +* **srcURI**: The markup contents URI. + +### Example + +* 'contents.txt'.fromTracWikiString() + * The Sequence of MElement corresponding to the given TracWiki contents at the given URI. + + + diff --git a/ref-doc/3.3.3/m2doc_service_paginationservices.md b/ref-doc/3.3.3/m2doc_service_paginationservices.md new file mode 100644 index 000000000..341f13a91 --- /dev/null +++ b/ref-doc/3.3.3/m2doc_service_paginationservices.md @@ -0,0 +1,165 @@ +--- +layout: article-services +title: PaginationServices +subtitle: 3.3.3 +relativePath: ../.. +--- + + + +# PaginationServices + +Services available for pagination. See [document examples](https://github.com/ObeoNetwork/M2Doc/tree/3.3.3/tests/org.obeonetwork.m2doc.tests/resources/paginationServices). + +* TOC +{:toc} + +## String.asPagination() : org.obeonetwork.m2doc.element.MPagination + +Converts a String to an hyperlink + +### Parameter + +* **paginationElement**: The name of the pagination element: 'newTableOfContent', 'newPage', 'newParagraph', 'newColumn', 'newTextWrapping' + +### Example + +* 'newPage'.asPagination() + * insert a page break + +## String.asParagraph() : org.obeonetwork.m2doc.element.MParagraph + +Convert a String into a MParagraph. + +### Parameter + +* **text**: The text + +### Example + +* 'some text'.asParagraph() + * insert 'some text' in a new paragraph. + +## String.asStyle(String) : org.obeonetwork.m2doc.element.MParagraph + +Converts a String with a given style if the style exists in the template, this service will insert a new paragraph. You can add styled text in comment to make sure they are present. + +### Parameter + +* **text**: The text +* **style**: The style ID. see availableTextStyles(). + +### Example + +* 'Section 1'.asStyle('Title1') + * insert 'Section 1' as style 'Titre1' in a new paragraph if the style exists in the template. + +## org.obeonetwork.m2doc.element.MTable.asStyle(String) : org.obeonetwork.m2doc.element.MTable + +Converts a MTable with a given style if the style exists in the template. You can add styled text in blockcomment to make sure they are present. + +### Parameter + +* **table**: The MTable +* **styleID**: The style ID. see availableTableStyles(). + +### Example + +* myTable.asStyle('Title1') + * set the given style to myTable. + +## Object.availableNumberingIDs() : Sequence{org.obeonetwork.m2doc.element.MParagraph} + +Lists available numbering IDs in the template. You can add bullet/numbered list in comment to make sure a numbering is present. + +### Parameter + +* **obj**: Any object + +### Example + +* ''.availableNumberingIDs() + * insert 'List of available numbering IDs:...'. + +## Object.availableTableStyles() : Sequence{org.obeonetwork.m2doc.element.MElement} + +Lists available table styles in the template. You can add styled table in comment to make sure a style is present. + +### Parameter + +* **obj**: Any object + +### Example + +* ''.availableTableStyles() + * insert 'List of available table styles:...'. + +## Object.availableTextStyles() : Sequence{org.obeonetwork.m2doc.element.MParagraph} + +Lists available text styles in the template. You can add styled text in comment to make sure a style is present. + +### Parameter + +* **obj**: Any object + +### Example + +* ''.availableTextStyles() + * insert 'List of available text styles:...'. + +## org.obeonetwork.m2doc.element.MParagraph.setAlignment(String) : org.obeonetwork.m2doc.element.MParagraph + +Sets the alignment of the paragraph. + +### Parameter + +* **paragraph**: The paragraph +* **alignment**: The alignment name: 'BOTH', 'CENTER', 'DISTRIBUTED', 'HIGH_KASHIDA', 'LEFT', 'LOW_KASHIDA', 'MEDIUM_KASHIDA', 'NUM_TAB', 'RIGHT', 'THAI_DISTRIBUTE'. + +### Example + +* myParagraph.setAlignment('CENTER') + * Sets the alignment to center. + +## org.obeonetwork.m2doc.element.MParagraph.setNumbering(Integer, Integer) : org.obeonetwork.m2doc.element.MParagraph + +Sets the numbering and level of the paragraph. + +### Parameter + +* **paragraph**: The paragraph +* **numberingID**: The integer idenfying the numbering. see availableNumberingIDs(). +* **level**: The level in the numbering. see availableNumberingIDs(). + +### Example + +* myParagraph.setNumbering(0, 3) + * Sets the numbering to the 0 numbering and level to 3 in this numbering. + +## org.obeonetwork.m2doc.element.MParagraph.setStyle(String) : org.obeonetwork.m2doc.element.MParagraph + +Sets the style of the paragraph. + +### Parameter + +* **paragraph**: The paragraph +* **styleID**: The style ID. see availableTextStyles(). + +### Example + +* myParagraph.setStyle('Title1') + * Sets the style to Title1. + + + diff --git a/ref-doc/3.3.3/m2doc_service_promptservices.md b/ref-doc/3.3.3/m2doc_service_promptservices.md new file mode 100644 index 000000000..3e6331f8a --- /dev/null +++ b/ref-doc/3.3.3/m2doc_service_promptservices.md @@ -0,0 +1,94 @@ +--- +layout: article-services +title: PromptServices +subtitle: 3.3.3 +relativePath: ../.. +--- + + + +# PromptServices + +Services available for prompting user for values using the console. + +* TOC +{:toc} + +## String.promptDouble() : Double + +Prompts for a Double value with the given message. + +### Parameter + +* **message**: The message displayed to the user + +### Example + +* 'Enter your weight: '.promptDouble() + * prompts the user + +## String.promptFloat() : Float + +Prompts for a Float value with the given message. + +### Parameter + +* **message**: The message displayed to the user + +### Example + +* 'Enter your weight: '.promptFloat() + * prompts the user + +## String.promptInteger() : Integer + +Prompts for a Integer value with the given message. + +### Parameter + +* **message**: The message displayed to the user + +### Example + +* 'Enter your age: '.promptInteger() + * prompts the user + +## String.promptLong() : Long + +Prompts for a Long value with the given message. + +### Parameter + +* **message**: The message displayed to the user + +### Example + +* 'Enter your age: '.promptLong() + * prompts the user + +## String.promptString() : String + +Prompts for a String value with the given message. + +### Parameter + +* **message**: The message displayed to the user + +### Example + +* 'Enter your name: '.promptString() + * prompts the user + + + diff --git a/ref-doc/3.3.3/m2doc_service_semanticbrowserservices.md b/ref-doc/3.3.3/m2doc_service_semanticbrowserservices.md new file mode 100644 index 000000000..64603fee6 --- /dev/null +++ b/ref-doc/3.3.3/m2doc_service_semanticbrowserservices.md @@ -0,0 +1,5047 @@ +--- +layout: article-services +title: SemanticBrowserServices +subtitle: 3.3.3 +relativePath: ../.. +--- + + + +# SemanticBrowserServices + +Services available for the Capella semantic browser. + +* TOC +{:toc} + +## org.polarsys.capella.core.data.capellacommon.State.getActiveElementsComputed() : Sequence{EObject} + +Returns the Sequence of computed active elements for the given State. + +### Parameter + +* **value**: the State + +### Example + +* myState.getActiveElementsComputed() + * the Sequence of computed active elements for the given State + +## org.polarsys.capella.core.data.capellacommon.State.getActiveElements() : Sequence{EObject} + +Returns the Sequence of active elements for the given State. + +### Parameter + +* **value**: the State + +### Example + +* myState.getActiveElements() + * the Sequence of active elements for the given State + +## org.polarsys.capella.core.data.fa.AbstractFunction.getActiveInModes() : Sequence{org.polarsys.capella.core.data.capellacommon.Mode} + +Returns the Sequence of active modes for the given AbstractFunction. + +### Parameter + +* **value**: the AbstractFunction + +### Example + +* myAbstractFunction.getActiveInModes() + * the Sequence of active modes for the given AbstractFunction + +## org.polarsys.capella.core.data.fa.FunctionalChain.getActiveInModes() : Sequence{org.polarsys.capella.core.data.capellacommon.Mode} + +Returns the Sequence of active modes for the given FunctionalChain. + +### Parameter + +* **value**: the FunctionalChain + +### Example + +* myFunctionalChain.getActiveInModes() + * the Sequence of active modes for the given FunctionalChain + +## org.polarsys.capella.core.data.interaction.AbstractCapability.getActiveInModes() : Sequence{org.polarsys.capella.core.data.capellacommon.Mode} + +Returns the Sequence of active modes for the given AbstractCapability. + +### Parameter + +* **value**: the AbstractCapability + +### Example + +* myAbstractCapability.getActiveInModes() + * the Sequence of active modes for the given AbstractCapability + +## org.polarsys.capella.core.data.fa.AbstractFunction.getActiveInStates() : Sequence{org.polarsys.capella.core.data.capellacommon.Mode} + +Returns the Sequence of active states for the given AbstractFunction. + +### Parameter + +* **value**: the AbstractFunction + +### Example + +* myAbstractFunction.getActiveInStates() + * the Sequence of active states for the given AbstractFunction + +## org.polarsys.capella.core.data.fa.FunctionalChain.getActiveInStates() : Sequence{org.polarsys.capella.core.data.capellacommon.Mode} + +Returns the Sequence of active states for the given FunctionalChain. + +### Parameter + +* **value**: the FunctionalChain + +### Example + +* myFunctionalChain.getActiveInStates() + * the Sequence of active states for the given FunctionalChain + +## org.polarsys.capella.core.data.interaction.AbstractCapability.getActiveInStates() : Sequence{org.polarsys.capella.core.data.capellacommon.Mode} + +Returns the Sequence of active states for the given AbstractCapability. + +### Parameter + +* **value**: the AbstractCapability + +### Example + +* myAbstractCapability.getActiveInStates() + * the Sequence of active states for the given AbstractCapability + +## org.polarsys.capella.common.data.modellingcore.ModelElement.getAllRelatedDiagrams() : Sequence{org.eclipse.sirius.viewpoint.DRepresentationDescriptor} + +Returns the Sequence of all related diagrams for the given ModelElement. + +### Parameter + +* **value**: the ModelElement + +### Example + +* myModelElement.getAllRelatedDiagrams() + * the Sequence of all related diagrams for the given ModelElement + +## org.polarsys.capella.common.data.modellingcore.ModelElement.getAllRelatedTables() : Sequence{org.eclipse.sirius.viewpoint.DRepresentationDescriptor} + +Returns the Sequence of all related tables for the given ModelElement. + +### Parameter + +* **value**: the ModelElement + +### Example + +* myModelElement.getAllRelatedTables() + * the Sequence of all related tables for the given ModelElement + +## org.polarsys.capella.core.data.cs.PhysicalLink.getAllocatedComponentExchanges() : Sequence{org.polarsys.capella.common.data.modellingcore.TraceableElement} + +Returns the Sequence of allocated component exchanges for the given PhysicalLink. + +### Parameter + +* **value**: the PhysicalLink + +### Example + +* myPhysicalLink.getAllocatedComponentExchanges() + * the Sequence of allocated component exchanges for the given PhysicalLink + +## org.polarsys.capella.core.data.cs.PhysicalPath.getAllocatedComponentExchanges() : Sequence{org.polarsys.capella.core.data.fa.ComponentExchange} + +Returns the Sequence of allocated component exchanges for the given PhysicalPath. + +### Parameter + +* **value**: the PhysicalPath + +### Example + +* myPhysicalPath.getAllocatedComponentExchanges() + * the Sequence of allocated component exchanges for the given PhysicalPath + +## org.polarsys.capella.core.data.cs.PhysicalPort.getAllocatedComponentPorts() : Sequence{org.polarsys.capella.core.data.fa.ComponentPort} + +Returns the Sequence of allocated component ports links for the given PhysicalPort. + +### Parameter + +* **value**: the PhysicalPort + +### Example + +* myPhysicalPort.getAllocatedComponentPorts() + * the Sequence of allocated component ports for the given PhysicalPort + +## org.polarsys.capella.core.data.cs.PhysicalPort.getAllocatedFunctionPorts() : Sequence{org.polarsys.capella.core.data.fa.FunctionPort} + +Returns the Sequence of allocated function ports links for the given PhysicalPort. + +### Parameter + +* **value**: the PhysicalPort + +### Example + +* myPhysicalPort.getAllocatedFunctionPorts() + * the Sequence of allocated function ports for the given PhysicalPort + +## org.polarsys.capella.core.data.fa.ComponentPort.getAllocatedFunctionPorts() : Sequence{org.polarsys.capella.core.data.information.Port} + +Returns the Sequence of realized component ports for the given ComponentPort. + +### Parameter + +* **value**: the ComponentPort + +### Example + +* myComponentPort.getRealizedComponentPorts() + * the Sequence of realized component ports for the given ComponentPort + +## org.polarsys.capella.core.data.fa.ComponentExchange.getAllocatedFunctionalExchanges() : Sequence{org.polarsys.capella.core.data.fa.FunctionalExchange} + +Returns the Sequence of allocated functional exchances for the given ComponentExchange. + +### Parameter + +* **value**: the ComponentExchange + +### Example + +* myComponentExchange.getAllocatedFunctionalExchanges() + * the Sequence of allocated functional exchances for the given ComponentExchange + +## org.polarsys.capella.core.data.oa.CommunicationMean.getAllocatedInteractions() : Sequence{org.polarsys.capella.core.data.fa.FunctionalExchange} + +Returns the Sequence of allocated interactions for the given CommunicationMean. + +### Parameter + +* **value**: the CommunicationMean + +### Example + +* myCommunicationMean.getAllocatedInteractions() + * the Sequence of allocated interactions for the given CommunicationMean + +## org.polarsys.capella.core.data.la.LogicalComponent.getAllocatedLogicalFunctions() : Sequence{org.polarsys.capella.core.data.la.LogicalFunction} + +Returns the Sequence of allocated logical functions for the given LogicalFunction. + +### Parameter + +* **value**: the LogicalFunction + +### Example + +* myLogicalFunction.getAllocatedLogicalFunctions() + * the Sequence of realized system components for the given LogicalFunction + +## org.polarsys.capella.core.data.oa.Entity.getAllocatedOperationalActivities() : Sequence{org.polarsys.capella.core.data.oa.OperationalActivity} + +Returns the Sequence of allocated operational activities for the given Entity. + +### Parameter + +* **value**: the Entity + +### Example + +* myEntity.getAllocatedOperationalActivities() + * the Sequence of allocated operational activities for the given Entity + +## org.polarsys.capella.core.data.oa.Role.getAllocatedOperationalActivities() : Sequence{org.polarsys.capella.core.data.oa.OperationalActivity} + +Returns the Sequence of allocating operational activities for the given Role. + +### Parameter + +* **value**: the Role + +### Example + +* myAllocation.getAllocatedOperationalActivities() + * the Sequence of allocating operational activities for the given Role + +## org.polarsys.capella.core.data.pa.PhysicalComponent.getAllocatedPhysicalFunctions() : Sequence{org.polarsys.capella.core.data.pa.PhysicalFunction} + +Returns the Sequence of allocated physical functions for the given PhysicalComponent. + +### Parameter + +* **value**: the PhysicalComponent + +### Example + +* myPhysicalComponent.getAllocatedPhysicalFunctions() + * the Sequence of allocated physical functions for the given PhysicalComponent + +## org.polarsys.capella.core.data.oa.Entity.getAllocatedRoles() : Sequence{org.polarsys.capella.core.data.oa.Role} + +Returns the Sequence of allocated roles for the given Entity. + +### Parameter + +* **value**: the Entity + +### Example + +* myEntity.getAllocatedRoles() + * the Sequence of allocated roles for the given Entity + +## org.polarsys.capella.core.data.ctx.SystemComponent.getAllocatedSystemFunctions() : Sequence{org.polarsys.capella.core.data.ctx.SystemFunction} + +Returns the Sequence of allocated system functions for the given SystemComponent. + +### Parameter + +* **value**: the SystemComponent + +### Example + +* mySystemComponent.getAllocatedSystemFunctions() + * the Sequence of allocated system functions for the given SystemComponent + +## org.polarsys.capella.core.data.fa.AbstractFunction.getAllocatingActorComponentComputed() : Sequence{org.polarsys.capella.core.data.cs.Component} + +Returns the Sequence of computed actor components for the given AbstractFunction. + +### Parameter + +* **value**: the AbstractFunction + +### Example + +* myAbstractFunction.getAllocatingActorComponentComputed() + * the Sequence of computed actor components for the given AbstractFunction + +## org.polarsys.capella.core.data.oa.OperationalActivity.getAllocatingActorEntityRoleComputed() : Sequence{EObject} + +Returns the Sequence of computed allocating actor entitie roles for the given OperationalActivity. + +### Parameter + +* **value**: the OperationalActivity + +### Example + +* myOperationalActivity.getAllocatingActorEntityRoleComputed() + * the Sequence of computed allocating actor entitie roles for the given OperationalActivity + +## org.polarsys.capella.core.data.ctx.SystemFunction.getAllocatingActor() : Sequence{EObject} + +Returns the Sequence of allocating actors for the given SystemFunction. + +### Parameter + +* **value**: the SystemFunction + +### Example + +* mySystemFunction.getAllocatingActor() + * the Sequence of allocating actors for the given SystemFunction + +## org.polarsys.capella.core.data.fa.FunctionalExchange.getAllocatingCommunicationMean() : Sequence{org.polarsys.capella.core.data.oa.CommunicationMean} + +Returns the Sequence of allocating communication means for the given FunctionalExchange. + +### Parameter + +* **value**: the FunctionalExchange + +### Example + +* myFunctionalExchange.getAllocatingCommunicationMean() + * the Sequence of allocating communication means for the given FunctionalExchange + +## org.polarsys.capella.core.data.fa.FunctionalExchange.getAllocatingComponentExchange() : Sequence{org.polarsys.capella.core.data.fa.ComponentExchange} + +Returns the Sequence of allocating component exchanges for the given FunctionalExchange. + +### Parameter + +* **value**: the FunctionalExchange + +### Example + +* myFunctionalExchange.getAllocatingComponentExchange() + * the Sequence of allocating component exchanges for the given FunctionalExchange + +## org.polarsys.capella.core.data.fa.FunctionPort.getAllocatingComponentPorts() : Sequence{org.polarsys.capella.core.data.fa.ComponentPort} + +Returns the Sequence of allocating component ports for the given FunctionPort. + +### Parameter + +* **value**: the FunctionPort + +### Example + +* myFunctionPort.getAllocatingComponentPorts() + * the Sequence of allocating component ports for the given FunctionPort + +## org.polarsys.capella.core.data.oa.Role.getAllocatingEntities() : Sequence{org.polarsys.capella.core.data.oa.Entity} + +Returns the Sequence of allocating entities for the given Role. + +### Parameter + +* **value**: the Role + +### Example + +* myAllocation.getAllocatingEntities() + * the Sequence of entities activities for the given Role + +## org.polarsys.capella.core.data.oa.OperationalActivity.getAllocatingEntity() : Sequence{EObject} + +Returns the Sequence of allocating entities for the given OperationalActivity. + +### Parameter + +* **value**: the OperationalActivity + +### Example + +* myOperationalActivity.getAllocatingEntity() + * the Sequence of allocating entities for the given OperationalActivity + +## org.polarsys.capella.core.data.information.ExchangeItem.getAllocatingExchanges() : Sequence{Object} + +Returns the Sequence of allocating exchanges for the given ExchangeItem. + +### Parameter + +* **value**: the ExchangeItem + +### Example + +* myExchangeItem.getAllocatingExchanges() + * the Sequence of allocating exchanges for the given ExchangeItem + +## org.polarsys.capella.core.data.information.ExchangeItem.getAllocatingFunctionInputPorts() : Sequence{org.polarsys.capella.core.data.fa.FunctionInputPort} + +Returns the Sequence of allocating function input ports for the given ExchangeItem. + +### Parameter + +* **value**: the ExchangeItem + +### Example + +* myExchangeItem.getAllocatingFunctionInputPorts() + * the Sequence of allocating function input ports for the given ExchangeItem + +## org.polarsys.capella.core.data.information.ExchangeItem.getAllocatingFunctionOutputPorts() : Sequence{org.polarsys.capella.core.data.fa.FunctionOutputPort} + +Returns the Sequence of allocating function output ports for the given ExchangeItem. + +### Parameter + +* **value**: the ExchangeItem + +### Example + +* myExchangeItem.getAllocatingFunctionOutputPorts() + * the Sequence of allocating function output ports for the given ExchangeItem + +## org.polarsys.capella.core.data.la.LogicalFunction.getAllocatingLogicalActor() : Sequence{EObject} + +Returns the Sequence of allocating logical actors for the given LogicalFunction. + +### Parameter + +* **value**: the LogicalFunction + +### Example + +* myLogicalFunction.getAllocatingLogicalActor() + * the Sequence of allocating logical actors for the given LogicalFunction + +## org.polarsys.capella.core.data.la.LogicalFunction.getAllocatingLogicalComponent() : Sequence{EObject} + +Returns the Sequence of allocating logical components for the given LogicalFunction. + +### Parameter + +* **value**: the LogicalFunction + +### Example + +* myLogicalFunction.getAllocatingLogicalComponent() + * the Sequence of allocating logical components for the given LogicalFunction + +## org.polarsys.capella.core.data.oa.OperationalActivity.getAllocatingOperationalActor() : Sequence{EObject} + +Returns the Sequence of allocating operational actors for the given OperationalActivity. + +### Parameter + +* **value**: the OperationalActivity + +### Example + +* myOperationalActivity.getAllocatingOperationalActor() + * the Sequence of allocating operational actors for the given OperationalActivity + +## org.polarsys.capella.core.data.pa.PhysicalFunction.getAllocatingPhysicalActor() : Sequence{EObject} + +Returns the Sequence of allocating physical actors for the given PhysicalFunction. + +### Parameter + +* **value**: the PhysicalFunction + +### Example + +* myPhysicalFunction.getAllocatingPhysicalActor() + * the Sequence of allocating physical actors for the given PhysicalFunction + +## org.polarsys.capella.core.data.pa.PhysicalFunction.getAllocatingPhysicalComponent() : Sequence{EObject} + +Returns the Sequence of allocating physical components for the given PhysicalFunction. + +### Parameter + +* **value**: the PhysicalFunction + +### Example + +* myPhysicalFunction.getAllocatingPhysicalComponent() + * the Sequence of allocating physical components for the given PhysicalFunction + +## org.polarsys.capella.core.data.fa.ComponentExchange.getAllocatingPhysicalLink() : Sequence{org.polarsys.capella.core.data.cs.PhysicalLink} + +Returns the Sequence of allocating physical link for the given ComponentExchange. + +### Parameter + +* **value**: the ComponentExchange + +### Example + +* myComponentExchange.getAllocatingPhysicalLink() + * the Sequence of allocating physical link for the given ComponentExchange + +## org.polarsys.capella.core.data.fa.ComponentExchange.getAllocatingPhysicalPath() : Sequence{org.polarsys.capella.core.data.cs.PhysicalPath} + +Returns the Sequence of allocating physical path for the given ComponentExchange. + +### Parameter + +* **value**: the ComponentExchange + +### Example + +* myComponentExchange.getAllocatingPhysicalPath() + * the Sequence of allocating physical path for the given ComponentExchange + +## org.polarsys.capella.core.data.fa.ComponentPort.getAllocatingPhysicalPorts() : Sequence{org.polarsys.capella.core.data.cs.PhysicalPort} + +Returns the Sequence of allocating physical ports for the given ComponentPort. + +### Parameter + +* **value**: the ComponentPort + +### Example + +* myComponentPort.getAllocatingPhysicalPorts() + * the Sequence of allocating physical ports for the given ComponentPort + +## org.polarsys.capella.core.data.oa.OperationalActivity.getAllocatingRole() : Sequence{org.polarsys.capella.core.data.oa.Role} + +Returns the Sequence of allocating roles for the given OperationalActivity. + +### Parameter + +* **value**: the OperationalActivity + +### Example + +* myOperationalActivity.getAllocatingRole() + * the Sequence of allocating roles for the given OperationalActivity + +## org.polarsys.capella.core.data.ctx.SystemFunction.getAllocatingSystem() : Sequence{EObject} + +Returns the Sequence of allocating system for the given SystemFunction. + +### Parameter + +* **value**: the SystemFunction + +### Example + +* mySystemFunction.getAllocatingSystem() + * the Sequence of allocating system for the given SystemFunction + +## org.polarsys.capella.core.data.capellacore.CapellaElement.getAppliedPropertyValueGroups() : Sequence{org.polarsys.capella.core.data.capellacore.PropertyValueGroup} + +Returns the Sequence of applied property value groups for the given CapellaElement. + +### Parameter + +* **value**: the CapellaElement + +### Example + +* myCapellaElement.getAppliedPropertyValueGroups() + * the Sequence of applied property value groups for the given CapellaElement + +## org.polarsys.capella.core.data.capellacore.CapellaElement.getAppliedPropertyValues() : Sequence{org.polarsys.capella.core.data.capellacore.AbstractPropertyValue} + +Returns the Sequence of applied property values for the given CapellaElement. + +### Parameter + +* **value**: the CapellaElement + +### Example + +* myCapellaElement.getAppliedPropertyValues() + * the Sequence of applied property values for the given CapellaElement + +## org.eclipse.sirius.viewpoint.description.DAnnotation.getAssociatedDiagram() : Sequence{org.eclipse.sirius.viewpoint.DRepresentationDescriptor} + +Returns the Sequence of associated diagram for the given DAnnotation. + +### Parameter + +* **value**: the DAnnotation + +### Example + +* myDAnnotation.getAssociatedDiagram() + * the Sequence of associated diagram for the given DAnnotation + +## org.eclipse.sirius.viewpoint.description.DAnnotation.getAssociatedElement() : Sequence{EObject} + +Returns the Sequence of associated element for the given DAnnotation. + +### Parameter + +* **value**: the DAnnotation + +### Example + +* myDAnnotation.getAssociatedElement() + * the Sequence of associated element for the given DAnnotation + +## org.polarsys.capella.core.data.information.Property.getAssociation() : Sequence{org.polarsys.capella.core.data.information.Association} + +Returns the Sequence of associations for the given Property. + +### Parameter + +* **value**: the Property + +### Example + +* myProperty.getAssociation() + * the Sequence of associations for the given Property + +## org.polarsys.capella.core.data.fa.AbstractFunction.getBreakdown() : Sequence{org.polarsys.capella.core.data.fa.AbstractFunction} + +Returns the Sequence of breakdown for the given AbstractFunction. + +### Parameter + +* **value**: the AbstractFunction + +### Example + +* myAbstractFunction.getBreakdown() + * the Sequence of breakdown for the given AbstractFunction + +## org.polarsys.capella.core.data.oa.Entity.getBreakdown() : Sequence{org.polarsys.capella.core.data.oa.Entity} + +Returns the Sequence of breakdown for the given Entity. + +### Parameter + +* **value**: the Entity + +### Example + +* myEntity.getBreakdown() + * the Sequence of breakdown for the given Entity + +## org.polarsys.capella.core.data.cs.PhysicalLink.getCategories() : Sequence{org.polarsys.capella.core.data.cs.PhysicalLinkCategory} + +Returns the Sequence of categories for the given PhysicalLink. + +### Parameter + +* **value**: the PhysicalLink + +### Example + +* myPhysicalLink.getCategories() + * the Sequence of categories for the given PhysicalLink + +## org.polarsys.capella.core.data.fa.ComponentExchange.getCategories() : Sequence{org.polarsys.capella.core.data.fa.ComponentExchangeCategory} + +Returns the Sequence of categories for the given ComponentExchange. + +### Parameter + +* **value**: the ComponentExchange + +### Example + +* myComponentExchange.getCategories() + * the Sequence of categories for the given ComponentExchange + +## org.polarsys.capella.core.data.fa.FunctionalExchange.getCategories() : Sequence{org.polarsys.capella.core.data.fa.ExchangeCategory} + +Returns the Sequence of categories for the given FunctionalExchange. + +### Parameter + +* **value**: the FunctionalExchange + +### Example + +* myFunctionalExchange.getCategories() + * the Sequence of categories for the given FunctionalExchange + +## org.polarsys.capella.core.data.cs.Component.getCommunicationLink() : Sequence{org.polarsys.capella.core.data.information.communication.CommunicationLink} + +Returns the Sequence of communication links for the given Component. + +### Parameter + +* **value**: the Component + +### Example + +* myComponent.getCommunicationLink() + * the Sequence of communication links for the given Component + +## org.polarsys.capella.core.data.information.ExchangeItem.getCommunicationLinks() : Sequence{EObject} + +Returns the Sequence of communication links for the given ExchangeItem. + +### Parameter + +* **value**: the ExchangeItem + +### Example + +* myExchangeItem.getCommunicationLinks() + * the Sequence of communication links for the given ExchangeItem + +## org.polarsys.capella.core.data.cs.Component.getComponentBreakdown() : Sequence{org.polarsys.capella.core.data.cs.Component} + +Returns the Sequence of component breakdown for the given Component. + +### Parameter + +* **value**: the Component + +### Example + +* myComponent.getComponentBreakdown() + * the Sequence of component breakdown for the given Component + +## org.polarsys.capella.core.data.fa.ComponentExchangeCategory.getComponentExchanges() : Sequence{org.polarsys.capella.core.data.fa.ComponentExchange} + +Returns the Sequence of component exchanges for the given ComponentExchangeCategory. + +### Parameter + +* **value**: the ComponentExchangeCategory + +### Example + +* myComponentExchangeCategory.getComponentExchanges() + * the Sequence of component exchanges for the given ComponentExchangeCategory + +## org.polarsys.capella.core.data.cs.Component.getComponentPorts() : Sequence{org.polarsys.capella.core.data.fa.ComponentPort} + +Returns the Sequence of component ports for the given Component. + +### Parameter + +* **value**: the Component + +### Example + +* myComponent.getComponentPorts() + * the Sequence of component ports for the given Component + +## org.polarsys.capella.core.data.fa.SequenceLink.getCondition() : Sequence{org.polarsys.capella.core.data.capellacore.Constraint} + +Returns the Sequence of condition for the given SequenceLink. + +### Parameter + +* **value**: the SequenceLink + +### Example + +* mySequenceLink.getCondition() + * the Sequence of condition for the given SequenceLink + +## org.polarsys.capella.core.data.fa.ComponentExchange.getConnectedComponents() : Sequence{org.polarsys.capella.core.data.cs.Component} + +Returns the Sequence of connected components for the given ComponentExchange. + +### Parameter + +* **value**: the ComponentExchange + +### Example + +* myComponentExchange.getConnectedComponents() + * the Sequence of connected components for the given ComponentExchange + +## org.polarsys.capella.core.data.fa.ComponentExchange.getConnectedParts() : Sequence{org.polarsys.capella.core.data.cs.Part} + +Returns the Sequence of connected parts for the given ComponentExchange. + +### Parameter + +* **value**: the ComponentExchange + +### Example + +* myComponentExchange.getConnectedParts() + * the Sequence of connected parts for the given ComponentExchange + +## org.polarsys.capella.core.data.capellacore.Constraint.getConstrainedElements() : Sequence{org.polarsys.capella.common.data.modellingcore.ModelElement} + +Returns the Sequence of constrained elements for the given Constraint. + +### Parameter + +* **value**: the Constraint + +### Example + +* myConstraint.getConstrainedElements() + * the Sequence of constrained elements for the given Constraint + +## org.polarsys.capella.common.data.modellingcore.ModelElement.getConstrainingElements() : Sequence{org.polarsys.capella.common.data.modellingcore.AbstractConstraint} + +Returns the Sequence of constraining elements for the given ModelElement. + +### Parameter + +* **value**: the ModelElement + +### Example + +* myModelElement.getConstrainingElements() + * the Sequence of constraining elements for the given ModelElement + +## org.eclipse.sirius.viewpoint.DRepresentationDescriptor.getContextualElements() : Sequence{EObject} + +Returns the Sequence of contextual elements for the given DRepresentationDescriptor. + +### Parameter + +* **value**: the DRepresentationDescriptor + +### Example + +* myDRepresentationDescriptor.getContextualElements() + * the Sequence of contextual elements for the given DRepresentationDescriptor + +## org.polarsys.capella.core.data.capellacore.AbstractDependenciesPkg.getDependencies() : Sequence{org.polarsys.capella.core.data.capellacore.AbstractDependenciesPkg} + +Returns the Sequence of dependencies for the given AbstractDependenciesPkg. + +### Parameter + +* **value**: the AbstractDependenciesPkg + +### Example + +* myAbstractDependenciesPkg.getDependencies() + * the Sequence of dependencies for the given AbstractDependenciesPkg + +## org.polarsys.capella.core.data.pa.PhysicalComponent.getDeployedPhysicalComponents() : Sequence{org.polarsys.capella.core.data.cs.Component} + +Returns the Sequence of deployed physical components for the given PhysicalComponent. + +### Parameter + +* **value**: the PhysicalComponent + +### Example + +* myPhysicalComponent.getDeployedPhysicalComponents() + * the Sequence of deployed physical components for the given PhysicalComponent + +## org.polarsys.capella.core.data.pa.PhysicalComponent.getDeployingPhysicalComponents() : Sequence{org.polarsys.capella.core.data.pa.PhysicalComponent} + +Returns the Sequence of deploying physical components for the given PhysicalComponent. + +### Parameter + +* **value**: the PhysicalComponent + +### Example + +* myPhysicalComponent.getDeployingPhysicalComponents() + * the Sequence of deploying physical components for the given PhysicalComponent + +## org.polarsys.capella.core.data.capellacommon.State.getDoActivity() : Sequence{org.polarsys.capella.common.data.behavior.AbstractEvent} + +Returns the Sequence of do activity for the given State. + +### Parameter + +* **value**: the State + +### Example + +* myState.getDoActivity() + * the Sequence of do activity for the given State + +## org.polarsys.capella.core.data.capellacommon.StateTransition.getEffect() : Sequence{org.polarsys.capella.common.data.behavior.AbstractEvent} + +Returns the Sequence of effect for the given StateTransition. + +### Parameter + +* **value**: the StateTransition + +### Example + +* myStateTransition.getEffect() + * the Sequence of effect for the given StateTransition + +## org.polarsys.kitalpha.emde.model.Element.getElementOfInterestForDiagram() : Sequence{EObject} + +Returns the Sequence of element of interest for diagram for the given Element. + +### Parameter + +* **value**: the Element + +### Example + +* myModelElement.getElementOfInterestForDiagram() + * the Sequence of element of interest for diagram for the given Element + +## org.eclipse.sirius.viewpoint.DRepresentationDescriptor.getElementsOfInterest() : Sequence{EObject} + +Returns the Sequence of element of interest for the given DRepresentationDescriptor. + +### Parameter + +* **value**: the DRepresentationDescriptor + +### Example + +* myDRepresentationDescriptor.getElementsOfInterest() + * the Sequence of element of interest for the given DRepresentationDescriptor + +## org.polarsys.capella.common.data.modellingcore.ModelElement.getExchangeContext() : Sequence{org.polarsys.capella.common.data.modellingcore.AbstractConstraint} + +Returns the Sequence of exchange context for the given ModelElement. + +### Parameter + +* **value**: the ModelElement + +### Example + +* myModelElement.getExchangeContext() + * the Sequence of exchange context for the given ModelElement + +## org.polarsys.capella.core.data.fa.FunctionalChainInvolvementLink.getExchangeContext() : Sequence{org.polarsys.capella.core.data.capellacore.Constraint} + +Returns the Sequence of exchange context for the given FunctionalChainInvolvementLink. + +### Parameter + +* **value**: the FunctionalChainInvolvementLink + +### Example + +* myFunctionalChainInvolvementLink.getExchangeContext() + * the Sequence of exchange context for the given FunctionalChainInvolvementLink + +## org.polarsys.capella.core.data.capellacore.Type.getExchangeItemElements() : Sequence{org.polarsys.capella.core.data.information.ExchangeItemElement} + +Returns the Sequence of exchange item elements for the given Type. + +### Parameter + +* **value**: the Type + +### Example + +* myAllocation.getExchangeItemElements() + * the Sequence of exchange item elements for the given Type + +## org.polarsys.capella.core.data.information.ExchangeItem.getExchangeItemElements() : Sequence{org.polarsys.capella.core.data.information.ExchangeItemElement} + +Returns the Sequence of echange item elements for the given ExchangeItem. + +### Parameter + +* **value**: the ExchangeItem + +### Example + +* myExchangeItem.getExchangeItemElements() + * the Sequence of echange item elements for the given ExchangeItem + +## org.polarsys.capella.core.data.cs.ExchangeItemAllocation.getExchangeItem() : Sequence{org.polarsys.capella.common.data.modellingcore.AbstractExchangeItem} + +Returns the Sequence of exchange items for the given ExchangeItemAllocation. + +### Parameter + +* **value**: the ExchangeItemAllocation + +### Example + +* myExchangeItemAllocation.getExchangeItem() + * the Sequence of exchange items for the given ExchangeItemAllocation + +## org.polarsys.capella.core.data.cs.Interface.getExchangeItems() : Sequence{org.polarsys.capella.core.data.information.ExchangeItem} + +Returns the Sequence of exchange items for the given Interface. + +### Parameter + +* **value**: the Interface + +### Example + +* myInterface.getExchangeItems() + * the Sequence of exchange items for the given Interface + +## org.polarsys.capella.core.data.fa.ComponentExchange.getExchangeItems() : Sequence{org.polarsys.capella.core.data.information.ExchangeItem} + +Returns the Sequence of exchange items for the given ComponentExchange. + +### Parameter + +* **value**: the ComponentExchange + +### Example + +* myComponentExchange.getExchangeItems() + * the Sequence of exchange items for the given ComponentExchange + +## org.polarsys.capella.core.data.fa.FunctionPort.getExchangeItems() : Sequence{org.polarsys.capella.core.data.information.ExchangeItem} + +Returns the Sequence of exchange items for the given FunctionPort. + +### Parameter + +* **value**: the FunctionPort + +### Example + +* myFunctionPort.getExchangeItems() + * the Sequence of exchange items for the given FunctionPort + +## org.polarsys.capella.core.data.fa.FunctionalExchange.getExchangeItems() : Sequence{org.polarsys.capella.core.data.information.ExchangeItem} + +Returns the Sequence of exchange items for the given FunctionalExchange. + +### Parameter + +* **value**: the FunctionalExchange + +### Example + +* myFunctionalExchange.getExchangeItems() + * the Sequence of exchange items for the given FunctionalExchange + +## org.polarsys.capella.core.data.interaction.SequenceMessage.getExchangeItems() : Sequence{org.polarsys.capella.core.data.information.ExchangeItem} + +Returns the Sequence of exchange items for the given SequenceMessage. + +### Parameter + +* **value**: the SequenceMessage + +### Example + +* mySequenceMessage.getExchangeItems() + * the Sequence of exchange items for the given SequenceMessage + +## org.polarsys.capella.core.data.ctx.Mission.getExploitedCapabilities() : Sequence{org.polarsys.capella.core.data.ctx.Capability} + +Returns the Sequence of exploited capabilities for the given Mission. + +### Parameter + +* **value**: the Mission + +### Example + +* myMission.getExploitedCapabilities() + * the Sequence of exploited capabilities for the given Mission + +## org.polarsys.capella.core.data.ctx.Capability.getExploitingMissions() : Sequence{org.polarsys.capella.core.data.ctx.Mission} + +Returns the Sequence of exploiting missions for the given Capability. + +### Parameter + +* **value**: the Capability + +### Example + +* myCapability.getExploitingMissions() + * the Sequence of exploiting missions for the given Capability + +## org.polarsys.capella.common.data.modellingcore.ModelElement.getExpression() : Sequence{org.polarsys.capella.common.data.modellingcore.ValueSpecification} + +Returns the Sequence of expressions for the given ModelElement. + +### Parameter + +* **value**: the ModelElement + +### Example + +* myModelElement.getExpression() + * the Sequence of expression for the given ModelElement + +## org.polarsys.capella.core.data.interaction.AbstractCapability.getExtendedCapabilities() : Sequence{org.polarsys.capella.core.data.interaction.AbstractCapability} + +Returns the Sequence of extended capabilities for the given AbstractCapability. + +### Parameter + +* **value**: the AbstractCapability + +### Example + +* myAbstractCapability.getExtendedCapabilities() + * the Sequence of extended capabilities for the given AbstractCapability + +## org.polarsys.capella.core.data.interaction.AbstractCapability.getExtendingCapabilities() : Sequence{org.polarsys.capella.core.data.interaction.AbstractCapability} + +Returns the Sequence of extending capabilities for the given AbstractCapability. + +### Parameter + +* **value**: the AbstractCapability + +### Example + +* myAbstractCapability.getExtendingCapabilities() + * the Sequence of extending capabilities for the given AbstractCapability + +## org.polarsys.capella.core.data.interaction.SequenceMessage.getFunctionSource() : Sequence{org.polarsys.capella.core.data.fa.AbstractFunction} + +Returns the Sequence of function source for the given SequenceMessage. + +### Parameter + +* **value**: the SequenceMessage + +### Example + +* mySequenceMessage.getFunctionSource() + * the Sequence of function source for the given SequenceMessage + +## org.polarsys.capella.core.data.interaction.SequenceMessage.getFunctionTarget() : Sequence{org.polarsys.capella.core.data.fa.AbstractFunction} + +Returns the Sequence of function target for the given SequenceMessage. + +### Parameter + +* **value**: the SequenceMessage + +### Example + +* mySequenceMessage.getFunctionTarget() + * the Sequence of function target for the given SequenceMessage + +## org.polarsys.capella.core.data.fa.AbstractFunction.getFunctionalChains() : Sequence{org.polarsys.capella.core.data.fa.FunctionalChain} + +Returns the Sequence of functional chains for the given AbstractFunction. + +### Parameter + +* **value**: the AbstractFunction + +### Example + +* myAbstractFunction.getFunctionalChains() + * the Sequence of functional chains for the given AbstractFunction + +## org.polarsys.capella.core.data.fa.FunctionalExchange.getFunctionalChains() : Sequence{org.polarsys.capella.core.data.fa.FunctionalChain} + +Returns the Sequence of functional chains for the given FunctionalExchange. + +### Parameter + +* **value**: the FunctionalExchange + +### Example + +* myFunctionalExchange.getFunctionalChains() + * the Sequence of functional chains for the given FunctionalExchange + +## org.polarsys.capella.core.data.fa.ExchangeCategory.getFunctionalExchanges() : Sequence{org.polarsys.capella.core.data.fa.FunctionalExchange} + +Returns the Sequence of functional echanges for the given ExchangeCategory. + +### Parameter + +* **value**: the ExchangeCategory + +### Example + +* myExchangeCategory.getFunctionalExchanges() + * the Sequence of functional echanges for the given ExchangeCategory + +## org.polarsys.capella.core.data.cs.Component.getGeneralizedComponents() : Sequence{org.polarsys.capella.core.data.capellacore.GeneralizableElement} + +Returns the Sequence of generalized components for the given Component. + +### Parameter + +* **value**: the Component + +### Example + +* myComponent.getGeneralizedComponents() + * the Sequence of generalized components for the given Component + +## org.polarsys.capella.core.data.capellacore.GeneralizableElement.getGeneralizedElements() : Sequence{org.polarsys.capella.core.data.capellacore.GeneralizableElement} + +Returns the Sequence of generalized elements for the given GeneralizableElement. + +### Parameter + +* **value**: the GeneralizableElement + +### Example + +* myAllocation.getGeneralizedElements() + * the Sequence of generalized elements for the given GeneralizableElement + +## org.polarsys.capella.core.data.interaction.AbstractCapability.getGeneralizedElements() : Sequence{org.polarsys.capella.core.data.interaction.AbstractCapability} + +Returns the Sequence of generalized elements for the given AbstractCapability. + +### Parameter + +* **value**: the AbstractCapability + +### Example + +* myAbstractCapability.getGeneralizedElements() + * the Sequence of generalized elements for the given AbstractCapability + +## org.polarsys.capella.core.data.cs.Component.getGeneralizingComponents() : Sequence{org.polarsys.capella.core.data.capellacore.GeneralizableElement} + +Returns the Sequence of generalizing components for the given Component. + +### Parameter + +* **value**: the Component + +### Example + +* myComponent.getGeneralizingComponents() + * the Sequence of generalizing components for the given Component + +## org.polarsys.capella.core.data.capellacore.GeneralizableElement.getGeneralizingElements() : Sequence{org.polarsys.capella.core.data.capellacore.GeneralizableElement} + +Returns the Sequence of generalizing elements for the given GeneralizableElement. + +### Parameter + +* **value**: the GeneralizableElement + +### Example + +* myAllocation.getGeneralizingElements() + * the Sequence of generalizing elements for the given GeneralizableElement + +## org.polarsys.capella.core.data.interaction.AbstractCapability.getGeneralizingElements() : Sequence{org.polarsys.capella.core.data.interaction.AbstractCapability} + +Returns the Sequence of generalizing elements for the given AbstractCapability. + +### Parameter + +* **value**: the AbstractCapability + +### Example + +* myAbstractCapability.getGeneralizingElements() + * the Sequence of generalizing elements for the given AbstractCapability + +## org.polarsys.capella.common.data.modellingcore.ModelElement.getGuard() : Sequence{org.polarsys.capella.common.data.modellingcore.AbstractConstraint} + +Returns the Sequence of guards for the given ModelElement. + +### Parameter + +* **value**: the ModelElement + +### Example + +* myModelElement.getGuard() + * the Sequence of guard for the given ModelElement + +## org.polarsys.capella.core.data.cs.Component.getImplementedInterfaces() : Sequence{org.polarsys.capella.core.data.cs.Interface} + +Returns the Sequence of implemented interfaces for the given Component. + +### Parameter + +* **value**: the Component + +### Example + +* myComponent.getImplementedInterfaces() + * the Sequence of implemented interfaces for the given Component + +## org.polarsys.capella.core.data.cs.Interface.getImplementors() : Sequence{org.polarsys.capella.core.data.cs.Component} + +Returns the Sequence of implementors for the given Interface. + +### Parameter + +* **value**: the Interface + +### Example + +* myInterface.getImplementors() + * the Sequence of implementors for the given Interface + +## org.polarsys.capella.core.data.ctx.SystemFunction.getInFlowPorts() : Sequence{org.polarsys.capella.core.data.fa.FunctionInputPort} + +Returns the Sequence of in flow ports for the given SystemFunction. + +### Parameter + +* **value**: the SystemFunction + +### Example + +* mySystemFunction.getInFlowPorts() + * the Sequence of in flow ports for the given SystemFunction + +## org.polarsys.capella.core.data.la.LogicalFunction.getInFlowPorts() : Sequence{org.polarsys.capella.core.data.fa.FunctionInputPort} + +Returns the Sequence of in flow ports for the given LogicalFunction. + +### Parameter + +* **value**: the LogicalFunction + +### Example + +* myLogicalFunction.getInFlowPorts() + * the Sequence of in flow ports for the given LogicalFunction + +## org.polarsys.capella.core.data.pa.PhysicalFunction.getInFlowPorts() : Sequence{org.polarsys.capella.core.data.fa.FunctionInputPort} + +Returns the Sequence of in flow ports for the given PhysicalFunction. + +### Parameter + +* **value**: the PhysicalFunction + +### Example + +* myPhysicalFunction.getInFlowPorts() + * the Sequence of in flow ports for the given PhysicalFunction + +## org.polarsys.capella.core.data.interaction.AbstractCapability.getIncludedCapabilities() : Sequence{org.polarsys.capella.core.data.interaction.AbstractCapability} + +Returns the Sequence of included capabilities for the given AbstractCapability. + +### Parameter + +* **value**: the AbstractCapability + +### Example + +* myAbstractCapability.getIncludedCapabilities() + * the Sequence of included capabilities for the given AbstractCapability + +## org.polarsys.capella.core.data.interaction.AbstractCapability.getIncludingCapabilities() : Sequence{org.polarsys.capella.core.data.interaction.AbstractCapability} + +Returns the Sequence of including capabilities for the given AbstractCapability. + +### Parameter + +* **value**: the AbstractCapability + +### Example + +* myAbstractCapability.getIncludingCapabilities() + * the Sequence of including capabilities for the given AbstractCapability + +## org.polarsys.capella.core.data.oa.Entity.getIncomingCommunicationMean() : Sequence{org.polarsys.capella.core.data.oa.CommunicationMean} + +Returns the Sequence of incoming communication means for the given Entity. + +### Parameter + +* **value**: the Entity + +### Example + +* myEntity.getIncomingCommunicationMean() + * the Sequence of incoming communication means for the given Entity + +## org.polarsys.capella.core.data.cs.Component.getIncomingComponentExchanges() : Sequence{org.polarsys.capella.core.data.fa.ComponentExchange} + +Returns the Sequence of incoming component exchanges for the given Component. + +### Parameter + +* **value**: the Component + +### Example + +* myComponent.getIncomingComponentExchanges() + * the Sequence of incoming component exchanges for the given Component + +## org.polarsys.capella.core.data.fa.ComponentPort.getIncomingComponentExchanges() : Sequence{org.polarsys.capella.core.data.fa.ComponentExchange} + +Returns the Sequence of incoming component exchanges for the given ComponentPort. + +### Parameter + +* **value**: the ComponentPort + +### Example + +* myComponentPort.getIncomingComponentExchanges() + * the Sequence of incoming component exchanges for the given ComponentPort + +## org.polarsys.capella.core.data.cs.Component.getIncomingDelegations() : Sequence{org.polarsys.capella.core.data.fa.ComponentExchange} + +Returns the Sequence of incoming delegations for the given Component. + +### Parameter + +* **value**: the Component + +### Example + +* myComponent.getIncomingDelegations() + * the Sequence of incoming delegations for the given Component + +## org.polarsys.capella.core.data.fa.ComponentPort.getIncomingDelegations() : Sequence{org.polarsys.capella.core.data.fa.ComponentExchange} + +Returns the Sequence of incoming delegations for the given ComponentPort. + +### Parameter + +* **value**: the ComponentPort + +### Example + +* myComponentPort.getIncomingDelegations() + * the Sequence of incoming delegations for the given ComponentPort + +## org.polarsys.capella.common.data.activity.Pin.getIncomingFunctionalExchanges() : Sequence{Object} + +Returns the Sequence of incoming functional exchanges for the given Pin. + +### Parameter + +* **value**: the Pin + +### Example + +* myPin.getIncomingFunctionalExchanges() + * the Sequence of incoming functional exchanges for the given Pin + +## org.polarsys.capella.core.data.ctx.SystemFunction.getIncomingFunctionalExchanges() : Sequence{org.polarsys.capella.core.data.fa.FunctionalExchange} + +Returns the Sequence of incoming functional exchanges for the given SystemFunction. + +### Parameter + +* **value**: the SystemFunction + +### Example + +* mySystemFunction.getIncomingFunctionalExchanges() + * the Sequence of incoming functional exchanges for the given SystemFunction + +## org.polarsys.capella.core.data.la.LogicalFunction.getIncomingFunctionalExchanges() : Sequence{org.polarsys.capella.core.data.fa.FunctionalExchange} + +Returns the Sequence of incoming functional exchanges for the given LogicalFunction. + +### Parameter + +* **value**: the LogicalFunction + +### Example + +* myLogicalFunction.getIncomingFunctionalExchanges() + * the Sequence of incoming functional exchanges for the given LogicalFunction + +## org.polarsys.capella.core.data.pa.PhysicalFunction.getIncomingFunctionalExchanges() : Sequence{org.polarsys.capella.core.data.fa.FunctionalExchange} + +Returns the Sequence of incoming functional exchanges for the given PhysicalFunction. + +### Parameter + +* **value**: the PhysicalFunction + +### Example + +* myPhysicalFunction.getIncomingFunctionalExchanges() + * the Sequence of incoming functional exchanges for the given PhysicalFunction + +## org.polarsys.capella.common.data.modellingcore.TraceableElement.getIncomingGenericTraces() : Sequence{org.polarsys.capella.common.data.modellingcore.TraceableElement} + +Returns the Sequence of incoming generic traces for the given TraceableElement. + +### Parameter + +* **value**: the TraceableElement + +### Example + +* myTraceableElement.getIncomingGenericTraces() + * the Sequence of incoming generic traces for the given TraceableElement + +## org.polarsys.capella.core.data.oa.OperationalActivity.getIncomingInteractions() : Sequence{org.polarsys.capella.core.data.fa.FunctionalExchange} + +Returns the Sequence of incoming interactions for the given OperationalActivity. + +### Parameter + +* **value**: the OperationalActivity + +### Example + +* myOperationalActivity.getIncomingInteractions() + * the Sequence of incoming interactions for the given OperationalActivity + +## org.polarsys.capella.core.data.fa.FunctionalChainInvolvementFunction.getIncomingInvolvementLinks() : Sequence{org.polarsys.capella.core.data.fa.FunctionalChainInvolvement} + +Returns the Sequence of incoming involvement links for the given FunctionalChainInvolvementFunction. + +### Parameter + +* **value**: the FunctionalChainInvolvementFunction + +### Example + +* myFunctionalChainInvolvementFunction.getIncomingInvolvementLinks() + * the Sequence of incoming involvement links for the given FunctionalChainInvolvementFunction + +## org.polarsys.capella.common.data.modellingcore.IState.getIncomingTransition() : Sequence{org.polarsys.capella.core.data.capellacommon.StateTransition} + +Returns the Sequence of incoming transitions for the given IState. + +### Parameter + +* **value**: the IState + +### Example + +* myIState.getIncomingTransition() + * the Sequence of incoming transitions for the given IState + +## org.polarsys.capella.core.data.cs.PhysicalLink.getInheritedCategories() : Sequence{org.polarsys.capella.core.data.cs.PhysicalLinkCategory} + +Returns the Sequence of inherited categories for the given PhysicalLink. + +### Parameter + +* **value**: the PhysicalLink + +### Example + +* myPhysicalLink.getScenarios() + * the Sequence of inherited categories for the given PhysicalLink + +## org.polarsys.capella.core.data.fa.ComponentExchange.getInheritedCategories() : Sequence{org.polarsys.capella.core.data.fa.ComponentExchangeCategory} + +Returns the Sequence of inherited categories for the given ComponentExchange. + +### Parameter + +* **value**: the ComponentExchange + +### Example + +* myComponentExchange.getInheritedCategories() + * the Sequence of inherited categories for the given ComponentExchange + +## org.polarsys.capella.core.data.cs.Interface.getInheritedExchangeItems() : Sequence{org.polarsys.capella.core.data.information.ExchangeItem} + +Returns the Sequence of inherited exchange items for the given Interface. + +### Parameter + +* **value**: the Interface + +### Example + +* myInterface.getInheritedExchangeItems() + * the Sequence of inherited exchange items for the given Interface + +## org.polarsys.capella.common.data.modellingcore.AbstractType.getInheritedOfTypingElements() : Sequence{org.polarsys.capella.common.data.modellingcore.AbstractTypedElement} + +Returns the Sequence of inherited of typing elements for the given AbstractType. + +### Parameter + +* **value**: the AbstractType + +### Example + +* myAbstractType.getInheritedOfTypingElements() + * the Sequence of inherited of typing elements for the given AbstractType + +## org.polarsys.capella.core.data.information.ExchangeItem.getInterfaces() : Sequence{EObject} + +Returns the Sequence of interfaces for the given ExchangeItem. + +### Parameter + +* **value**: the ExchangeItem + +### Example + +* myExchangeItem.getInterfaces() + * the Sequence of interfaces for the given ExchangeItem + +## org.polarsys.capella.core.data.cs.Component.getInternalIncomingComponentExchangesComputed() : Sequence{org.polarsys.capella.core.data.fa.ComponentExchange} + +Returns the Sequence of computed incoming component echanges for the given Component. + +### Parameter + +* **value**: the Component + +### Example + +* myComponent.getInternalIncomingComponentExchangesComputed() + * the Sequence of computed incoming component echanges for the given Component + +## org.polarsys.capella.core.data.ctx.SystemFunction.getInternalIncomingFunctionalExchanges() : Sequence{org.polarsys.capella.core.data.fa.FunctionalExchange} + +Returns the Sequence of internal incoming functional exchanges for the given SystemFunction. + +### Parameter + +* **value**: the SystemFunction + +### Example + +* mySystemFunction.getInternalIncomingFunctionalExchanges() + * the Sequence of internal incoming functional exchanges for the given SystemFunction + +## org.polarsys.capella.core.data.la.LogicalFunction.getInternalIncomingFunctionalExchanges() : Sequence{org.polarsys.capella.core.data.fa.FunctionalExchange} + +Returns the Sequence of incoming functional exchanges for the given LogicalFunction. + +### Parameter + +* **value**: the LogicalFunction + +### Example + +* myLogicalFunction.getInternalIncomingFunctionalExchanges() + * the Sequence of incoming functional exchanges for the given LogicalFunction + +## org.polarsys.capella.core.data.pa.PhysicalFunction.getInternalIncomingFunctionalExchanges() : Sequence{org.polarsys.capella.core.data.fa.FunctionalExchange} + +Returns the Sequence of internal incoming functional exchanges for the given PhysicalFunction. + +### Parameter + +* **value**: the PhysicalFunction + +### Example + +* myPhysicalFunction.getInternalIncomingFunctionalExchanges() + * the Sequence of internal incoming functional exchanges for the given PhysicalFunction + +## org.polarsys.capella.core.data.oa.OperationalActivity.getInternalIncomingInteractions() : Sequence{org.polarsys.capella.core.data.fa.FunctionalExchange} + +Returns the Sequence of internal incoming interaction for the given OperationalActivity. + +### Parameter + +* **value**: the OperationalActivity + +### Example + +* myOperationalActivity.getInternalIncomingInteractions() + * the Sequence of internal incoming interaction for the given OperationalActivity + +## org.polarsys.capella.core.data.cs.Component.getInternalOutgoingComponentExchangesComputed() : Sequence{org.polarsys.capella.core.data.fa.ComponentExchange} + +Returns the Sequence of outgoing component exchanges for the given Component. + +### Parameter + +* **value**: the Component + +### Example + +* myComponent.getInternalOutgoingComponentExchangesComputed() + * the Sequence of outgoing component exchanges for the given Component + +## org.polarsys.capella.core.data.ctx.SystemFunction.getInternalOutgoingFunctionalExchanges() : Sequence{org.polarsys.capella.core.data.fa.FunctionalExchange} + +Returns the Sequence of internal outgoing functional exchanges for the given SystemFunction. + +### Parameter + +* **value**: the SystemFunction + +### Example + +* mySystemFunction.getInternalOutgoingFunctionalExchanges() + * the Sequence of internal outgoing functional exchanges for the given SystemFunction + +## org.polarsys.capella.core.data.la.LogicalFunction.getInternalOutgoingFunctionalExchanges() : Sequence{org.polarsys.capella.core.data.fa.FunctionalExchange} + +Returns the Sequence of outgoing functional exchanges for the given LogicalFunction. + +### Parameter + +* **value**: the LogicalFunction + +### Example + +* myLogicalFunction.getInternalOutgoingFunctionalExchanges() + * the Sequence of outgoing functional exchanges for the given LogicalFunction + +## org.polarsys.capella.core.data.pa.PhysicalFunction.getInternalOutgoingFunctionalExchanges() : Sequence{org.polarsys.capella.core.data.fa.FunctionalExchange} + +Returns the Sequence of internal outgoing functional exchanges for the given PhysicalFunction. + +### Parameter + +* **value**: the PhysicalFunction + +### Example + +* myPhysicalFunction.getInternalOutgoingFunctionalExchanges() + * the Sequence of internal outgoing functional exchanges for the given PhysicalFunction + +## org.polarsys.capella.core.data.oa.OperationalActivity.getInternalOutgoingInteractions() : Sequence{org.polarsys.capella.core.data.fa.FunctionalExchange} + +Returns the Sequence of internal outgoing interactions for the given OperationalActivity. + +### Parameter + +* **value**: the OperationalActivity + +### Example + +* myOperationalActivity.getInternalOutgoingInteractions() + * the Sequence of internal outgoing interactions for the given OperationalActivity + +## org.polarsys.capella.core.data.pa.PhysicalComponent.getInternalPhysicalLinksComputed() : Sequence{org.polarsys.capella.core.data.cs.PhysicalLink} + +Returns the Sequence of computed internal physical links for the given PhysicalComponent. + +### Parameter + +* **value**: the PhysicalComponent + +### Example + +* myPhysicalComponent.getInternalPhysicalLinksComputed() + * the Sequence of computed internal physical links for the given PhysicalComponent + +## org.polarsys.capella.core.data.capellacore.AbstractDependenciesPkg.getInverseDependencies() : Sequence{org.polarsys.capella.core.data.capellacore.AbstractDependenciesPkg} + +Returns the Sequence of inverse dependencies for the given AbstractDependenciesPkg. + +### Parameter + +* **value**: the AbstractDependenciesPkg + +### Example + +* myAbstractDependenciesPkg.getInverseDependencies() + * the Sequence of inverse dependencies for the given AbstractDependenciesPkg + +## org.polarsys.capella.core.data.interaction.SequenceMessage.getInvokedCommunicationMean() : Sequence{org.polarsys.capella.core.data.information.AbstractEventOperation} + +Returns the Sequence of invoked communication mean for the given SequenceMessage. + +### Parameter + +* **value**: the SequenceMessage + +### Example + +* mySequenceMessage.getInvokedCommunicationMean() + * the Sequence of invoked communication mean for the given SequenceMessage + +## org.polarsys.capella.core.data.interaction.SequenceMessage.getInvokedComponentExchange() : Sequence{org.polarsys.capella.core.data.information.AbstractEventOperation} + +Returns the Sequence of invoked component exchange for the given SequenceMessage. + +### Parameter + +* **value**: the SequenceMessage + +### Example + +* mySequenceMessage.getInvokedComponentExchange() + * the Sequence of invoked component exchange for the given SequenceMessage + +## org.polarsys.capella.core.data.interaction.SequenceMessage.getInvokedExchangeItemAllocation() : Sequence{org.polarsys.capella.core.data.information.AbstractEventOperation} + +Returns the Sequence of invoked exchange item for the given SequenceMessage. + +### Parameter + +* **value**: the SequenceMessage + +### Example + +* mySequenceMessage.getInvokedExchangeItemAllocation() + * the Sequence of invoked exchange item for the given SequenceMessage + +## org.polarsys.capella.core.data.interaction.SequenceMessage.getInvokedFunctionalExchange() : Sequence{org.polarsys.capella.core.data.information.AbstractEventOperation} + +Returns the Sequence of invoked functional exchange for the given SequenceMessage. + +### Parameter + +* **value**: the SequenceMessage + +### Example + +* mySequenceMessage.getInvokedFunctionalExchange() + * the Sequence of invoked functional exchange for the given SequenceMessage + +## org.polarsys.capella.core.data.interaction.SequenceMessage.getInvokedInteraction() : Sequence{org.polarsys.capella.core.data.information.AbstractEventOperation} + +Returns the Sequence of invoked interaction for the given SequenceMessage. + +### Parameter + +* **value**: the SequenceMessage + +### Example + +* mySequenceMessage.getInvokedInteraction() + * the Sequence of invoked interaction for the given SequenceMessage + +## org.polarsys.capella.core.data.interaction.SequenceMessage.getInvokedOperation() : Sequence{org.polarsys.capella.core.data.information.AbstractEventOperation} + +Returns the Sequence of invoked operation for the given SequenceMessage. + +### Parameter + +* **value**: the SequenceMessage + +### Example + +* mySequenceMessage.getInvokedOperation() + * the Sequence of invoked operation for the given SequenceMessage + +## org.polarsys.capella.core.data.fa.FunctionalChain.getInvolvedComponents() : Sequence{org.polarsys.capella.core.data.cs.Component} + +Returns the Sequence of involved components for the given FunctionalChain. + +### Parameter + +* **value**: the FunctionalChain + +### Example + +* myFunctionalChain.getInvolvedComponents() + * the Sequence of involved components for the given FunctionalChain + +## org.polarsys.capella.core.data.interaction.AbstractCapability.getInvolvedComponents() : Sequence{org.polarsys.capella.core.data.capellacommon.CapabilityRealizationInvolvedElement} + +Returns the Sequence of involved components for the given AbstractCapability. + +### Parameter + +* **value**: the AbstractCapability + +### Example + +* myAbstractCapability.getInvolvedComponents() + * the Sequence of involved components for the given AbstractCapability + +## org.polarsys.capella.core.data.capellacore.Involvement.getInvolvedElement() : Sequence{org.polarsys.capella.core.data.capellacore.InvolvedElement} + +Returns the Sequence of involved elements for the given Involvement. + +### Parameter + +* **value**: the Involvement + +### Example + +* myInvolvement.getInvolvedElement() + * the Sequence of involved elements for the given Involvement + +## org.polarsys.capella.core.data.ctx.CapabilityExploitation.getInvolvedElement() : Sequence{org.polarsys.capella.core.data.interaction.AbstractCapability} + +Returns the Sequence of involved elements for the given CapabilityExploitation. + +### Parameter + +* **value**: the CapabilityExploitation + +### Example + +* myCapabilityExploitation.getInvolvedElement() + * the Sequence of involved elements for the given CapabilityExploitation + +## org.polarsys.capella.core.data.oa.OperationalCapability.getInvolvedEntities() : Sequence{org.polarsys.capella.core.data.oa.Entity} + +Returns the Sequence of involved entities for the given OperationalCapability. + +### Parameter + +* **value**: the OperationalCapability + +### Example + +* myOperationalCapability.getInvolvedEntities() + * the Sequence of involved entities for the given OperationalCapability + +## org.polarsys.capella.core.data.ctx.Capability.getInvolvedFunctionalChains() : Sequence{org.polarsys.capella.core.data.fa.FunctionalChain} + +Returns the Sequence of involved functional chains for the given Capability. + +### Parameter + +* **value**: the Capability + +### Example + +* myCapability.getInvolvedFunctionalChains() + * the Sequence of involved functional chains for the given Capability + +## org.polarsys.capella.core.data.fa.FunctionalChain.getInvolvedFunctionalChains() : Sequence{org.polarsys.capella.core.data.fa.FunctionalChainReference} + +Returns the Sequence of involved functional chains for the given FunctionalChain. + +### Parameter + +* **value**: the FunctionalChain + +### Example + +* myFunctionalChain.getInvolvedFunctionalChains() + * the Sequence of involved functional chains for the given FunctionalChain + +## org.polarsys.capella.core.data.fa.FunctionalChainReference.getInvolvedFunctionalChains() : Sequence{org.polarsys.capella.core.data.fa.FunctionalChainReference} + +Returns the Sequence of involved functional chains for the given FunctionalChainReference. + +### Parameter + +* **value**: the FunctionalChainReference + +### Example + +* myFunctionalChainReference.getInvolvedFunctionalChains() + * the Sequence of involved functional chains for the given FunctionalChainReference + +## org.polarsys.capella.core.data.la.CapabilityRealization.getInvolvedFunctionalChains() : Sequence{org.polarsys.capella.core.data.fa.FunctionalChain} + +Returns the Sequence of involved functional chains for the given CapabilityRealization. + +### Parameter + +* **value**: the CapabilityRealization + +### Example + +* myCapabilityRealization.getInvolvedFunctionalChains() + * the Sequence of involved functional chains for the given CapabilityRealization + +## org.polarsys.capella.core.data.fa.FunctionalChain.getInvolvedFunctions() : Sequence{org.polarsys.capella.core.data.fa.FunctionalChainInvolvementFunction} + +Returns the Sequence of involved functions for the given FunctionalChain. + +### Parameter + +* **value**: the FunctionalChain + +### Example + +* myFunctionalChain.getInvolvedFunctions() + * the Sequence of involved functions for the given FunctionalChain + +## org.polarsys.capella.core.data.fa.FunctionalChainReference.getInvolvedFunctions() : Sequence{org.polarsys.capella.core.data.fa.FunctionalChainInvolvementFunction} + +Returns the Sequence of involved functions for the given FunctionalChainReference. + +### Parameter + +* **value**: the FunctionalChainReference + +### Example + +* myFunctionalChainReference.getInvolvedFunctions() + * the Sequence of involved functions for the given FunctionalChainReference + +## org.polarsys.capella.core.data.la.CapabilityRealization.getInvolvedLogicalFunctions() : Sequence{org.polarsys.capella.core.data.la.LogicalFunction} + +Returns the Sequence of involved logical functions for the given CapabilityRealization. + +### Parameter + +* **value**: the CapabilityRealization + +### Example + +* myCapabilityRealization.getInvolvedLogicalFunctions() + * the Sequence of involved logical functions for the given CapabilityRealization + +## org.polarsys.capella.core.data.oa.OperationalProcess.getInvolvedOperationalActivities() : Sequence{org.polarsys.capella.core.data.oa.OperationalActivity} + +Returns the Sequence of involved operational activities for the given OperationalProcess. + +### Parameter + +* **value**: the OperationalProcess + +### Example + +* myOperationalProcess.getInvolvedOperationalActivities() + * the Sequence of involved operational activities for the given OperationalProcess + +## org.polarsys.capella.core.data.oa.OperationalCapability.getInvolvedOperationalProcesses() : Sequence{org.polarsys.capella.core.data.oa.OperationalProcess} + +Returns the Sequence of involved operational process for the given OperationalCapability. + +### Parameter + +* **value**: the OperationalCapability + +### Example + +* myOperationalCapability.getInvolvedOperationalProcesses() + * the Sequence of involved operational process for the given OperationalCapability + +## org.polarsys.capella.core.data.oa.OperationalProcess.getInvolvedOperationalProcesses() : Sequence{org.polarsys.capella.core.data.oa.OperationalProcess} + +Returns the Sequence of involved operational processes for the given OperationalProcess. + +### Parameter + +* **value**: the OperationalProcess + +### Example + +* myOperationalProcess.getInvolvedOperationalProcesses() + * the Sequence of involved operational processes for the given OperationalProcess + +## org.polarsys.capella.core.data.cs.PhysicalPathInvolvement.getInvolvedPhysicalComponent() : Sequence{org.polarsys.capella.core.data.cs.AbstractPathInvolvedElement} + +Returns the Sequence of involved physical components for the given PhysicalPathInvolvement. + +### Parameter + +* **value**: the PhysicalPathInvolvement + +### Example + +* myPhysicalPathInvolvement.getInvolvedPhysicalComponent() + * the Sequence of involved physical components for the given PhysicalPathInvolvement + +## org.polarsys.capella.core.data.la.CapabilityRealization.getInvolvedPhysicalFunctions() : Sequence{org.polarsys.capella.core.data.pa.PhysicalFunction} + +Returns the Sequence of involved physical functions for the given CapabilityRealization. + +### Parameter + +* **value**: the CapabilityRealization + +### Example + +* myCapabilityRealization.getInvolvedPhysicalFunctions() + * the Sequence of involved physical functions for the given CapabilityRealization + +## org.polarsys.capella.core.data.cs.PhysicalPathInvolvement.getInvolvedPhysicalLink() : Sequence{org.polarsys.capella.core.data.cs.PhysicalLink} + +Returns the Sequence of involved physical links for the given PhysicalPathInvolvement. + +### Parameter + +* **value**: the PhysicalPathInvolvement + +### Example + +* myPhysicalPathInvolvement.getInvolvedPhysicalLink() + * the Sequence of involved physical links for the given PhysicalPathInvolvement + +## org.polarsys.capella.core.data.cs.PhysicalPath.getInvolvedPhysicalLinks() : Sequence{org.polarsys.capella.core.data.cs.PhysicalLink} + +Returns the Sequence of involved physical links for the given PhysicalPath. + +### Parameter + +* **value**: the PhysicalPath + +### Example + +* myPhysicalPath.getInvolvedPhysicalLinks() + * the Sequence of involved physical links for the given PhysicalPath + +## org.polarsys.capella.core.data.cs.PhysicalPathInvolvement.getInvolvedPhysicalPath() : Sequence{org.polarsys.capella.core.data.cs.PhysicalPath} + +Returns the Sequence of involved physical paths for the given PhysicalPathInvolvement. + +### Parameter + +* **value**: the PhysicalPathInvolvement + +### Example + +* myPhysicalPathInvolvement.getInvolvedPhysicalPath() + * the Sequence of involved physical paths for the given PhysicalPathInvolvement + +## org.polarsys.capella.core.data.cs.PhysicalPath.getInvolvedPhysicalPaths() : Sequence{org.polarsys.capella.core.data.cs.PhysicalPath} + +Returns the Sequence of involved physical paths for the given PhysicalPath. + +### Parameter + +* **value**: the PhysicalPath + +### Example + +* myPhysicalPath.getInvolvedPhysicalPaths() + * the Sequence of involved physical paths for the given PhysicalPath + +## org.polarsys.capella.common.data.modellingcore.IState.getInvolvedStatesAndModes() : Sequence{org.polarsys.capella.common.data.modellingcore.IState} + +Returns the Sequence of involved state and mode for the given IState. + +### Parameter + +* **value**: the IState + +### Example + +* myIState.getInvolvedStatesAndModes() + * the Sequence of involved state and mode for the given IState + +## org.polarsys.capella.core.data.ctx.Mission.getInvolvedSystemComponents() : Sequence{org.polarsys.capella.core.data.ctx.SystemComponent} + +Returns the Sequence of involved system components for the given Mission. + +### Parameter + +* **value**: the Mission + +### Example + +* myMission.getInvolvedSystemComponents() + * the Sequence of involved system components for the given Mission + +## org.polarsys.capella.core.data.ctx.Capability.getInvolvedSystemFunctions() : Sequence{org.polarsys.capella.core.data.ctx.SystemFunction} + +Returns the Sequence of involved system functions for the given Capability. + +### Parameter + +* **value**: the Capability + +### Example + +* myCapability.getInvolvedSystemFunctions() + * the Sequence of involved system functions for the given Capability + +## org.polarsys.capella.core.data.fa.FunctionalChain.getInvolvementLinks() : Sequence{org.polarsys.capella.core.data.fa.FunctionalChainInvolvementLink} + +Returns the Sequence of involvement links for the given FunctionalChain. + +### Parameter + +* **value**: the FunctionalChain + +### Example + +* myFunctionalChain.getInvolvementLinks() + * the Sequence of involvement links for the given FunctionalChain + +## org.polarsys.capella.core.data.fa.FunctionalChainReference.getInvolvementLinks() : Sequence{org.polarsys.capella.core.data.fa.FunctionalChainInvolvementLink} + +Returns the Sequence of involved links for the given FunctionalChainReference. + +### Parameter + +* **value**: the FunctionalChainReference + +### Example + +* myFunctionalChainReference.getInvolvementLinks() + * the Sequence of involved links for the given FunctionalChainReference + +## org.polarsys.capella.core.data.ctx.SystemComponent.getInvolvingCapabilities() : Sequence{org.polarsys.capella.core.data.ctx.Capability} + +Returns the Sequence of involving capabilities for the given SystemComponent. + +### Parameter + +* **value**: the SystemComponent + +### Example + +* mySystemComponent.getInvolvingCapabilities() + * the Sequence of involving capabilities for the given SystemComponent + +## org.polarsys.capella.core.data.ctx.SystemFunction.getInvolvingCapabilities() : Sequence{org.polarsys.capella.core.data.ctx.Capability} + +Returns the Sequence of involving capabilities for the given SystemFunction. + +### Parameter + +* **value**: the SystemFunction + +### Example + +* mySystemFunction.getInvolvingCapabilities() + * the Sequence of involving capabilities for the given SystemFunction + +## org.polarsys.capella.core.data.fa.FunctionalChain.getInvolvingCapabilities() : Sequence{org.polarsys.capella.core.data.interaction.AbstractCapability} + +Returns the Sequence of involving capabilities for the given FunctionalChain. + +### Parameter + +* **value**: the FunctionalChain + +### Example + +* myFunctionalChain.getInvolvingCapabilities() + * the Sequence of involving capabilities for the given FunctionalChain + +## org.polarsys.capella.core.data.capellacommon.CapabilityRealizationInvolvedElement.getInvolvingCapabilityRealizations() : Sequence{org.polarsys.capella.core.data.la.CapabilityRealization} + +Returns the Sequence of involving capability realizations for the given CapabilityRealizationInvolvedElement. + +### Parameter + +* **value**: the CapabilityRealizationInvolvedElement + +### Example + +* myCapabilityRealizationInvolvedElement.getInvolvingCapabilityRealizations() + * the Sequence of involving capability realizations for the given CapabilityRealizationInvolvedElement + +## org.polarsys.capella.core.data.fa.FunctionalChain.getInvolvingCapabilityRealizations() : Sequence{org.polarsys.capella.core.data.interaction.AbstractCapability} + +Returns the Sequence of involving capability realizations for the given FunctionalChain. + +### Parameter + +* **value**: the FunctionalChain + +### Example + +* myFunctionalChain.getInvolvingCapabilityRealizations() + * the Sequence of involving capability realizations for the given FunctionalChain + +## org.polarsys.capella.core.data.la.LogicalFunction.getInvolvingCapabilityRealizations() : Sequence{org.polarsys.capella.core.data.la.CapabilityRealization} + +Returns the Sequence of involving capability realizations for the given LogicalFunction. + +### Parameter + +* **value**: the LogicalFunction + +### Example + +* myLogicalFunction.getInvolvingCapabilityRealizations() + * the Sequence of involving capability realizations for the given LogicalFunction + +## org.polarsys.capella.core.data.pa.PhysicalFunction.getInvolvingCapabilityRealizations() : Sequence{org.polarsys.capella.core.data.la.CapabilityRealization} + +Returns the Sequence of involving capability realizations for the given PhysicalFunction. + +### Parameter + +* **value**: the PhysicalFunction + +### Example + +* myPhysicalFunction.getInvolvingCapabilityRealizations() + * the Sequence of involving capability realizations for the given PhysicalFunction + +## org.polarsys.capella.core.data.capellacore.Involvement.getInvolvingElement() : Sequence{org.polarsys.capella.core.data.capellacore.InvolverElement} + +Returns the Sequence of involving elements for the given Involvement. + +### Parameter + +* **value**: the Involvement + +### Example + +* myInvolvement.getInvolvingElement() + * the Sequence of involving elements for the given Involvement + +## org.polarsys.capella.core.data.ctx.SystemComponent.getInvolvingMissions() : Sequence{org.polarsys.capella.core.data.ctx.Mission} + +Returns the Sequence of involving missions for the given SystemComponent. + +### Parameter + +* **value**: the SystemComponent + +### Example + +* mySystemComponent.getInvolvingMissions() + * the Sequence of involving missions for the given SystemComponent + +## org.polarsys.capella.core.data.oa.Entity.getInvolvingOperationalCapabilities() : Sequence{org.polarsys.capella.core.data.oa.OperationalCapability} + +Returns the Sequence of involving operation capabilities for the given Entity. + +### Parameter + +* **value**: the Entity + +### Example + +* myEntity.getInvolvingOperationalCapabilities() + * the Sequence of involving operation capabilities for the given Entity + +## org.polarsys.capella.core.data.oa.OperationalProcess.getInvolvingOperationalCapabilities() : Sequence{org.polarsys.capella.core.data.oa.OperationalActivity} + +Returns the Sequence of involved operational capabilities for the given OperationalProcess. + +### Parameter + +* **value**: the OperationalProcess + +### Example + +* myOperationalProcess.getInvolvingOperationalCapabilities() + * the Sequence of involved capabilities activities for the given OperationalProcess + +## org.polarsys.capella.core.data.cs.Interface.getInvolvingScenarios() : Sequence{org.polarsys.capella.core.data.interaction.Scenario} + +Returns the Sequence of involving scenarii for the given Interface. + +### Parameter + +* **value**: the Interface + +### Example + +* myInterface.getInvolvingScenarios() + * the Sequence of involving scenarii for the given Interface + +## org.polarsys.capella.common.data.modellingcore.IState.getInvolvingStatesAndModes() : Sequence{org.polarsys.capella.common.data.modellingcore.IState} + +Returns the Sequence of involving states and modes for the given IState. + +### Parameter + +* **value**: the IState + +### Example + +* myIState.getInvolvingStatesAndModes() + * the Sequence of involving states and modes for the given IState + +## org.polarsys.capella.core.data.fa.SequenceLink.getLinks() : Sequence{org.polarsys.capella.core.data.fa.FunctionalChainInvolvementLink} + +Returns the Sequence of links for the given SequenceLink. + +### Parameter + +* **value**: the SequenceLink + +### Example + +* mySequenceLink.getLinks() + * the Sequence of links for the given SequenceLink + +## org.polarsys.capella.core.data.fa.FunctionalExchange.getOperationalProcesses() : Sequence{org.polarsys.capella.core.data.oa.OperationalProcess} + +Returns the Sequence of operational processes for the given FunctionalExchange. + +### Parameter + +* **value**: the FunctionalExchange + +### Example + +* myFunctionalExchange.getOperationalProcesses() + * the Sequence of operational processes for the given FunctionalExchange + +## org.polarsys.capella.core.data.oa.OperationalActivity.getOperationalProcesses() : Sequence{org.polarsys.capella.core.data.oa.OperationalProcess} + +Returns the Sequence of operational processes for the given OperationalActivity. + +### Parameter + +* **value**: the OperationalActivity + +### Example + +* myOperationalActivity.getOperationalProcesses() + * the Sequence of operational processes for the given OperationalActivity + +## org.polarsys.capella.core.data.ctx.SystemFunction.getOutFlowPorts() : Sequence{org.polarsys.capella.core.data.fa.FunctionOutputPort} + +Returns the Sequence of out function ports for the given SystemFunction. + +### Parameter + +* **value**: the SystemFunction + +### Example + +* mySystemFunction.getOutFlowPorts() + * the Sequence of out function ports for the given SystemFunction + +## org.polarsys.capella.core.data.la.LogicalFunction.getOutFlowPorts() : Sequence{org.polarsys.capella.core.data.fa.FunctionOutputPort} + +Returns the Sequence of out flow ports for the given LogicalFunction. + +### Parameter + +* **value**: the LogicalFunction + +### Example + +* myLogicalFunction.getOutFlowPorts() + * the Sequence of out flow ports for the given LogicalFunction + +## org.polarsys.capella.core.data.pa.PhysicalFunction.getOutFlowPorts() : Sequence{org.polarsys.capella.core.data.fa.FunctionOutputPort} + +Returns the Sequence of outgoing functional exchanges for the given PhysicalFunction. + +### Parameter + +* **value**: the PhysicalFunction + +### Example + +* myPhysicalFunction.getOutFlowPorts() + * the Sequence of outgoing functional exchanges for the given PhysicalFunction + +## org.polarsys.capella.core.data.oa.Entity.getOutgoingCommunicationMean() : Sequence{org.polarsys.capella.core.data.oa.CommunicationMean} + +Returns the Sequence of outgoing communication means for the given Entity. + +### Parameter + +* **value**: the Entity + +### Example + +* myEntity.getOutgoingCommunicationMean() + * the Sequence of outgoing communication means for the given Entity + +## org.polarsys.capella.core.data.cs.Component.getOutgoingComponentExchanges() : Sequence{org.polarsys.capella.core.data.fa.ComponentExchange} + +Returns the Sequence of outgoing component echanges for the given Component. + +### Parameter + +* **value**: the Component + +### Example + +* myComponent.getOutgoingComponentExchanges() + * the Sequence of outgoing component echanges for the given Component + +## org.polarsys.capella.core.data.fa.ComponentPort.getOutgoingComponentExchanges() : Sequence{org.polarsys.capella.core.data.fa.ComponentExchange} + +Returns the Sequence of outgoing component exchanges for the given ComponentPort. + +### Parameter + +* **value**: the ComponentPort + +### Example + +* myComponentPort.getOutgoingComponentExchanges() + * the Sequence of outgoing component exchanges for the given ComponentPort + +## org.polarsys.capella.core.data.cs.Component.getOutgoingDelegations() : Sequence{org.polarsys.capella.core.data.fa.ComponentExchange} + +Returns the Sequence of outgoing delegations for the given Component. + +### Parameter + +* **value**: the Component + +### Example + +* myComponent.getOutgoingDelegations() + * the Sequence of outgoing delegations for the given Component + +## org.polarsys.capella.core.data.cs.PhysicalPort.getOutgoingDelegations() : Sequence{org.polarsys.capella.core.data.fa.ComponentExchange} + +Returns the Sequence of outgoing delegations links for the given PhysicalPort. + +### Parameter + +* **value**: the PhysicalPort + +### Example + +* myPhysicalPort.getOutgoingDelegations() + * the Sequence of outgoing delegations for the given PhysicalPort + +## org.polarsys.capella.core.data.fa.ComponentPort.getOutgoingDelegations() : Sequence{org.polarsys.capella.core.data.fa.ComponentExchange} + +Returns the Sequence of outgoing delegations for the given ComponentPort. + +### Parameter + +* **value**: the ComponentPort + +### Example + +* myComponentPort.getOutgoingDelegations() + * the Sequence of outgoing delegations for the given ComponentPort + +## org.polarsys.capella.common.data.activity.Pin.getOutgoingFunctionalExchanges() : Sequence{org.polarsys.capella.core.data.fa.FunctionalExchange} + +Returns the Sequence of outgoing functional exchanges for the given Pin. + +### Parameter + +* **value**: the Pin + +### Example + +* myPin.getOutgoingFunctionalExchanges() + * the Sequence of outgoing functional exchanges for the given Pin + +## org.polarsys.capella.core.data.ctx.SystemFunction.getOutgoingFunctionalExchanges() : Sequence{org.polarsys.capella.core.data.fa.FunctionalExchange} + +Returns the Sequence of outgoing functional exchanges for the given SystemFunction. + +### Parameter + +* **value**: the SystemFunction + +### Example + +* mySystemFunction.getOutgoingFunctionalExchanges() + * the Sequence of outgoing functional exchanges for the given SystemFunction + +## org.polarsys.capella.core.data.la.LogicalFunction.getOutgoingFunctionalExchanges() : Sequence{org.polarsys.capella.core.data.fa.FunctionalExchange} + +Returns the Sequence of outgoing functional exchanges for the given LogicalFunction. + +### Parameter + +* **value**: the LogicalFunction + +### Example + +* myLogicalFunction.getOutgoingFunctionalExchanges() + * the Sequence of outgoing functional exchanges for the given LogicalFunction + +## org.polarsys.capella.core.data.pa.PhysicalFunction.getOutgoingFunctionalExchanges() : Sequence{org.polarsys.capella.core.data.fa.FunctionalExchange} + +Returns the Sequence of outgoing functional exchanges for the given PhysicalFunction. + +### Parameter + +* **value**: the PhysicalFunction + +### Example + +* myPhysicalFunction.getOutgoingFunctionalExchanges() + * the Sequence of outgoing functional exchanges for the given PhysicalFunction + +## org.polarsys.capella.common.data.modellingcore.TraceableElement.getOutgoingGenericTraces() : Sequence{org.polarsys.capella.common.data.modellingcore.TraceableElement} + +Returns the Sequence of outgoing generic traces for the given TraceableElement. + +### Parameter + +* **value**: the TraceableElement + +### Example + +* myTraceableElement.getOutgoingGenericTraces() + * the Sequence of outgoing generic traces for the given TraceableElement + +## org.polarsys.capella.core.data.oa.OperationalActivity.getOutgoingInteractions() : Sequence{org.polarsys.capella.core.data.fa.AbstractFunction} + +Returns the Sequence of outgoing interactions for the given OperationalActivity. + +### Parameter + +* **value**: the OperationalActivity + +### Example + +* myOperationalActivity.getOutgoingInteractions() + * the Sequence of outgoing interactions for the given OperationalActivity + +## org.polarsys.capella.core.data.fa.FunctionalChainInvolvementFunction.getOutgoingInvolvementLinks() : Sequence{org.polarsys.capella.core.data.fa.FunctionalChainInvolvement} + +Returns the Sequence of outgoing involvement links for the given FunctionalChainInvolvementFunction. + +### Parameter + +* **value**: the FunctionalChainInvolvementFunction + +### Example + +* myFunctionalChainInvolvementFunction.getOutgoingInvolvementLinks() + * the Sequence of outgoing involvement links for the given FunctionalChainInvolvementFunction + +## org.polarsys.capella.common.data.modellingcore.IState.getOutgoingTransition() : Sequence{org.polarsys.capella.core.data.capellacommon.StateTransition} + +Returns the Sequence of outgoing transitions for the given IState. + +### Parameter + +* **value**: the IState + +### Example + +* myIState.getOutgoingTransition() + * the Sequence of outgoing transitions for the given IState + +## org.polarsys.capella.core.data.cs.Component.getOwnedComponents() : Sequence{org.polarsys.capella.core.data.cs.Component} + +Returns the Sequence of owned components for the given Component. + +### Parameter + +* **value**: the Component + +### Example + +* myComponent.getOwnedComponents() + * the Sequence of owned components for the given Component + +## org.polarsys.capella.core.data.capellacommon.Region.getOwnedEntryExitPoints() : Sequence{org.polarsys.capella.core.data.capellacommon.Pseudostate} + +Returns the Sequence of owned entry exit points for the given Region. + +### Parameter + +* **value**: the Region + +### Example + +* myRegion.getOwnedEntryExitPoints() + * the Sequence of owned entry exit points for the given Region + +## org.polarsys.capella.core.data.ctx.Capability.getOwnedFunctionalChains() : Sequence{org.polarsys.capella.core.data.fa.FunctionalChain} + +Returns the Sequence of owned functional chains for the given Capability. + +### Parameter + +* **value**: the Capability + +### Example + +* myCapability.getOwnedFunctionalChains() + * the Sequence of owned functional chains for the given Capability + +## org.polarsys.capella.core.data.ctx.SystemFunction.getOwnedFunctionalChains() : Sequence{org.polarsys.capella.core.data.fa.FunctionalChain} + +Returns the Sequence of owned functional chains for the given SystemFunction. + +### Parameter + +* **value**: the SystemFunction + +### Example + +* mySystemFunction.getOwnedFunctionalChains() + * the Sequence of owned functional chains for the given SystemFunction + +## org.polarsys.capella.core.data.la.CapabilityRealization.getOwnedFunctionalChains() : Sequence{org.polarsys.capella.core.data.fa.FunctionalChain} + +Returns the Sequence of owned functional chains for the given CapabilityRealization. + +### Parameter + +* **value**: the CapabilityRealization + +### Example + +* myCapabilityRealization.getOwnedFunctionalChains() + * the Sequence of owned functional chains for the given CapabilityRealization + +## org.polarsys.capella.core.data.la.LogicalFunction.getOwnedFunctionalChains() : Sequence{org.polarsys.capella.core.data.fa.FunctionalChain} + +Returns the Sequence of owned functional chains for the given LogicalFunction. + +### Parameter + +* **value**: the LogicalFunction + +### Example + +* myLogicalFunction.getOwnedFunctionalChains() + * the Sequence of owned functional chains for the given LogicalFunction + +## org.polarsys.capella.core.data.pa.PhysicalFunction.getOwnedFunctionalChains() : Sequence{org.polarsys.capella.core.data.fa.FunctionalChain} + +Returns the Sequence of owned functional chains for the given PhysicalFunction. + +### Parameter + +* **value**: the PhysicalFunction + +### Example + +* myPhysicalFunction.getOwnedFunctionalChains() + * the Sequence of owned functional chains for the given PhysicalFunction + +## org.polarsys.capella.core.data.oa.OperationalActivity.getOwnedOperationalProcesses() : Sequence{org.polarsys.capella.core.data.oa.OperationalProcess} + +Returns the Sequence of owned operational processes for the given OperationalActivity. + +### Parameter + +* **value**: the OperationalActivity + +### Example + +* myOperationalActivity.getOwnedOperationalProcesses() + * the Sequence of owned operational processes for the given OperationalActivity + +## org.polarsys.capella.core.data.oa.OperationalCapability.getOwnedOperationalProcesses() : Sequence{org.polarsys.capella.core.data.oa.OperationalProcess} + +Returns the Sequence of owned operational processes for the given OperationalCapability. + +### Parameter + +* **value**: the OperationalCapability + +### Example + +* myOperationalCapability.getOwnedOperationalProcesses() + * the Sequence of owned operational processes for the given OperationalCapability + +## org.polarsys.capella.common.data.modellingcore.IState.getOwnedStateAndMode() : Sequence{org.polarsys.capella.core.data.capellacommon.AbstractState} + +Returns the Sequence of owned state and mode for the given IState. + +### Parameter + +* **value**: the IState + +### Example + +* myIState.getOwnedStateAndMode() + * the Sequence of owned state and mode for the given IState + +## org.polarsys.capella.common.data.activity.Pin.getOwner() : Sequence{EObject} + +Returns the Sequence of owner for the given Pin. + +### Parameter + +* **value**: the Pin + +### Example + +* myPin.getOwner() + * the Sequence of owner for the given Pin + +## org.polarsys.capella.core.data.fa.ComponentExchange.getOwner() : Sequence{EObject} + +Returns the Sequence of owner for the given ComponentExchange. + +### Parameter + +* **value**: the ComponentExchange + +### Example + +* myComponentExchange.getOwner() + * the Sequence of owner for the given ComponentExchange + +## org.polarsys.capella.core.data.fa.ComponentPort.getOwner() : Sequence{EObject} + +Returns the Sequence of owner for the given ComponentPort. + +### Parameter + +* **value**: the ComponentPort + +### Example + +* myComponentPort.getType() + * the Sequence of owner for the given ComponentPort + +## org.polarsys.capella.core.data.fa.FunctionalChain.getOwner() : Sequence{org.polarsys.capella.core.data.fa.AbstractFunction} + +Returns the Sequence of owners for the given OperationalActivity. + +### Parameter + +* **value**: the OperationalActivity + +### Example + +* myOperationalActivity.getOwner() + * the Sequence of owners for the given OperationalActivity + +## org.polarsys.capella.core.data.fa.FunctionalChainInvolvementFunction.getOwner() : Sequence{EObject} + +Returns the Sequence of owner for the given FunctionalChainInvolvementFunction. + +### Parameter + +* **value**: the FunctionalChainInvolvementFunction + +### Example + +* myFunctionalChainInvolvementFunction.getOwner() + * the Sequence of owner for the given FunctionalChainInvolvementFunction + +## org.polarsys.capella.core.data.fa.FunctionalExchange.getOwner() : Sequence{EObject} + +Returns the Sequence of owners for the given FunctionalExchange. + +### Parameter + +* **value**: the FunctionalExchange + +### Example + +* myFunctionalExchange.getOwner() + * the Sequence of owners for the given FunctionalExchange + +## org.polarsys.capella.core.data.fa.SequenceLink.getOwner() : Sequence{EObject} + +Returns the Sequence of owner for the given SequenceLink. + +### Parameter + +* **value**: the SequenceLink + +### Example + +* mySequenceLink.getOwner() + * the Sequence of owner for the given SequenceLink + +## org.polarsys.capella.core.data.fa.FunctionalChain.getParentFunctionalChains() : Sequence{org.polarsys.capella.core.data.fa.FunctionalChainReference} + +Returns the Sequence of parent functional chains for the given FunctionalChain. + +### Parameter + +* **value**: the FunctionalChain + +### Example + +* myFunctionalChain.getParentFunctionalChains() + * the Sequence of parent functional chains for the given FunctionalChain + +## org.polarsys.capella.core.data.fa.FunctionalChainReference.getParentFunctionalChains() : Sequence{org.polarsys.capella.core.data.fa.FunctionalChainReference} + +Returns the Sequence of parent fuctional chains for the given FunctionalChainReference. + +### Parameter + +* **value**: the FunctionalChainReference + +### Example + +* myFunctionalChainReference.getParentFunctionalChains() + * the Sequence of parent fuctional chains for the given FunctionalChainReference + +## org.polarsys.capella.core.data.oa.OperationalProcess.getParentOperationalProcesses() : Sequence{org.polarsys.capella.core.data.oa.OperationalProcess} + +Returns the Sequence of parent operational processes for the given OperationalProcess. + +### Parameter + +* **value**: the OperationalProcess + +### Example + +* myOperationalProcess.getParentOperationalProcesses() + * the Sequence of parent operational processes for the given OperationalProcess + +## org.polarsys.capella.core.data.capellacommon.Pseudostate.getParentRegion() : Sequence{org.polarsys.capella.core.data.capellacommon.Region} + +Returns the Sequence of parent region for the given Pseudostate. + +### Parameter + +* **value**: the Pseudostate + +### Example + +* myPseudostate.getParentRegion() + * the Sequence of parent region for the given Pseudostate + +## org.polarsys.capella.core.data.interaction.InstanceRole.getParentScenario() : Sequence{org.polarsys.capella.core.data.interaction.Scenario} + +Returns the Sequence of parent scenario for the given InstanceRole. + +### Parameter + +* **value**: the InstanceRole + +### Example + +* myInstanceRole.getParentScenario() + * the Sequence of parent scenario for the given InstanceRole + +## org.polarsys.capella.core.data.interaction.SequenceMessage.getParentScenario() : Sequence{EObject} + +Returns the Sequence of parent scenario for the given SequenceMessage. + +### Parameter + +* **value**: the SequenceMessage + +### Example + +* mySequenceMessage.getParentScenario() + * the Sequence of parent scenario for the given SequenceMessage + +## org.polarsys.capella.common.data.modellingcore.IState.getParentStateAndMode() : Sequence{org.polarsys.capella.core.data.capellacommon.State} + +Returns the Sequence of parent state and mode for the given IState. + +### Parameter + +* **value**: the IState + +### Example + +* myIState.getParentStateAndMode() + * the Sequence of parent state and mode for the given IState + +## org.polarsys.capella.core.data.cs.Component.getParent() : Sequence{org.polarsys.capella.core.data.cs.Component} + +Returns the Sequence of parent for the given Component. + +### Parameter + +* **value**: the Component + +### Example + +* myComponent.getParent() + * the Sequence of parent for the given Component + +## org.polarsys.capella.core.data.fa.AbstractFunction.getParent() : Sequence{org.polarsys.capella.core.data.fa.AbstractFunction} + +Returns the Sequence of parents for the given AbstractFunction. + +### Parameter + +* **value**: the AbstractFunction + +### Example + +* myAbstractFunction.getParent() + * the Sequence of parents for the given AbstractFunction + +## org.polarsys.capella.core.data.information.Property.getParent() : Sequence{EObject} + +Returns the Sequence of parents for the given Property. + +### Parameter + +* **value**: the Property + +### Example + +* myProperty.getParent() + * the Sequence of parents for the given Property + +## org.polarsys.capella.core.data.interaction.Scenario.getParent() : Sequence{EObject} + +Returns the Sequence of parent for the given Scenario. + +### Parameter + +* **value**: the Scenario + +### Example + +* myScenario.getParent() + * the Sequence of parent for the given Scenario + +## org.polarsys.capella.core.data.interaction.SequenceMessage.getPartSource() : Sequence{org.polarsys.capella.core.data.cs.Part} + +Returns the Sequence of part source for the given SequenceMessage. + +### Parameter + +* **value**: the SequenceMessage + +### Example + +* mySequenceMessage.getPartSource() + * the Sequence of part source for the given SequenceMessage + +## org.polarsys.capella.core.data.interaction.SequenceMessage.getPartTarget() : Sequence{org.polarsys.capella.core.data.cs.Part} + +Returns the Sequence of part target for the given SequenceMessage. + +### Parameter + +* **value**: the SequenceMessage + +### Example + +* mySequenceMessage.getPartTarget() + * the Sequence of part target for the given SequenceMessage + +## org.polarsys.capella.core.data.cs.PhysicalLinkCategory.getPhysicalLinks() : Sequence{org.polarsys.capella.core.data.cs.PhysicalLink} + +Returns the Sequence of physical links for the given PhysicalLinkCategory. + +### Parameter + +* **value**: the PhysicalLinkCategory + +### Example + +* myPhysicalLinkCategory.getPhysicalLinks() + * the Sequence of physical links for the given PhysicalLinkCategory + +## org.polarsys.capella.core.data.cs.PhysicalLink.getPhysicalPaths() : Sequence{org.polarsys.capella.core.data.cs.PhysicalPath} + +Returns the Sequence of physical paths for the given PhysicalLink. + +### Parameter + +* **value**: the PhysicalLink + +### Example + +* myPhysicalLink.getPhysicalPaths() + * the Sequence of physical paths for the given PhysicalLink + +## org.polarsys.capella.core.data.cs.PhysicalPath.getPhysicalPaths() : Sequence{org.polarsys.capella.core.data.cs.PhysicalPath} + +Returns the Sequence of physical paths for the given PhysicalPath. + +### Parameter + +* **value**: the PhysicalPath + +### Example + +* myPhysicalPath.getPhysicalPaths() + * the Sequence of physical paths for the given PhysicalPath + +## org.polarsys.capella.common.data.modellingcore.ModelElement.getPostCondition() : Sequence{org.polarsys.capella.common.data.modellingcore.AbstractConstraint} + +Returns the Sequence of post consition for the given ModelElement. + +### Parameter + +* **value**: the ModelElement + +### Example + +* myModelElement.getPostCondition() + * the Sequence of post consition for the given ModelElement + +## org.polarsys.capella.common.data.modellingcore.ModelElement.getPreCondition() : Sequence{org.polarsys.capella.common.data.modellingcore.AbstractConstraint} + +Returns the Sequence of pre conditions for the given ModelElement. + +### Parameter + +* **value**: the ModelElement + +### Example + +* myModelElement.getPreCondition() + * the Sequence of pre conditions for the given ModelElement + +## org.polarsys.capella.core.data.cs.Component.getProvidedInterfaces() : Sequence{org.polarsys.capella.core.data.cs.Interface} + +Returns the Sequence of provided interfaces for the given Component. + +### Parameter + +* **value**: the Component + +### Example + +* myComponent.getProvidedInterfaces() + * the Sequence of provided interfaces for the given Component + +## org.polarsys.capella.core.data.fa.ComponentPort.getProvidedInterfaces() : Sequence{org.polarsys.capella.core.data.cs.Interface} + +Returns the Sequence of provided interfaces for the given ComponentPort. + +### Parameter + +* **value**: the ComponentPort + +### Example + +* myComponentPort.getProvidedInterfaces() + * the Sequence of provided interfaces for the given ComponentPort + +## org.polarsys.capella.core.data.cs.Interface.getProviders() : Sequence{org.polarsys.capella.core.data.fa.ComponentPort} + +Returns the Sequence of providers for the given Interface. + +### Parameter + +* **value**: the Interface + +### Example + +* myInterface.getProviders() + * the Sequence of providers for the given Interface + +## org.polarsys.kitalpha.emde.model.Element.getRECSourceElement() : Sequence{EObject} + +Returns the Sequence of REC source element for the given Element. + +### Parameter + +* **value**: the Element + +### Example + +* myElement.getRECSourceElement() + * the Sequence of REC source element for the given Element + +## org.polarsys.kitalpha.emde.model.Element.getREC() : Sequence{org.polarsys.capella.common.re.CatalogElement} + +Returns the Sequence of REC for the given Element. + +### Parameter + +* **value**: the Element + +### Example + +* myElement.getREC() + * the Sequence of REC for the given Element + +## org.polarsys.capella.common.re.CatalogElement.getRPL() : Sequence{org.polarsys.capella.common.re.CatalogElement} + +Returns the Sequence of RPL for the given CatalogElement. + +### Parameter + +* **value**: the CatalogElement + +### Example + +* myCatalogElement.getRPL() + * the Sequence of RPL for the given CatalogElement + +## org.polarsys.kitalpha.emde.model.Element.getRPL() : Sequence{org.polarsys.capella.common.re.CatalogElement} + +Returns the Sequence of RPL for the given Element. + +### Parameter + +* **value**: the Element + +### Example + +* myElement.getRPL() + * the Sequence of RPL for the given Element + +## org.polarsys.capella.core.data.la.CapabilityRealization.getRealizedCapabilities() : Sequence{org.polarsys.capella.core.data.ctx.Capability} + +Returns the Sequence of realized capabilities for the given CapabilityRealization. + +### Parameter + +* **value**: the CapabilityRealization + +### Example + +* myCapabilityRealization.getRealizedCapabilities() + * the Sequence of realized capabilities for the given CapabilityRealization + +## org.polarsys.capella.core.data.la.CapabilityRealization.getRealizedCapabilityRealizations() : Sequence{org.polarsys.capella.core.data.la.CapabilityRealization} + +Returns the Sequence of realized capabilities realizations for the given CapabilityRealization. + +### Parameter + +* **value**: the CapabilityRealization + +### Example + +* myCapabilityRealization.getRealizedCapabilityRealizations() + * the Sequence of realized capabilities realizations for the given CapabilityRealization + +## org.polarsys.capella.core.data.information.Class.getRealizedClasses() : Sequence{org.polarsys.capella.core.data.information.Class} + +Returns the Sequence of realized classes for the given Class. + +### Parameter + +* **value**: the Class + +### Example + +* myClass.getRealizedClasses() + * the Sequence of realized classes for the given Class + +## org.polarsys.capella.core.data.fa.ComponentExchange.getRealizedCommunicationMean() : Sequence{org.polarsys.capella.core.data.oa.CommunicationMean} + +Returns the Sequence of realized communication means for the given ComponentExchange. + +### Parameter + +* **value**: the ComponentExchange + +### Example + +* myComponentExchange.getRealizedCommunicationMean() + * the Sequence of realized communication means for the given ComponentExchange + +## org.polarsys.capella.core.data.fa.ExchangeSpecification.getRealizedComponentExchanges() : Sequence{org.polarsys.capella.core.data.oa.CommunicationMean} + +Returns the Sequence of realized system components for the given Entity. + +### Parameter + +* **value**: the Entity + +### Example + +* myEntity.getRealizedComponentExchanges() + * the Sequence of realized system components for the given Entity + +## org.polarsys.capella.core.data.fa.ComponentPort.getRealizedComponentPorts() : Sequence{org.polarsys.capella.core.data.fa.ComponentPort} + +Returns the Sequence of realized component ports for the given ComponentPort. + +### Parameter + +* **value**: the ComponentPort + +### Example + +* myComponentPort.getRealizedComponentPorts() + * the Sequence of realized component ports for the given ComponentPort + +## org.polarsys.capella.core.data.information.ExchangeItem.getRealizedExchangeItems() : Sequence{org.polarsys.capella.core.data.information.ExchangeItem} + +Returns the Sequence of realized echange items for the given ExchangeItem. + +### Parameter + +* **value**: the ExchangeItem + +### Example + +* myExchangeItem.getRealizedExchangeItems() + * the Sequence of realized echange items for the given ExchangeItem + +## org.polarsys.capella.core.data.fa.FunctionPort.getRealizedFunctionPorts() : Sequence{org.polarsys.capella.core.data.fa.FunctionPort} + +Returns the Sequence of realized function ports for the given FunctionPort. + +### Parameter + +* **value**: the FunctionPort + +### Example + +* myFunctionPort.getRealizedFunctionPorts() + * the Sequence of realized function ports for the given FunctionPort + +## org.polarsys.capella.core.data.fa.FunctionalChain.getRealizedFunctionalChains() : Sequence{org.polarsys.capella.core.data.oa.OperationalProcess} + +Returns the Sequence of realized functional chains for the given FunctionalChain. + +### Parameter + +* **value**: the FunctionalChain + +### Example + +* myFunctionalChain.getRealizedFunctionalChains() + * the Sequence of realized functional chains for the given FunctionalChain + +## org.polarsys.capella.core.data.fa.FunctionalExchange.getRealizedFunctionalExchange() : Sequence{org.polarsys.capella.core.data.fa.FunctionalExchange} + +Returns the Sequence of realized functional exchanges for the given FunctionalExchange. + +### Parameter + +* **value**: the FunctionalExchange + +### Example + +* myFunctionalExchange.getRealizedFunctionalExchange() + * the Sequence of realized functional exchanges for the given FunctionalExchange + +## org.polarsys.capella.core.data.fa.FunctionalExchange.getRealizedInteractions() : Sequence{org.polarsys.capella.common.data.modellingcore.TraceableElement} + +Returns the Sequence of realized interactions for the given FunctionalExchange. + +### Parameter + +* **value**: the FunctionalExchange + +### Example + +* myFunctionalExchange.getRealizedInteractions() + * the Sequence of realized interactions for the given FunctionalExchange + +## org.polarsys.capella.core.data.pa.PhysicalComponent.getRealizedLogicalComponent() : Sequence{org.polarsys.capella.core.data.la.LogicalComponent} + +Returns the Sequence of realized logical components for the given PhysicalComponent. + +### Parameter + +* **value**: the PhysicalComponent + +### Example + +* myPhysicalComponent.getRealizedLogicalComponent() + * the Sequence of realized logical components for the given PhysicalComponent + +## org.polarsys.capella.core.data.pa.PhysicalFunction.getRealizedLogicalFunctions() : Sequence{org.polarsys.capella.core.data.la.LogicalFunction} + +Returns the Sequence of realized logical functions for the given PhysicalFunction. + +### Parameter + +* **value**: the PhysicalFunction + +### Example + +* myPhysicalFunction.getRealizedLogicalFunctions() + * the Sequence of realized logical functions for the given PhysicalFunction + +## org.polarsys.capella.core.data.capellacommon.AbstractState.getRealizedMode() : Sequence{org.polarsys.capella.common.data.modellingcore.IState} + +Returns the Sequence of realized mode for the given AbstractState. + +### Parameter + +* **value**: the AbstractState + +### Example + +* myAbstractState.getRealizedMode() + * the Sequence of realized mode for the given AbstractState + +## org.polarsys.capella.core.data.ctx.SystemFunction.getRealizedOperationalActivities() : Sequence{org.polarsys.capella.core.data.oa.OperationalActivity} + +Returns the Sequence of realized operational activities for the given SystemFunction. + +### Parameter + +* **value**: the SystemFunction + +### Example + +* mySystemFunction.getRealizedOperationalActivities() + * the Sequence of realized operational activities for the given SystemFunction + +## org.polarsys.capella.core.data.ctx.Capability.getRealizedOperationalCapabilities() : Sequence{org.polarsys.capella.core.data.oa.OperationalCapability} + +Returns the Sequence of realized operational capabilities for the given Capability. + +### Parameter + +* **value**: the Capability + +### Example + +* myCapability.getRealizedOperationalCapabilities() + * the Sequence of realized operational capabilities for the given Capability + +## org.polarsys.capella.core.data.ctx.SystemComponent.getRealizedOperationalEntities() : Sequence{org.polarsys.capella.core.data.cs.Component} + +Returns the Sequence of realized operation entities for the given SystemComponent. + +### Parameter + +* **value**: the SystemComponent + +### Example + +* mySystemComponent.getRealizedOperationalEntities() + * the Sequence of realized operation entities for the given SystemComponent + +## org.polarsys.capella.core.data.fa.FunctionalChain.getRealizedOperationalProcesses() : Sequence{org.polarsys.capella.core.data.oa.OperationalProcess} + +Returns the Sequence of realized operational processes for the given FunctionalChain. + +### Parameter + +* **value**: the FunctionalChain + +### Example + +* myFunctionalChain.getRealizedOperationalProcesses() + * the Sequence of realized operational processes for the given FunctionalChain + +## org.polarsys.capella.core.data.epbs.ConfigurationItem.getRealizedPhysicalComponents() : Sequence{org.polarsys.capella.core.data.pa.PhysicalComponent} + +Returns the Sequence of realized physical components for the given ConfigurationItem. + +### Parameter + +* **value**: the ConfigurationItem + +### Example + +* myConfigurationItem.getRealizedPhysicalComponents() + * the Sequence of realized physical components for the given ConfigurationItem + +## org.polarsys.capella.core.data.epbs.ConfigurationItem.getRealizedPhysicalLinks() : Sequence{org.polarsys.capella.core.data.cs.PhysicalLink} + +Returns the Sequence of realized physical links for the given ConfigurationItem. + +### Parameter + +* **value**: the ConfigurationItem + +### Example + +* myConfigurationItem.getRealizedPhysicalLinks() + * the Sequence of realized physical links for the given ConfigurationItem + +## org.polarsys.capella.core.data.epbs.ConfigurationItem.getRealizedPhysicalPorts() : Sequence{org.polarsys.capella.core.data.cs.PhysicalPort} + +Returns the Sequence of realized physical ports for the given ConfigurationItem. + +### Parameter + +* **value**: the ConfigurationItem + +### Example + +* myConfigurationItem.getRealizedPhysicalLinks() + * the Sequence of realized physical ports for the given ConfigurationItem + +## org.polarsys.capella.common.data.activity.Pin.getRealizedPin() : Sequence{EObject} + +Returns the Sequence of realized pins for the given Pin. + +### Parameter + +* **value**: the Pin + +### Example + +* myPin.getRealizedPin() + * the Sequence of realized pins for the given Pin + +## org.polarsys.capella.core.data.interaction.Scenario.getRealizedScenarios() : Sequence{org.polarsys.capella.core.data.interaction.Scenario} + +Returns the Sequence of realized scenarii for the given Scenario. + +### Parameter + +* **value**: the Scenario + +### Example + +* myScenario.getRealizedScenarios() + * the Sequence of realized scenarii for the given Scenario + +## org.polarsys.capella.core.data.capellacommon.StateTransition.getRealizedStateTransition() : Sequence{org.polarsys.capella.core.data.capellacommon.StateTransition} + +Returns the Sequence of realized state transition for the given StateTransition. + +### Parameter + +* **value**: the StateTransition + +### Example + +* myStateTransition.getRealizedStateTransition() + * the Sequence of realized state transition for the given StateTransition + +## org.polarsys.capella.core.data.capellacommon.AbstractState.getRealizedState() : Sequence{org.polarsys.capella.common.data.modellingcore.IState} + +Returns the Sequence of realized state for the given AbstractState. + +### Parameter + +* **value**: the AbstractState + +### Example + +* myAbstractState.getRealizedState() + * the Sequence of realized state for the given AbstractState + +## org.polarsys.capella.core.data.la.LogicalComponent.getRealizedSystemComponents() : Sequence{org.polarsys.capella.core.data.ctx.SystemComponent} + +Returns the Sequence of realized system components for the given LogicalFunction. + +### Parameter + +* **value**: the LogicalFunction + +### Example + +* myLogicalFunction.getRealizedSystemComponents() + * the Sequence of realized system components for the given LogicalFunction + +## org.polarsys.capella.core.data.la.LogicalFunction.getRealizedSystemFunctions() : Sequence{org.polarsys.capella.core.data.ctx.SystemFunction} + +Returns the Sequence of realized system functions for the given LogicalFunction. + +### Parameter + +* **value**: the LogicalFunction + +### Example + +* myLogicalFunction.getRealizedSystemFunctions() + * the Sequence of realized system functions for the given LogicalFunction + +## org.polarsys.capella.core.data.oa.OperationalCapability.getRealizingCapabilities() : Sequence{org.polarsys.capella.core.data.ctx.Capability} + +Returns the Sequence of realizing capabilities for the given OperationalCapability. + +### Parameter + +* **value**: the OperationalCapability + +### Example + +* myOperationalCapability.getRealizingCapabilities() + * the Sequence of realizing capabilities for the given OperationalCapability + +## org.polarsys.capella.core.data.ctx.Capability.getRealizingCapabilityRealizations() : Sequence{org.polarsys.capella.core.data.la.CapabilityRealization} + +Returns the Sequence of realizing capability realizations for the given Capability. + +### Parameter + +* **value**: the Capability + +### Example + +* myCapability.getRealizingCapabilityRealizations() + * the Sequence of realizing capability realizations for the given Capability + +## org.polarsys.capella.core.data.la.CapabilityRealization.getRealizingCapabilityRealizations() : Sequence{org.polarsys.capella.core.data.la.CapabilityRealization} + +Returns the Sequence of realizing capability realizations for the given CapabilityRealization. + +### Parameter + +* **value**: the CapabilityRealization + +### Example + +* myCapabilityRealization.getRealizingCapabilityRealizations() + * the Sequence of realizing capability realizations for the given CapabilityRealization + +## org.polarsys.capella.core.data.information.Class.getRealizingClasses() : Sequence{org.polarsys.capella.core.data.information.Class} + +Returns the Sequence of realizing classes for the given Class. + +### Parameter + +* **value**: the Class + +### Example + +* myClass.getRealizingClasses() + * the Sequence of realizing classes for the given Class + +## org.polarsys.capella.core.data.fa.ComponentExchange.getRealizingComponentExchanges() : Sequence{org.polarsys.capella.core.data.fa.ComponentExchange} + +Returns the Sequence of realizing component exchanges for the given ComponentExchange. + +### Parameter + +* **value**: the ComponentExchange + +### Example + +* myComponentExchange.getRealizingComponentExchanges() + * the Sequence of realizing component exchanges for the given ComponentExchange + +## org.polarsys.capella.core.data.fa.ComponentPort.getRealizingComponentPorts() : Sequence{org.polarsys.capella.core.data.information.Port} + +Returns the Sequence of realizing component ports for the given ComponentPort. + +### Parameter + +* **value**: the ComponentPort + +### Example + +* myComponentPort.getRealizingComponentPorts() + * the Sequence of realizing component ports for the given ComponentPort + +## org.polarsys.capella.core.data.pa.PhysicalComponent.getRealizingComponents() : Sequence{org.polarsys.capella.core.data.cs.Component} + +Returns the Sequence of realizing components for the given PhysicalComponent. + +### Parameter + +* **value**: the PhysicalComponent + +### Example + +* myPhysicalComponent.getRealizingComponents() + * the Sequence of realizing components for the given PhysicalComponent + +## org.polarsys.capella.core.data.cs.PhysicalLink.getRealizingConfigurationItems() : Sequence{org.polarsys.capella.core.data.epbs.ConfigurationItem} + +Returns the Sequence of realizing configuration items for the given PhysicalLink. + +### Parameter + +* **value**: the PhysicalLink + +### Example + +* myPhysicalLink.getRealizingConfigurationItems() + * the Sequence of realizing configuration items for the given PhysicalLink + +## org.polarsys.capella.core.data.cs.PhysicalPort.getRealizingConfigurationItems() : Sequence{org.polarsys.capella.core.data.epbs.ConfigurationItem} + +Returns the Sequence of realizing configuration items for the given PhysicalPort. + +### Parameter + +* **value**: the PhysicalPort + +### Example + +* myPhysicalPort.getRealizingConfigurationItems() + * the Sequence of realizing configuration items for the given PhysicalPort + +## org.polarsys.capella.core.data.pa.PhysicalComponent.getRealizingConfigurationItems() : Sequence{org.polarsys.capella.core.data.epbs.ConfigurationItem} + +Returns the Sequence of realizing configuration items for the given PhysicalComponent. + +### Parameter + +* **value**: the PhysicalComponent + +### Example + +* myPhysicalComponent.getRealizingConfigurationItems() + * the Sequence of realizing configuration items for the given PhysicalComponent + +## org.polarsys.capella.core.data.information.ExchangeItem.getRealizingExchangeItems() : Sequence{org.polarsys.capella.core.data.information.ExchangeItem} + +Returns the Sequence of realizing exchange items for the given ExchangeItem. + +### Parameter + +* **value**: the ExchangeItem + +### Example + +* myExchangeItem.getRealizingExchangeItems() + * the Sequence of realizing exchange items for the given ExchangeItem + +## org.polarsys.capella.core.data.fa.FunctionPort.getRealizingFunctionPorts() : Sequence{org.polarsys.capella.core.data.fa.FunctionPort} + +Returns the Sequence of realizing function ports for the given FunctionPort. + +### Parameter + +* **value**: the FunctionPort + +### Example + +* myFunctionPort.getRealizingFunctionPorts() + * the Sequence of realizing function ports for the given FunctionPort + +## org.polarsys.capella.core.data.fa.FunctionalChain.getRealizingFunctionalChains() : Sequence{org.polarsys.capella.common.data.modellingcore.TraceableElement} + +Returns the Sequence of realizing functional chains for the given FunctionalChain. + +### Parameter + +* **value**: the FunctionalChain + +### Example + +* myFunctionalChain.getRealizingFunctionalChains() + * the Sequence of realizing functional chains for the given FunctionalChain + +## org.polarsys.capella.core.data.fa.FunctionalExchange.getRealizingFunctionalExchanges() : Sequence{org.polarsys.capella.core.data.fa.FunctionalExchange} + +Returns the Sequence of realizing functional exchanges for the given FunctionalExchange. + +### Parameter + +* **value**: the FunctionalExchange + +### Example + +* myFunctionalExchange.getRealizingFunctionalExchanges() + * the Sequence of realizing functional exchanges for the given FunctionalExchange + +## org.polarsys.capella.core.data.ctx.SystemComponent.getRealizingLogicalComponents() : Sequence{org.polarsys.capella.core.data.la.LogicalComponent} + +Returns the Sequence of realizing logical components for the given SystemComponent. + +### Parameter + +* **value**: the SystemComponent + +### Example + +* mySystemComponent.getRealizingLogicalComponents() + * the Sequence of realizing logical components for the given SystemComponent + +## org.polarsys.capella.core.data.ctx.SystemFunction.getRealizingLogicalFunctions() : Sequence{org.polarsys.capella.core.data.la.LogicalFunction} + +Returns the Sequence of realizing logical functions for the given SystemFunction. + +### Parameter + +* **value**: the SystemFunction + +### Example + +* mySystemFunction.getRealizingLogicalFunctions() + * the Sequence of realizing logical functions for the given SystemFunction + +## org.polarsys.capella.core.data.capellacommon.AbstractState.getRealizingMode() : Sequence{org.polarsys.capella.common.data.modellingcore.IState} + +Returns the Sequence of realizing mode for the given AbstractState. + +### Parameter + +* **value**: the AbstractState + +### Example + +* myAbstractState.getRealizingMode() + * the Sequence of realizing mode for the given AbstractState + +## org.polarsys.capella.core.data.la.LogicalComponent.getRealizingPhysicalComponents() : Sequence{org.polarsys.capella.core.data.pa.PhysicalComponent} + +Returns the Sequence of realizing physical components for the given LogicalFunction. + +### Parameter + +* **value**: the LogicalFunction + +### Example + +* myLogicalFunction.getRealizingPhysicalComponents() + * the Sequence of realizing physical components for the given LogicalFunction + +## org.polarsys.capella.core.data.la.LogicalFunction.getRealizingPhysicalFunctions() : Sequence{org.polarsys.capella.core.data.pa.PhysicalFunction} + +Returns the Sequence of realizing physical functions for the given LogicalFunction. + +### Parameter + +* **value**: the LogicalFunction + +### Example + +* myLogicalFunction.getRealizingPhysicalFunctions() + * the Sequence of realizing physical functions for the given LogicalFunction + +## org.polarsys.capella.common.data.activity.Pin.getRealizingPin() : Sequence{EObject} + +Returns the Sequence of realizing pins for the given Pin. + +### Parameter + +* **value**: the Pin + +### Example + +* myPin.getIncomingFunctionalExchanges() + * the Sequence of realizing pins for the given Pin + +## org.polarsys.capella.core.data.interaction.Scenario.getRealizingScenarios() : Sequence{org.polarsys.capella.core.data.interaction.Scenario} + +Returns the Sequence of realizing scenarii for the given Scenario. + +### Parameter + +* **value**: the Scenario + +### Example + +* myScenario.getRealizingScenarios() + * the Sequence of realizing scenarii for the given Scenario + +## org.polarsys.capella.core.data.capellacommon.StateTransition.getRealizingStateTransition() : Sequence{org.polarsys.capella.core.data.capellacommon.StateTransition} + +Returns the Sequence of realizing state transition for the given StateTransition. + +### Parameter + +* **value**: the StateTransition + +### Example + +* myStateTransition.getRealizingStateTransition() + * the Sequence of realizing state transition for the given StateTransition + +## org.polarsys.capella.core.data.capellacommon.AbstractState.getRealizingState() : Sequence{org.polarsys.capella.common.data.modellingcore.IState} + +Returns the Sequence of realizing state for the given AbstractState. + +### Parameter + +* **value**: the AbstractState + +### Example + +* myAbstractState.getRealizingState() + * the Sequence of realizing state for the given AbstractState + +## org.polarsys.capella.core.data.oa.Entity.getRealizingSystemComponents() : Sequence{org.polarsys.capella.core.data.cs.Component} + +Returns the Sequence of realizing system components for the given Entity. + +### Parameter + +* **value**: the Entity + +### Example + +* myEntity.getRealizingSystemComponents() + * the Sequence of realizing system components for the given Entity + +## org.polarsys.capella.core.data.oa.OperationalActivity.getRealizingSystemFunctions() : Sequence{org.polarsys.capella.core.data.ctx.SystemFunction} + +Returns the Sequence of realizing system functions for the given OperationalActivity. + +### Parameter + +* **value**: the OperationalActivity + +### Example + +* myOperationalActivity.getRealizingSystemFunctions() + * the Sequence of realizing system functions for the given OperationalActivity + +## org.polarsys.capella.common.re.CatalogElementLink.getReferencedElement() : Sequence{EObject} + +Returns the Sequence of referenced element for the given CatalogElementLink. + +### Parameter + +* **value**: the CatalogElementLink + +### Example + +* myCatalogElementLink.getReferencedElement() + * the Sequence of referenced element for the given CatalogElementLink + +## org.polarsys.capella.core.data.information.datavalue.DataValue.getReferencedProperty() : Sequence{org.polarsys.capella.core.data.information.Property} + +Returns the Sequence of referenced properties for the given DataValue. + +### Parameter + +* **value**: the DataValue + +### Example + +* myDataValue.getReferencedProperty() + * the Sequence of referenced properties for the given DataValue + +## org.polarsys.capella.core.data.interaction.InteractionUse.getReferencedScenario() : Sequence{org.polarsys.capella.core.data.interaction.Scenario} + +Returns the Sequence of referenced senario for the given InteractionUse. + +### Parameter + +* **value**: the InteractionUse + +### Example + +* myInteractionUse.getReferencedScenario() + * the Sequence of referenced senario for the given InteractionUse + +## org.polarsys.capella.core.data.interaction.Scenario.getReferencedScenario() : Sequence{org.polarsys.capella.core.data.interaction.Scenario} + +Returns the Sequence of referenced scenario for the given Scenario. + +### Parameter + +* **value**: the Scenario + +### Example + +* myScenario.getReferencedScenario() + * the Sequence of referenced scenario for the given Scenario + +## org.polarsys.capella.core.data.information.datavalue.DataValue.getReferencedValue() : Sequence{org.polarsys.capella.core.data.information.datavalue.DataValue} + +Returns the Sequence of referenced values for the given DataValue. + +### Parameter + +* **value**: the DataValue + +### Example + +* myDataValue.getReferencedValue() + * the Sequence of referenced values for the given DataValue + +## org.polarsys.capella.core.data.cs.Component.getReferencingComponents() : Sequence{org.polarsys.capella.core.data.cs.Component} + +Returns the Sequence of referencing components for the given Component. + +### Parameter + +* **value**: the Component + +### Example + +* myComponent.getReferencingComponents() + * the Sequence of referencing components for the given Component + +## org.polarsys.capella.core.data.interaction.InteractionUse.getReferencingScenario() : Sequence{org.polarsys.capella.core.data.interaction.Scenario} + +Returns the Sequence of referencing senario for the given InteractionUse. + +### Parameter + +* **value**: the InteractionUse + +### Example + +* myInteractionUse.getReferencingScenario() + * the Sequence of referencing senario for the given InteractionUse + +## org.polarsys.capella.core.data.information.datavalue.DataValue.getReferencingValue() : Sequence{Object} + +Returns the Sequence of referencing values for the given DataValue. + +### Parameter + +* **value**: the DataValue + +### Example + +* myDataValue.getReferencingValue() + * the Sequence of referencing values for the given DataValue + +## org.polarsys.capella.core.data.interaction.AbstractCapability.getRefinedCapabilities() : Sequence{org.polarsys.capella.core.data.capellacore.CapellaElement} + +Returns the Sequence of refined capabilities for the given AbstractCapability. + +### Parameter + +* **value**: the AbstractCapability + +### Example + +* myAbstractCapability.getRefinedCapabilities() + * the Sequence of refined capabilities for the given AbstractCapability + +## org.polarsys.capella.core.data.cs.Interface.getRefinedInterfaces() : Sequence{org.polarsys.capella.core.data.cs.Interface} + +Returns the Sequence of refined interfaces for the given Interface. + +### Parameter + +* **value**: the Interface + +### Example + +* myInterface.getRefinedInterfaces() + * the Sequence of refined interfaces for the given Interface + +## org.polarsys.capella.core.data.interaction.Scenario.getRefinedScenarios() : Sequence{org.polarsys.capella.core.data.interaction.Scenario} + +Returns the Sequence of refined scenarii for the given Scenario. + +### Parameter + +* **value**: the Scenario + +### Example + +* myScenario.getRefinedScenarios() + * the Sequence of refined scenarii for the given Scenario + +## org.polarsys.capella.core.data.interaction.SequenceMessage.getRefinedSequenceMessage() : Sequence{org.polarsys.capella.core.data.interaction.SequenceMessage} + +Returns the Sequence of refined sequence message for the given SequenceMessage. + +### Parameter + +* **value**: the SequenceMessage + +### Example + +* mySequenceMessage.getRefinedSequenceMessage() + * the Sequence of refined sequence message for the given SequenceMessage + +## org.polarsys.capella.core.data.cs.Interface.getRefiningInterfaces() : Sequence{org.polarsys.capella.core.data.cs.Interface} + +Returns the Sequence of refining interfaces for the given Interface. + +### Parameter + +* **value**: the Interface + +### Example + +* myInterface.getRefiningInterfaces() + * the Sequence of refining interfaces for the given Interface + +## org.polarsys.capella.core.data.interaction.AbstractCapability.getRefiningScenarios() : Sequence{org.polarsys.capella.core.data.capellacore.CapellaElement} + +Returns the Sequence of refining scenarii for the given AbstractCapability. + +### Parameter + +* **value**: the AbstractCapability + +### Example + +* myAbstractCapability.getRefiningScenarios() + * the Sequence of refining scenarii for the given AbstractCapability + +## org.polarsys.capella.core.data.interaction.Scenario.getRefiningScenarios() : Sequence{org.polarsys.capella.core.data.interaction.Scenario} + +Returns the Sequence of refining scenarii for the given Scenario. + +### Parameter + +* **value**: the Scenario + +### Example + +* myScenario.getRefiningScenarios() + * the Sequence of refining scenarii for the given Scenario + +## org.polarsys.capella.core.data.interaction.SequenceMessage.getRefiningSequenceMessage() : Sequence{org.polarsys.capella.core.data.interaction.SequenceMessage} + +Returns the Sequence of refining sequence message for the given SequenceMessage. + +### Parameter + +* **value**: the SequenceMessage + +### Example + +* mySequenceMessage.getRefiningSequenceMessage() + * the Sequence of refining sequence message for the given SequenceMessage + +## org.polarsys.capella.core.data.fa.ComponentExchange.getRelatedData() : Sequence{org.polarsys.capella.common.data.modellingcore.AbstractType} + +Returns the Sequence of related data for the given ComponentExchange. + +### Parameter + +* **value**: the ComponentExchange + +### Example + +* myComponentExchange.getRelatedData() + * the Sequence of related data for the given ComponentExchange + +## org.polarsys.capella.core.data.fa.FunctionalExchange.getRelatedData() : Sequence{org.polarsys.capella.core.data.capellacore.Type} + +Returns the Sequence of related data for the given FunctionalExchange. + +### Parameter + +* **value**: the FunctionalExchange + +### Example + +* myFunctionalExchange.getIncomingFunctionalExchanges() + * the Sequence of related data for the given FunctionalExchange + +## org.polarsys.capella.common.re.CatalogElement.getRelatedElements() : Sequence{EObject} + +Returns the Sequence of related elements for the given CatalogElement. + +### Parameter + +* **value**: the CatalogElement + +### Example + +* myCatalogElement.getRelatedElements() + * the Sequence of related elements for the given CatalogElement + +## org.polarsys.capella.core.data.interaction.StateFragment.getRelatedFunction() : Sequence{org.polarsys.capella.core.data.fa.AbstractFunction} + +Returns the Sequence of related function for the given StateFragment. + +### Parameter + +* **value**: the StateFragment + +### Example + +* myStateFragment.getRelatedFunction() + * the Sequence of related function for the given StateFragment + +## org.polarsys.capella.common.re.CatalogElement.getRelatedReplicableElements() : Sequence{org.polarsys.capella.common.re.CatalogElement} + +Returns the Sequence of related replicable elements for the given CatalogElement. + +### Parameter + +* **value**: the CatalogElement + +### Example + +* myCatalogElement.getRelatedReplicableElements() + * the Sequence of related replicable elements for the given CatalogElement + +## org.polarsys.capella.core.data.interaction.StateFragment.getRelatedState() : Sequence{org.polarsys.capella.core.data.capellacommon.AbstractState} + +Returns the Sequence of related stat for the given StateFragment. + +### Parameter + +* **value**: the StateFragment + +### Example + +* myStateFragment.getRelatedState() + * the Sequence of related stat for the given StateFragment + +## org.polarsys.capella.core.data.interaction.InstanceRole.getRepresentedInstance() : Sequence{org.polarsys.capella.common.data.modellingcore.AbstractType} + +Returns the Sequence of represented instance for the given InstanceRole. + +### Parameter + +* **value**: the InstanceRole + +### Example + +* myInstanceRole.getRepresentedInstance() + * the Sequence of represented instance for the given InstanceRole + +## org.polarsys.capella.core.data.cs.Component.getRepresentingParts() : Sequence{org.polarsys.capella.core.data.cs.Part} + +Returns the Sequence of representing parts for the given Component. + +### Parameter + +* **value**: the Component + +### Example + +* myComponent.getOutgoingComponentExchanges() + * the Sequence of representing parts for the given Component + +## org.polarsys.capella.core.data.cs.Component.getRequiredInterfaces() : Sequence{org.polarsys.capella.core.data.cs.Interface} + +Returns the Sequence of required interfaces for the given Component. + +### Parameter + +* **value**: the Component + +### Example + +* myComponent.getRequiredInterfaces() + * the Sequence of required interfaces for the given Component + +## org.polarsys.capella.core.data.fa.ComponentPort.getRequiredInterfaces() : Sequence{org.polarsys.capella.core.data.cs.Interface} + +Returns the Sequence of required interfaces for the given ComponentPort. + +### Parameter + +* **value**: the ComponentPort + +### Example + +* myComponentPort.getRequiredInterfaces() + * the Sequence of required interfaces for the given ComponentPort + +## org.polarsys.capella.core.data.cs.Interface.getRequirers() : Sequence{org.polarsys.capella.core.data.fa.ComponentPort} + +Returns the Sequence of requirers for the given Interface. + +### Parameter + +* **value**: the Interface + +### Example + +* myInterface.getRequirers() + * the Sequence of requirers for the given Interface + +## org.polarsys.capella.core.data.information.Association.getRoles() : Sequence{org.polarsys.capella.core.data.information.Property} + +Returns the Sequence of roles for the given Association. + +### Parameter + +* **value**: the Association + +### Example + +* myAssociation.getRoles() + * the Sequence of roles for the given Association + +## org.polarsys.capella.core.data.capellacommon.State.getScenarios() : Sequence{org.polarsys.capella.core.data.interaction.Scenario} + +Returns the Sequence of scenarii for the given State. + +### Parameter + +* **value**: the State + +### Example + +* myState.getScenarios() + * the Sequence of scenarii for the given State + +## org.polarsys.capella.core.data.cs.Component.getScenarios() : Sequence{org.polarsys.capella.core.data.interaction.Scenario} + +Returns the Sequence of scenarii for the given Component. + +### Parameter + +* **value**: the Component + +### Example + +* myComponent.getScenarios() + * the Sequence of scenarii for the given Component + +## org.polarsys.capella.core.data.cs.ExchangeItemAllocation.getScenarios() : Sequence{org.polarsys.capella.core.data.interaction.Scenario} + +Returns the Sequence of scenarii for the given ExchangeItemAllocation. + +### Parameter + +* **value**: the ExchangeItemAllocation + +### Example + +* myExchangeItemAllocation.getScenarios() + * the Sequence of scenarii for the given ExchangeItemAllocation + +## org.polarsys.capella.core.data.fa.AbstractFunction.getScenarios() : Sequence{org.polarsys.capella.core.data.interaction.Scenario} + +Returns the Sequence of scenarios for the given AbstractFunction. + +### Parameter + +* **value**: the AbstractFunction + +### Example + +* myAbstractFunction.getScenarios() + * the Sequence of scenarios for the given AbstractFunction + +## org.polarsys.capella.core.data.fa.ComponentExchange.getScenarios() : Sequence{org.polarsys.capella.core.data.interaction.Scenario} + +Returns the Sequence of scenarii for the given ComponentExchange. + +### Parameter + +* **value**: the ComponentExchange + +### Example + +* myComponentExchange.getScenarios() + * the Sequence of scenarii for the given ComponentExchange + +## org.polarsys.capella.core.data.fa.FunctionalExchange.getScenarios() : Sequence{org.polarsys.capella.core.data.interaction.Scenario} + +Returns the Sequence of categories for the given FunctionalExchange. + +### Parameter + +* **value**: the FunctionalExchange + +### Example + +* myFunctionalExchange.getScenarios() + * the Sequence of categories for the given FunctionalExchange + +## org.polarsys.capella.core.data.information.ExchangeItemInstance.getScenarios() : Sequence{org.polarsys.capella.core.data.interaction.Scenario} + +Returns the Sequence of scenarii for the given ExchangeItemInstance. + +### Parameter + +* **value**: the ExchangeItemInstance + +### Example + +* myExchangeItemInstance.getType() + * the Sequence of scenarii for the given ExchangeItemInstance + +## org.polarsys.capella.core.data.information.Operation.getScenarios() : Sequence{org.polarsys.capella.core.data.interaction.Scenario} + +Returns the Sequence of scenarii for the given Operation. + +### Parameter + +* **value**: the Operation + +### Example + +* myOperation.getScenarios() + * the Sequence of scenarii for the given Operation + +## org.polarsys.capella.core.data.interaction.AbstractCapability.getScenarios() : Sequence{org.polarsys.capella.core.data.interaction.Scenario} + +Returns the Sequence of scenarii for the given AbstractCapability. + +### Parameter + +* **value**: the AbstractCapability + +### Example + +* myAbstractCapability.getScenarios() + * the Sequence of scenarii for the given AbstractCapability + +## org.polarsys.capella.core.data.oa.Role.getScenarios() : Sequence{org.polarsys.capella.core.data.interaction.Scenario} + +Returns the Sequence of scenarii for the given Role. + +### Parameter + +* **value**: the Role + +### Example + +* myAllocation.getScenarios() + * the Sequence of scenarii for the given Role + +## org.polarsys.capella.core.data.fa.SequenceLink.getSourceControlNode() : Sequence{org.polarsys.capella.core.data.fa.ControlNode} + +Returns the Sequence of source control node for the given SequenceLink. + +### Parameter + +* **value**: the SequenceLink + +### Example + +* mySequenceLink.getSourceControlNode() + * the Sequence of source control node for the given SequenceLink + +## org.polarsys.capella.core.data.fa.SequenceLink.getSourceInvolvementFunction() : Sequence{org.polarsys.capella.core.data.fa.FunctionalChainInvolvementFunction} + +Returns the Sequence of source involvement functions for the given SequenceLink. + +### Parameter + +* **value**: the SequenceLink + +### Example + +* mySequenceLink.getSourceInvolvementFunction() + * the Sequence of source involvement functions for the given SequenceLink + +## org.polarsys.capella.core.data.fa.ReferenceHierarchyContext.getSourceReferenceHierachy() : Sequence{org.polarsys.capella.core.data.fa.FunctionalChainReference} + +Returns the Sequence of source reference hierarchy for the given ReferenceHierarchyContext. + +### Parameter + +* **value**: the ReferenceHierarchyContext + +### Example + +* myReferenceHierarchyContext.getSourceReferenceHierachy() + * the Sequence of source reference hierarchy for the given ReferenceHierarchyContext + +## org.polarsys.capella.core.data.fa.SequenceLinkEnd.getSourceSequenceLinks() : Sequence{org.polarsys.capella.core.data.fa.SequenceLink} + +Returns the Sequence of source sequence links for the given SequenceLinkEnd. + +### Parameter + +* **value**: the SequenceLinkEnd + +### Example + +* mySequenceLinkEnd.getTargetSequenceLinks() + * the Sequence of source sequence links for the given SequenceLinkEnd + +## org.polarsys.capella.core.data.capellacommon.StateTransition.getSource() : Sequence{org.polarsys.capella.common.data.modellingcore.IState} + +Returns the Sequence of source for the given StateTransition. + +### Parameter + +* **value**: the StateTransition + +### Example + +* myStateTransition.getSource() + * the Sequence of source for the given StateTransition + +## org.polarsys.capella.core.data.capellacore.Allocation.getSource() : Sequence{org.polarsys.capella.common.data.modellingcore.TraceableElement} + +Returns the Sequence of source for the given Allocation. + +### Parameter + +* **value**: the Allocation + +### Example + +* myAllocation.getSource() + * the Sequence of source for the given Allocation + +## org.polarsys.capella.core.data.capellacore.Generalization.getSource() : Sequence{org.polarsys.capella.core.data.capellacore.GeneralizableElement} + +Returns the Sequence of source for the given Generalization. + +### Parameter + +* **value**: the Generalization + +### Example + +* myGeneralization.getSource() + * the Sequence of source for the given Generalization + +## org.polarsys.capella.core.data.capellacore.Trace.getSource() : Sequence{org.polarsys.capella.common.data.modellingcore.TraceableElement} + +Returns the Sequence of sources for the given Trace. + +### Parameter + +* **value**: the Trace + +### Example + +* myTrace.getSource() + * the Sequence of sources for the given Trace + +## org.polarsys.capella.core.data.cs.InterfaceImplementation.getSource() : Sequence{org.polarsys.capella.core.data.cs.Component} + +Returns the Sequence of sources for the given InterfaceImplementation. + +### Parameter + +* **value**: the InterfaceImplementation + +### Example + +* myInterface.getSource() + * the Sequence of sources for the given InterfaceImplementation + +## org.polarsys.capella.core.data.cs.InterfaceUse.getSource() : Sequence{org.polarsys.capella.core.data.cs.Component} + +Returns the Sequence of sources for the given InterfaceUse. + +### Parameter + +* **value**: the InterfaceUse + +### Example + +* myInterfaceUse.getSource() + * the Sequence of sources for the given InterfaceUse + +## org.polarsys.capella.core.data.ctx.CapabilityExploitation.getSource() : Sequence{org.polarsys.capella.core.data.ctx.Mission} + +Returns the Sequence of source for the given CapabilityExploitation. + +### Parameter + +* **value**: the CapabilityExploitation + +### Example + +* myCapabilityExploitation.getSource() + * the Sequence of source for the given CapabilityExploitation + +## org.polarsys.capella.core.data.fa.ExchangeSpecification.getSource() : Sequence{org.polarsys.capella.common.data.modellingcore.InformationsExchanger} + +Returns the Sequence of source for the given ExchangeSpecification. + +### Parameter + +* **value**: the ExchangeSpecification + +### Example + +* myEntity.getSource() + * the Sequence of source for the given ExchangeSpecification + +## org.polarsys.capella.core.data.fa.FunctionalChainInvolvementLink.getSource() : Sequence{org.polarsys.capella.core.data.fa.FunctionalChainInvolvementFunction} + +Returns the Sequence of source for the given FunctionalChainInvolvementLink. + +### Parameter + +* **value**: the FunctionalChainInvolvementLink + +### Example + +* myFunctionalChainInvolvementLink.getSource() + * the Sequence of source for the given FunctionalChainInvolvementLink + +## org.polarsys.capella.core.data.fa.FunctionalExchange.getSource() : Sequence{org.polarsys.capella.common.data.activity.ActivityNode} + +Returns the Sequence of sources for the given FunctionalExchange. + +### Parameter + +* **value**: the FunctionalExchange + +### Example + +* myFunctionalExchange.getSource() + * the Sequence of sources for the given FunctionalExchange + +## org.polarsys.capella.core.data.information.communication.CommunicationLink.getSource() : Sequence{org.polarsys.capella.core.data.cs.Component} + +Returns the Sequence of source for the given CommunicationLink. + +### Parameter + +* **value**: the CommunicationLink + +### Example + +* myCommunicationLink.getSource() + * the Sequence of source for the given CommunicationLink + +## org.polarsys.capella.core.data.interaction.AbstractCapabilityExtend.getSource() : Sequence{org.polarsys.capella.core.data.interaction.AbstractCapability} + +Returns the Sequence of source for the given AbstractCapabilityExtend. + +### Parameter + +* **value**: the AbstractCapabilityExtend + +### Example + +* myAbstractCapabilityExtend.getSource() + * the Sequence of source for the given AbstractCapabilityExtend + +## org.polarsys.capella.core.data.interaction.AbstractCapabilityGeneralization.getSource() : Sequence{org.polarsys.capella.core.data.interaction.AbstractCapability} + +Returns the Sequence of source for the given AbstractCapabilityGeneralization. + +### Parameter + +* **value**: the AbstractCapabilityGeneralization + +### Example + +* myAbstractCapabilityGeneralization.getSource() + * the Sequence of source for the given AbstractCapabilityGeneralization + +## org.polarsys.capella.core.data.interaction.AbstractCapabilityInclude.getSource() : Sequence{Object} + +Returns the Sequence of source for the given AbstractCapabilityInclude. + +### Parameter + +* **value**: the AbstractCapabilityInclude + +### Example + +* myAbstractCapabilityInclude.getSource() + * the Sequence of source for the given AbstractCapabilityInclude + +## org.polarsys.capella.core.data.oa.CommunicationMean.getSource() : Sequence{org.polarsys.capella.common.data.modellingcore.InformationsExchanger} + +Returns the Sequence of source for the given CommunicationMean. + +### Parameter + +* **value**: the CommunicationMean + +### Example + +* myCommunicationMean.getSource() + * the Sequence of source for the given CommunicationMean + +## org.polarsys.capella.core.data.fa.SequenceLink.getTargetControlNode() : Sequence{org.polarsys.capella.core.data.fa.ControlNode} + +Returns the Sequence of target control node for the given SequenceLink. + +### Parameter + +* **value**: the SequenceLink + +### Example + +* mySequenceLink.getTargetControlNode() + * the Sequence of target control node for the given SequenceLink + +## org.eclipse.sirius.viewpoint.DRepresentationDescriptor.getTargetElement() : Sequence{EObject} + +Returns the Sequence of target element for the given DRepresentationDescriptor. + +### Parameter + +* **value**: the DRepresentationDescriptor + +### Example + +* myDRepresentationDescriptor.getTargetElement() + * the Sequence of target element for the given DRepresentationDescriptor + +## org.polarsys.capella.core.data.fa.SequenceLink.getTargetInvolvementFunction() : Sequence{org.polarsys.capella.core.data.fa.FunctionalChainInvolvementFunction} + +Returns the Sequence of target involvement functions for the given SequenceLink. + +### Parameter + +* **value**: the SequenceLink + +### Example + +* mySequenceLink.getTargetInvolvementFunction() + * the Sequence of target involvement functions for the given SequenceLink + +## org.polarsys.capella.core.data.fa.ReferenceHierarchyContext.getTargetReferenceHierachy() : Sequence{org.polarsys.capella.core.data.fa.FunctionalChainReference} + +Returns the Sequence of target reference hierarchy for the given ReferenceHierarchyContext. + +### Parameter + +* **value**: the ReferenceHierarchyContext + +### Example + +* myReferenceHierarchyContext.getTargetReferenceHierachy() + * the Sequence of target reference hierarchy for the given ReferenceHierarchyContext + +## org.polarsys.capella.core.data.fa.SequenceLinkEnd.getTargetSequenceLinks() : Sequence{org.polarsys.capella.core.data.fa.SequenceLink} + +Returns the Sequence of target sequence links for the given SequenceLinkEnd. + +### Parameter + +* **value**: the SequenceLinkEnd + +### Example + +* mySequenceLinkEnd.getTargetSequenceLinks() + * the Sequence of target sequence links for the given SequenceLinkEnd + +## org.polarsys.capella.core.data.capellacommon.StateTransition.getTarget() : Sequence{org.polarsys.capella.common.data.modellingcore.IState} + +Returns the Sequence of target for the given StateTransition. + +### Parameter + +* **value**: the StateTransition + +### Example + +* myStateTransition.getTarget() + * the Sequence of target for the given StateTransition + +## org.polarsys.capella.core.data.capellacore.Allocation.getTarget() : Sequence{org.polarsys.capella.common.data.modellingcore.TraceableElement} + +Returns the Sequence of target for the given Allocation. + +### Parameter + +* **value**: the Allocation + +### Example + +* myAllocation.getTarget() + * the Sequence of target for the given Allocation + +## org.polarsys.capella.core.data.capellacore.Generalization.getTarget() : Sequence{org.polarsys.capella.core.data.capellacore.GeneralizableElement} + +Returns the Sequence of target for the given Generalization. + +### Parameter + +* **value**: the Generalization + +### Example + +* myGeneralization.getTarget() + * the Sequence of target for the given Generalization + +## org.polarsys.capella.core.data.capellacore.Trace.getTarget() : Sequence{org.polarsys.capella.common.data.modellingcore.TraceableElement} + +Returns the Sequence of targets for the given Trace. + +### Parameter + +* **value**: the Trace + +### Example + +* myTrace.getTarget() + * the Sequence of targets for the given Trace + +## org.polarsys.capella.core.data.cs.InterfaceImplementation.getTarget() : Sequence{org.polarsys.capella.core.data.cs.Interface} + +Returns the Sequence of targets for the given InterfaceImplementation. + +### Parameter + +* **value**: the InterfaceImplementation + +### Example + +* myInterface.getTarget() + * the Sequence of targets for the given InterfaceImplementation + +## org.polarsys.capella.core.data.cs.InterfaceUse.getTarget() : Sequence{org.polarsys.capella.core.data.cs.Interface} + +Returns the Sequence of targets for the given InterfaceUse. + +### Parameter + +* **value**: the InterfaceUse + +### Example + +* myInterfaceUse.getTarget() + * the Sequence of targets for the given InterfaceUse + +## org.polarsys.capella.core.data.fa.ExchangeSpecification.getTarget() : Sequence{org.polarsys.capella.common.data.modellingcore.InformationsExchanger} + +Returns the Sequence of target for the given ExchangeSpecification. + +### Parameter + +* **value**: the ExchangeSpecification + +### Example + +* myEntity.getTarget() + * the Sequence of target for the given ExchangeSpecification + +## org.polarsys.capella.core.data.fa.FunctionalChainInvolvementLink.getTarget() : Sequence{org.polarsys.capella.core.data.fa.FunctionalChainInvolvementFunction} + +Returns the Sequence of target for the given FunctionalChainInvolvementLink. + +### Parameter + +* **value**: the FunctionalChainInvolvementLink + +### Example + +* myFunctionalChainInvolvementLink.getTarget() + * the Sequence of target for the given FunctionalChainInvolvementLink + +## org.polarsys.capella.core.data.fa.FunctionalExchange.getTarget() : Sequence{org.polarsys.capella.common.data.activity.ActivityNode} + +Returns the Sequence of targets for the given FunctionalExchange. + +### Parameter + +* **value**: the FunctionalExchange + +### Example + +* myFunctionalExchange.getTarget() + * the Sequence of targets for the given FunctionalExchange + +## org.polarsys.capella.core.data.information.communication.CommunicationLink.getTarget() : Sequence{org.polarsys.capella.common.data.modellingcore.AbstractExchangeItem} + +Returns the Sequence of target for the given CommunicationLink. + +### Parameter + +* **value**: the CommunicationLink + +### Example + +* myCommunicationLink.getTarget() + * the Sequence of target for the given CommunicationLink + +## org.polarsys.capella.core.data.interaction.AbstractCapabilityExtend.getTarget() : Sequence{org.polarsys.capella.core.data.interaction.AbstractCapability} + +Returns the Sequence of target for the given AbstractCapabilityExtend. + +### Parameter + +* **value**: the AbstractCapabilityExtend + +### Example + +* myAbstractCapabilityExtend.getTarget() + * the Sequence of target for the given AbstractCapabilityExtend + +## org.polarsys.capella.core.data.interaction.AbstractCapabilityGeneralization.getTarget() : Sequence{org.polarsys.capella.core.data.interaction.AbstractCapability} + +Returns the Sequence of target for the given AbstractCapabilityGeneralization. + +### Parameter + +* **value**: the AbstractCapabilityGeneralization + +### Example + +* myAbstractCapabilityGeneralization.getTarget() + * the Sequence of target for the given AbstractCapabilityGeneralization + +## org.polarsys.capella.core.data.interaction.AbstractCapabilityInclude.getTarget() : Sequence{org.polarsys.capella.core.data.interaction.AbstractCapability} + +Returns the Sequence of target for the given AbstractCapabilityInclude. + +### Parameter + +* **value**: the AbstractCapabilityInclude + +### Example + +* myAbstractCapabilityInclude.getTarget() + * the Sequence of target for the given AbstractCapabilityInclude + +## org.polarsys.capella.core.data.oa.CommunicationMean.getTarget() : Sequence{org.polarsys.capella.common.data.modellingcore.InformationsExchanger} + +Returns the Sequence of target for the given CommunicationMean. + +### Parameter + +* **value**: the CommunicationMean + +### Example + +* myCommunicationMean.getTarget() + * the Sequence of target for the given CommunicationMean + +## org.polarsys.capella.core.data.capellacommon.StateTransition.getTrigger() : Sequence{org.polarsys.capella.common.data.behavior.AbstractEvent} + +Returns the Sequence of trigger for the given StateTransition. + +### Parameter + +* **value**: the StateTransition + +### Example + +* myStateTransition.getTrigger() + * the Sequence of trigger for the given StateTransition + +## org.polarsys.capella.common.data.activity.Pin.getType() : Sequence{org.polarsys.capella.common.data.modellingcore.AbstractType} + +Returns the Sequence of type for the given Pin. + +### Parameter + +* **value**: the Pin + +### Example + +* myPin.getType() + * the Sequence of type for the given Pin + +## org.polarsys.capella.core.data.cs.Part.getType() : Sequence{org.polarsys.capella.common.data.modellingcore.AbstractType} + +Returns the Sequence of type for the given Part. + +### Parameter + +* **value**: the Part + +### Example + +* myPart.getType() + * the Sequence of type for the given Part + +## org.polarsys.capella.core.data.fa.ComponentPort.getType() : Sequence{org.polarsys.capella.core.data.capellacore.Type} + +Returns the Sequence of types for the given ComponentPort. + +### Parameter + +* **value**: the ComponentPort + +### Example + +* myComponentPort.getType() + * the Sequence of types for the given ComponentPort + +## org.polarsys.capella.core.data.information.Collection.getType() : Sequence{org.polarsys.capella.core.data.capellacore.Type} + +Returns the Sequence of type for the given Collection. + +### Parameter + +* **value**: the Collection + +### Example + +* myCollection.getType() + * the Sequence of type for the given Collection + +## org.polarsys.capella.core.data.information.ExchangeItemElement.getType() : Sequence{org.polarsys.capella.common.data.modellingcore.AbstractType} + +Returns the Sequence of type for the given ExchangeItemElement. + +### Parameter + +* **value**: the ExchangeItemElement + +### Example + +* myExchangeItemElement.getType() + * the Sequence of type for the given ExchangeItemElement + +## org.polarsys.capella.core.data.information.Parameter.getType() : Sequence{org.polarsys.capella.core.data.capellacore.Type} + +Returns the Sequence of type for the given Parameter. + +### Parameter + +* **value**: the Parameter + +### Example + +* myParameter.getType() + * the Sequence of type for the given Parameter + +## org.polarsys.capella.core.data.information.Property.getType() : Sequence{org.polarsys.capella.core.data.capellacore.Type} + +Returns the Sequence of types for the given Property. + +### Parameter + +* **value**: the Property + +### Example + +* myProperty.getType() + * the Sequence of types for the given Property + +## org.polarsys.capella.core.data.capellacore.Type.getTypingElements() : Sequence{org.polarsys.capella.core.data.information.ExchangeItemElement} + +Returns the Sequence of typing elements for the given Type. + +### Parameter + +* **value**: the Type + +### Example + +* myAllocation.getTypingElements() + * the Sequence of typing elements for the given Type + +## org.polarsys.capella.core.data.cs.Component.getUsedInterfaces() : Sequence{org.polarsys.capella.core.data.cs.Interface} + +Returns the Sequence of used interfaces for the given Component. + +### Parameter + +* **value**: the Component + +### Example + +* myComponent.getUsedInterfaces() + * the Sequence of used interfaces for the given Component + +## org.polarsys.capella.core.data.cs.Interface.getUsers() : Sequence{org.polarsys.capella.core.data.cs.Component} + +Returns the Sequence of users for the given Interface. + +### Parameter + +* **value**: the Interface + +### Example + +* myInterface.getUsers() + * the Sequence of users for the given Interface + +## org.polarsys.capella.core.data.capellacore.AbstractPropertyValue.getValuedElements() : Sequence{org.polarsys.capella.core.data.capellacore.CapellaElement} + +Returns the Sequence of valued elements for the given AbstractPropertyValue. + +### Parameter + +* **value**: the AbstractPropertyValue + +### Example + +* myAbstractPropertyValue.getValuedElements() + * the Sequence of valued elements for the given AbstractPropertyValue + +## org.polarsys.capella.core.data.capellacore.PropertyValueGroup.getValuedElements() : Sequence{org.polarsys.capella.core.data.capellacore.CapellaElement} + +Returns the Sequence of valued elements for the given PropertyValueGroup. + +### Parameter + +* **value**: the PropertyValueGroup + +### Example + +* myPropertyValueGroup.getValuedElements() + * the Sequence of valued elements for the given PropertyValueGroup + +## org.polarsys.capella.core.data.capellacore.AbstractPropertyValue.getValue() : Sequence{org.polarsys.capella.core.data.capellacore.AbstractPropertyValue} + +Returns the Sequence of value for the given AbstractPropertyValue. + +### Parameter + +* **value**: the AbstractPropertyValue + +### Example + +* myAbstractPropertyValue.getValue() + * the Sequence of value for the given AbstractPropertyValue + +## org.polarsys.capella.core.data.information.datavalue.DataValue.getValue() : Sequence{String} + +Returns the Sequence of values for the given DataValue. + +### Parameter + +* **value**: the DataValue + +### Example + +* myDataValue.getValue() + * the Sequence of values for the given DataValue + + + diff --git a/ref-doc/3.3.3/m2doc_service_swtpromptservices.md b/ref-doc/3.3.3/m2doc_service_swtpromptservices.md new file mode 100644 index 000000000..98132ac1b --- /dev/null +++ b/ref-doc/3.3.3/m2doc_service_swtpromptservices.md @@ -0,0 +1,94 @@ +--- +layout: article-services +title: SWTPromptServices +subtitle: 3.3.3 +relativePath: ../.. +--- + + + +# SWTPromptServices + +Services available for prompting user for values using SWT for graphical user interface. + +* TOC +{:toc} + +## String.promptDouble() : Double + +Prompts for a Double value with the given message. + +### Parameter + +* **message**: The message displayed to the user + +### Example + +* 'Enter your weight: '.promptDouble() + * prompts the user + +## String.promptFloat() : Float + +Prompts for a Float value with the given message. + +### Parameter + +* **message**: The message displayed to the user + +### Example + +* 'Enter your weight: '.promptFloat() + * prompts the user + +## String.promptInteger() : Integer + +Prompts for a Integer value with the given message. + +### Parameter + +* **message**: The message displayed to the user + +### Example + +* 'Enter your age: '.promptInteger() + * prompts the user + +## String.promptLong() : Long + +Prompts for a Long value with the given message. + +### Parameter + +* **message**: The message displayed to the user + +### Example + +* 'Enter your age: '.promptLong() + * prompts the user + +## String.promptString() : String + +Prompts for a String value with the given message. + +### Parameter + +* **message**: The message displayed to the user + +### Example + +* 'Enter your name: '.promptString() + * prompts the user + + + diff --git a/ref-doc/3.3.3/services-toc.xml b/ref-doc/3.3.3/services-toc.xml new file mode 100644 index 000000000..9902caab0 --- /dev/null +++ b/ref-doc/3.3.3/services-toc.xml @@ -0,0 +1,18 @@ + + + + + + + + + + + + + + + + + +