mirrors/eiffel-org
1
0
Fork 0
mirror of https://github.com/EiffelSoftware/eiffel-org.git synced 2025-12-07 15:22:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

Replaced many abc' to abc`.

Browse Source 
Added 16.05 branch.

git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@1591 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
eiffel-org
2016-06-16 12:15:58 +00:00
parent 24b363ac17
commit a4b2f9f415
2882 changed files with 59503 additions and 158 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
documentation/16.05/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/computing-measure/evaluating-measure.wiki Normal file
View File

@@ -0,0 +1,22 @@
[[Property:title|Evaluating a measure]]
[[Property:weight|1]]
[[Property:uuid|533ec807-ad3d-5338-3955-aa2f8601976e]]
To evaluate a metric over a scope:
# Select the '''Metric Evaluation''' tab from the Metric tool.
# Define the scope by adding either groups, classes or features to the input domain list.
# Select a metric from the list of available metrics.
# Click the '''Run selected metric''' button and the result will appear in the '''Value''' text field.
You can get more information about the evaluated metric. See [[Viewing measure details|detailing a measure]] .
{{warning|When calculated, a measure is not saved. }}
{{seealso|<br/>
[[Saving a measure|Saving a measure]] <br/>
[[Viewing measure details|Detailing a measure]] <br/>
}}

9
documentation/16.05/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/computing-measure/index.wiki Normal file
View File

@@ -0,0 +1,9 @@
[[Property:title|Computing a measure]]
[[Property:weight|1]]
[[Property:uuid|cff91cf0-1280-f79d-440a-69801b213dac]]
The metric interface allows users to analyze their projects. It provides a set of metrics that could be evaluated over various scopes to obtain quantitative information about systems.
Thanks to the metric interface, users can evaluate metrics over different scopes, get some detailed information when possible, save the pertinent measures, delete the useless ones, and update the values of previously recorded metrics.
Below is the list of operations you can perform.

17
documentation/16.05/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/computing-measure/saving-measure.wiki Normal file
View File

@@ -0,0 +1,17 @@
[[Property:title|Saving a measure]]
[[Property:weight|2]]
[[Property:uuid|d967fde4-5dea-a855-50ec-b0d8f1473cf2]]
To save the result of evaluation of a metric:
# Select the '''Metric Archive''' tab of the Metric tool.
# Select the input domain as described in [[Evaluating a measure|Evaluating a measure]] and the metrics you want to compute and save over the selected scope
# Select a file to use to store the results. If you specify a non-existing file, it will be created, if you specify an existing file it will be overriden. The selection of the file can be done by clicking on the button with the three dots in the '''Archive Management''' frame.
# Click the '''Start metric archive evaluation'''.
{{seealso|<br/>
[[Evaluating a measure|Evaluating a measure]] <br/>
[[Viewing measure details|Detailing measures]] <br/>
}}

17
documentation/16.05/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/computing-measure/viewing-measure-details.wiki Normal file
View File

@@ -0,0 +1,17 @@
[[Property:title|Viewing measure details]]
[[Property:weight|3]]
[[Property:uuid|570feb7a-4650-0a7d-ae45-1336c5429cfb]]
It is possible to have some details when evaluating a metric.
# Select the '''Metric Evaluation''' tab of the metric tool.
# [[Evaluating a measure|Evaluate a metric]] .
# Click the '''Run selected metric and show detailed result''' button and the result will appear in the '''Detailed Result''' tab of the metric tool.
# To come back to the main interface click again on '''Metric Evaluation''' tab of the metric tool.
{{seealso|<br/>
[[Evaluating a measure|Evaluating a measure]] <br/>
[[Saving a measure|Saving measures]] <br/>
}}

15
documentation/16.05/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/handling-archives/comparing-archive.wiki Normal file
View File

@@ -0,0 +1,15 @@
[[Property:title|Comparing to an archive]]
[[Property:weight|2]]
[[Property:uuid|eb13a2c4-623d-8a35-6175-40a43486beb8]]
The main goal of archives is comparing archives one to another. In order to compare your project to an archived file, you must select the '''Metric archive''' tab of the metric tool.
The goal is to load the archive of a (preferably different) project, to compare the archived measures to the system's. You can select your current archive or any other archive, against a reference archive file.
Once the archives are selected, click the '''Compare''' button to start the comparison. It will bring you to the '''Detailed Result''' tab.
{{seealso|<br/>
[[Creating an archive|Creating an archive]] }}

11
documentation/16.05/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/handling-archives/creating-archive.wiki Normal file
View File

@@ -0,0 +1,11 @@
[[Property:title|Creating an archive]]
[[Property:weight|1]]
[[Property:uuid|d8bd6d77-a5dc-df38-a796-6fa8a07ddf29]]
Users may want to archive the result of the system they are working on. To create an archive is basically the same as [[Saving a measure|saving a measure]] .
{{seealso|<br/>
[[Comparing to an archive|Comparing to an archive]] }}

7
documentation/16.05/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/handling-archives/index.wiki Normal file
View File

@@ -0,0 +1,7 @@
[[Property:title|Handling archives]]
[[Property:weight|3]]
[[Property:uuid|1a2bc120-2f9d-0cc3-4883-a98c5999b12d]]
The archive file for a system contains all the values of measures resulting from evaluating selected metrics. It also contains the definitions of non elementary metrics (the one user has [[Defining new metrics|defined]]) in order to be sure of what is being measured.
The archive files are entitled to achieve comparisons between systems. And then, user can compare systems to evaluate their own projects.

21
documentation/16.05/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/handling-new-metrics/defining-new-metrics/defining-derived-metrics.wiki Normal file
View File

@@ -0,0 +1,21 @@
[[Property:title|Defining derived metrics]]
[[Property:weight|1]]
[[Property:uuid|d9c9037a-7b87-3810-c5c8-d34523cdad7b]]
To define a derived metric, you must select the''' Metric Definition''' tab and click the '''New metric''' button. A menu appears asking you the kind of metric you want to define. Select '''Basic metric''' and then the type of the results you are looking for (i.e. Class, Feature, Line, ...). Once done, you can perform the following steps:
# Enter a name for the metric in the "Name" field. Next to the field you will see the type of metric as well as the unit for this metric.
# Enter a description for the metric. The description is shown as a tooltip when you navigate the list of available metrics.
# Choose your criteria by selecting the item with ... in the '''Criterion definition''' list. Once selected you can press Ctrl+Space to see the list of available criterion. Once the criterion is set, you can add some properties (e.g. a property could be <eiffel>STRING</eiffel> if the criterion you have is to look for descendants of the <eiffel>STRING</eiffel> class).
# Once you have completed the metric definition you need to save your metric by clicking on the Save button.
# If you want to define another derived metric, repeat all the previous steps.
For more information about criterion, read the [[Criterion References|Managing criterion]] section.
A summary of the metric you just defined appears in a textual representation in the '''Expression''' text field.
{{seealso|<br/>
[[Managing new metrics|Managing metrics]] <br/>
[[Criterion References|Managing criterion]] }}

20
documentation/16.05/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/handling-new-metrics/defining-new-metrics/defining-linear-metrics.wiki Normal file
View File

@@ -0,0 +1,20 @@
[[Property:title|Defining linear metrics]]
[[Property:weight|2]]
[[Property:uuid|bfcfffff-08ec-8e18-fed4-3f39ac3772da]]
To define a linear metric, you must select the '''Metric Definition''' tab and click the '''New metric''' button. A menu appears asking you the kind of metric you want to define. Select '''Linear metric''' and then the type of the results you are looking for (i.e. Class, Feature, Line, ...). Once done, you can perform the following steps:
# Enter a name for the metric in the "Name" field. Next to the field you will see the type of metric as well as the unit for this metric.
# Enter a description for the metric. The description is shown as a tooltip when you navigate the list of available metrics.
# Define a single term by choosing a metric from the combo box that appears when selecting the '''Metrics''' column, and then choose a coefficent in the '''Coefficient''' column of the metric definition list.
# To add other terms, repeat operation 3 as many times as needs.
# Once you have completed the metric definition you need to save your metric by clicking on the Save button.
# If you want to define another linear metric, repeat all the previous steps.
A summary of the metric you just defined appears in a textual representation in the '''Expression''' text field.
{{seealso|<br/>
[[Managing new metrics|Managing metrics]] <br/>
}}

21
documentation/16.05/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/handling-new-metrics/defining-new-metrics/defining-ratio-metrics.wiki Normal file
View File

@@ -0,0 +1,21 @@
[[Property:title|Defining ratio metrics]]
[[Property:weight|3]]
[[Property:uuid|40394359-600c-5392-8609-6f994920a3b1]]
To define a ratio metric, you must select the '''Metric Definition''' tab and click the '''New metric''' button. A menu appears asking you the kind of metric you want to define. Select '''Ratio metric'''. Once done, you can perform the following steps:
# Enter a name for the metric in the "Name" field. Next to the field you will see the type of metric as well as the unit for this metric.
# Enter a description for the metric. The description is shown as a tooltip when you navigate the list of available metrics.
# Select a metric for numerator in the "Metric" combo box of the "Numerator" frame to change the numerator in the "Ratio" field.
# Select a metric for denominator in the "Metric" combo box of the "Denominator" frame to change the denominator in the "Ratio" field.
# If you want to change again either numerator or denominator repeat operations 3. or 4. as many times as needed.
# Once you have completed the metric definition you need to save your metric by clicking on the Save button.
# If you want to define another ratio metric, repeat all the previous steps.
A summary of the metric you just defined appears in a textual representation in the '''Expression''' text field.
{{seealso|<br/>
[[Managing new metrics|Managing metrics]] <br/>
}}

13
documentation/16.05/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/handling-new-metrics/defining-new-metrics/index.wiki Normal file
View File

@@ -0,0 +1,13 @@
[[Property:title|Defining new metrics]]
[[Property:weight|1]]
[[Property:uuid|7f36c01c-40f4-be23-dfcd-d92bf2bbd535]]
The metric interface provides by default a set of basic metrics. However, user may want to define other metrics, such as linear sums or different ratios, or combining some criteria... This is possible thanks to the '''Metric Definition''' tab of the metric tool.
New metrics are increasingly added to the list of metrics which is ordered by unit type, and are available for [[Evaluating a measure|calculation]] .
{{seealso|<br/>
[[Evaluating a measure|Evaluating a measure]] <br/>
[[Managing new metrics]] }}

9
documentation/16.05/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/handling-new-metrics/index.wiki Normal file
View File

@@ -0,0 +1,9 @@
[[Property:title|Handling new metrics]]
[[Property:weight|2]]
[[Property:uuid|1ca7a8cf-f446-6cbc-59e1-0455e633ce44]]
The metric tool ("Metric" tab of the context tool) provides by default a set of metrics that can be used to make some measurements over various scopes in order to evaluate a project.
This set of metrics is certainly not complete, users may probably want to define other metrics regarding their own needs. And then, since needs are different and in order to avoid an explosion in the number of basic metrics, we agreed on implementing only elementary metrics that could not be evaluated if not implemented in the tool.
Users can then define their own metrics. The metric tool provides an interface to define new metrics. Click on the '''Metric Definition''' tab in the metric tool to start adding new metrics and modifying existing metrics.

7
documentation/16.05/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/handling-new-metrics/managing-new-metrics.wiki Normal file
View File

@@ -0,0 +1,7 @@
[[Property:title|Managing new metrics]]
[[Property:weight|2]]
[[Property:uuid|540cbcc4-27cb-7fc4-5c98-0c622bfb0841]]
After having [[Defining new metrics|defined]] some new metrics, it is possible to delete the useless ones, or to edit them:
* Deleting a metric: select the metric you want to delete and click on the '''Remove current selected metric''' button.
* Editing a metric: select the metric you want to edit and start changing its definition by adding or removing criteria (derived), adding or removing terms (linear), changing numerator and denominator (ratio).

8
documentation/16.05/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/index.wiki Normal file
View File

@@ -0,0 +1,8 @@
[[Property:title|How to analyze a project]]
[[Property:weight|6]]
[[Property:uuid|85d47406-926e-8754-0c15-a2af5b151658]]
The metric tab in the context tool allows project analyzing. Built on a suitable metric theory, this tool provides a set of elementary metrics that can be evaluated to test projects design and implementation.
The metric tool provides an interface to evaluate measures, save them or delete some of them when no longer needed.