Author:admin

Date:2008-09-17T13:53:28.000000Z


git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@3 abb3cda0-5349-4a8f-a601-0c33ac3a8c38

documentation/current/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/computing-measure/evaluating-measure.wiki

@@ -0,0 +1,24 @@
+[[Property:title|Evaluating a measure]]
+[[Property:weight|1]]
+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| '''Caution''': When calculated, a measure is not saved. }}
+
+{{seealso| '''See Also''' <br/>
+[[Saving a measure|Saving a measure]]  <br/>
+[[Viewing measure details|Detailing a measure]]  <br/>
+}}
+<br/>
+<br/>
+
+
+
+

documentation/current/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/computing-measure/index.wiki

@@ -0,0 +1,10 @@
+[[Property:title|Computing a measure]]
+[[Property:weight|1]]
+*  [[Computing a measure: Introduction|Introduction]]  
+*  [[Evaluating a measure|Evaluating a measure]]  
+*  [[Saving a measure|Saving a measure]]  
+*  [[Viewing measure details|Detailing a measure]]  
+
+
+
+

documentation/current/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/computing-measure/saving-measure.wiki

@@ -0,0 +1,16 @@
+[[Property:title|Saving a measure]]
+[[Property:weight|2]]
+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| '''See Also''' <br/>
+[[Evaluating a measure|Evaluating a measure]]  <br/>
+[[Viewing measure details|Detailing measures]]  <br/>
+}}
+
+
+
+

documentation/current/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/computing-measure/viewing-measure-details.wiki

@@ -0,0 +1,16 @@
+[[Property:title|Viewing measure details]]
+[[Property:weight|3]]
+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| '''See Also''' <br/>
+[[Evaluating a measure|Evaluating a measure]]  <br/>
+[[Saving a measure|Saving measures]]  <br/>
+}}
+
+
+
+

documentation/current/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/handling-archives/comparing-archive.wiki

@@ -0,0 +1,14 @@
+[[Property:title|Comparing to an archive]]
+[[Property:weight|2]]
+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| '''See Also''' <br/>
+[[Creating an archive|Creating an archive]]  }}
+
+
+
+

documentation/current/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/handling-archives/creating-archive.wiki

@@ -0,0 +1,10 @@
+[[Property:title|Creating an archive]]
+[[Property:weight|1]]
+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| '''See Also''' <br/>
+[[Comparing to an archive|Comparing to an archive]]  }}
+
+
+
+

documentation/current/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/handling-archives/index.wiki

@@ -0,0 +1,9 @@
+[[Property:title|Handling archives]]
+[[Property:weight|3]]
+*  [[Handling archives: introduction|Introduction]]  
+*  [[Creating an archive|Creating an archive]]  
+*  [[Comparing to an archive|Comparing to an archive]]  
+
+
+
+

documentation/current/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/handling-new-metrics/defining-new-metrics/defining-derived-metrics.wiki

@@ -0,0 +1,20 @@
+[[Property:title|Defining derived metrics]]
+[[Property:weight|1]]
+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| '''See Also''' <br/>
+[[Managing new metrics: Introduction|Managing metrics]]  <br/>
+[[Criterion References|Managing criterion]]  }}
+
+
+
+

documentation/current/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/handling-new-metrics/defining-new-metrics/defining-linear-metrics.wiki

@@ -0,0 +1,19 @@
+[[Property:title|Defining linear metrics]]
+[[Property:weight|2]]
+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| '''See Also''' <br/>
+[[Managing new metrics: Introduction|Managing metrics]]  <br/>
+}}
+
+
+
+

documentation/current/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/handling-new-metrics/defining-new-metrics/defining-ratio-metrics.wiki

@@ -0,0 +1,20 @@
+[[Property:title|Defining ratio metrics]]
+[[Property:weight|3]]
+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| '''See Also''' <br/>
+[[Managing new metrics: Introduction|Managing metrics]]  <br/>
+}}
+
+
+
+

documentation/current/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/handling-new-metrics/defining-new-metrics/index.wiki

@@ -0,0 +1,10 @@
+[[Property:title|Defining new metrics]]
+[[Property:weight|1]]
+*  [[Defining new metrics: introduction|Introduction]]  
+*  [[Defining derived metrics|Derived metrics]]  
+*  [[Defining linear metrics|Linear metrics]]  
+*  [[Defining ratio metrics|Ratio metrics]]  
+
+
+
+

documentation/current/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/handling-new-metrics/index.wiki

@@ -0,0 +1,9 @@
+[[Property:title|Handling new metrics]]
+[[Property:weight|2]]
+*  [[Handling new metrics: Introduction|Introduction]]  
+*  [[Defining new metrics|Defining new metrics]]  
+*  [[Managing new metrics|Managing metrics]]  
+
+
+
+

documentation/current/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/handling-new-metrics/managing-new-metrics.wiki

@@ -0,0 +1,7 @@
+[[Property:title|Managing new metrics]]
+[[Property:weight|2]]
+*  [[Managing new metrics: Introduction|Introduction]]  
+
+
+
+

documentation/current/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/index.wiki

@@ -0,0 +1,10 @@
+[[Property:title|How to analyze a project]]
+[[Property:weight|6]]
+*  [[How to analyze a project: Introduction|Introduction]]  
+*  [[Computing a measure|Computing a measure]]  
+*  [[Handling new metrics|Handling new metrics]]  
+*  [[Handling archives|Handling archives]]  
+
+
+
+