mirror of
https://github.com/EiffelSoftware/eiffel-org.git
synced 2025-12-08 07:42:33 +01:00
Author:admin
Date:2008-09-25T16:19:15.000000Z git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@44 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
jfiat
@@ -3,9 +3,9 @@
|
||||
[[Property:uuid|f2d63c29-6be2-b3d9-a735-b18e08c5a678]]
|
||||
For functions and procedures, you can build a formal argument list. You can do this by clicking on the '''New argument''' button as many times as you need arguments.
|
||||
|
||||
{{note| '''Note''': Even though this dialog always shows parentheses, they are not generated if the list is empty (Eiffel's command-query separation (CQS) principle). }}
|
||||
{{note|Even though this dialog always shows parentheses, they are not generated if the list is empty (Eiffel's command-query separation (CQS) principle). }}
|
||||
<div> [[Image:feature-wizard-3-arguments]] </div>
|
||||
{{note| '''Note''': If you add arguments to a routine, it is not possible anymore to select routine type '''once'''. }}
|
||||
{{note|If you add arguments to a routine, it is not possible anymore to select routine type '''once'''. }}
|
||||
|
||||
For every attribute you selected, enter a name in the text box and a type using the [[Type selection|type selection]] .
|
||||
<div> [[Image:feature-wizard-1-argument]] </div>
|
||||
|
||||
@@ -6,7 +6,7 @@ The feature you create will be inserted in the feature clause you specified. If
|
||||
The export status is the class the feature is accessible for. Usually, this is <eiffel>ANY</eiffel> for public features, or <eiffel>NONE</eiffel> for implementation features, but you can specify any class here.
|
||||
[[Image:feature-wizard-export]]
|
||||
|
||||
{{note| '''Note''': In the class text, you can export a feature to more than one class but (for simplicity) not with this dialog. }}
|
||||
{{note|In the class text, you can export a feature to more than one class but (for simplicity) not with this dialog. }}
|
||||
|
||||
==Feature clause names==
|
||||
For feature clause names it is recommended that you pick one from the standard ones, but it is also possible to create a new one. If you have introduced a special feature clause name in your project, add it to the feature clause order list in the [[Preferences Reference|preferences]] and it will also appear in this dialog.
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
[[Property:uuid|850bd867-5cbf-34d0-f94c-97a75bfa244b]]
|
||||
The feature name field is a text box that lets you enter a name for the feature. For help on how to choose the right name for a feature, see: [http://www.eiffel.com/doc/oosc/ Object-Oriented Software Construction, Second Edition] , paragraph 26.2.
|
||||
|
||||
{{warning| '''Warning''': EiffelStudio performs no validation on the name you choose. For example if you type a space in it, it will generate the code, and detect a syntax error only when compiling. }}
|
||||
{{warning|EiffelStudio performs no validation on the name you choose. For example if you type a space in it, it will generate the code, and detect a syntax error only when compiling. }}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -5,14 +5,14 @@ Whenever you need to give a type of something in the dialog, the type selection
|
||||
<div> [[Image:feature-wizard-typeselection]] </div>
|
||||
When you select a class that is in the system and has formal generic parameters, the type selection component lets you specify an actual generic parameter in another type selection.
|
||||
<div> [[Image:feature-wizard-generictype]] </div>
|
||||
{{note| '''Note''': the window might grow in size because of the added component. }}
|
||||
{{note|the window might grow in size because of the added component. }}
|
||||
|
||||
Since the actual generic type selection is also a type selection, you can select another class with generic parameters and nest them as deep as you need.
|
||||
<div> [[Image:feature-wizard-generictyperec]] </div>
|
||||
You can also select the type <eiffel>TUPLE</eiffel>, which is a special class that can have zero or more generic parameters. When you select it, it has no parameters, but you can add one by clicking on the '''Add parameter''' button. Click it as often as the number of generic parameters that you need.
|
||||
<div> [[Image:feature-wizard-tupletype2]] <br/>
|
||||
</div>
|
||||
{{warning| '''Warning''': if you need a very complex type, it is better not to use the dialog, as the window might grow bigger than your screen. After you completed the feature, edit it manually in the class text. }}
|
||||
{{warning|if you need a very complex type, it is better not to use the dialog, as the window might grow bigger than your screen. After you completed the feature, edit it manually in the class text. }}
|
||||
|
||||
The code generated for the selected type is quite straightforward, an example:
|
||||
<div> [[Image:feature-wizard-complextype]] <br/>
|
||||
|
||||
@@ -43,7 +43,7 @@ As in Eiffel, -- introduces a comment, which has no effect on the specification.
|
||||
<br/>
|
||||
|
||||
|
||||
{{seealso| '''See Also''' <br/>
|
||||
{{seealso|<br/>
|
||||
[[Select a Run-time information record to generate the Execution Profile|Select a Run-time information record to generate the Execution Profile]] <br/>
|
||||
[[Profiling|How to profile a system]] }}
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
# [[Select the information you need and formulate your query|'''Final step''': Select the information you need and formulate your query.]]
|
||||
# [[Profile query window|Profile query window]]
|
||||
|
||||
{{seealso| '''See Also''' <br/>
|
||||
{{seealso|<br/>
|
||||
[[Profiler wizard: Introduction|How the Profiler wizard works]] <br/>
|
||||
[[Profiling|How to profile a system]] }}
|
||||
|
||||
|
||||
@@ -13,11 +13,11 @@ To change the operator affecting an existing sub query, select it in either the
|
||||
|
||||
Click on the '''Save''' button to save the currently displayed results in a text file.
|
||||
|
||||
{{tip| '''Tip''': To visualize the result in Microsoft Excel or any other spreadsheet, select the entire text (except the first three lines where the Execution Profile file is specified), copy it and then paste it into Excel. }}
|
||||
{{tip|To visualize the result in Microsoft Excel or any other spreadsheet, select the entire text (except the first three lines where the Execution Profile file is specified), copy it and then paste it into Excel. }}
|
||||
<br/>
|
||||
[[Image:profiler-query-window]] <br/>
|
||||
|
||||
{{seealso| '''See Also''' <br/>
|
||||
{{seealso|<br/>
|
||||
[[Profiler wizard: Introduction|How the Profiler wizard works]] <br/>
|
||||
[[Profiling|How to profile a system]] }}
|
||||
|
||||
|
||||
@@ -5,12 +5,12 @@ The second screen of the wizard lets you reuse a previously generated ''Executio
|
||||
|
||||
The profiler wizard has detected that one or more ''Execution Profiles'' have already been generated for this system in this compilation mode. If you have executed your system after the generation of the existing profile, select '''Generate a profile from Run-time information record''' to create a new ''Execution Profile'' for the newly produced ''Run-time information record''.
|
||||
|
||||
{{note| '''Note''': If you choose '''Generate a profile from Run-time information record''' the generated ''Execution Profile'' will be written into ''<project_directory>/EIFGENa/target_name/W_CODE/profinfo.pfi'' if you have selected '''Workbench mode''' in the first step, or ''<project_directory>/EIFGENs/target_name/F_CODE/profinfo.pfi'' if you have selected '''Finalized mode'''. If a file with the same name already exists its content will be destroyed and replaced. }}
|
||||
{{note|If you choose '''Generate a profile from Run-time information record''' the generated ''Execution Profile'' will be written into ''<project_directory>/EIFGENa/target_name/W_CODE/profinfo.pfi'' if you have selected '''Workbench mode''' in the first step, or ''<project_directory>/EIFGENs/target_name/F_CODE/profinfo.pfi'' if you have selected '''Finalized mode'''. If a file with the same name already exists its content will be destroyed and replaced. }}
|
||||
<br/>
|
||||
|
||||
However, if you have not executed your system since the generation of the last ''Execution Profile'', there is no need to generate a new ''Execution Profile''. If you are in the latter case, select '''Use existing profile''' and choose the last ''Execution Profile'' you have generated.
|
||||
|
||||
{{tip| '''Tip''': If you want to archive different ''Execution Profiles'' (to compare them for example), rename the ''profinfo.pfi'' file into a new name but keep the .pfi extension. The profiler wizard detects existing Execution Profiles by checking the file extensions. }}
|
||||
{{tip|If you want to archive different ''Execution Profiles'' (to compare them for example), rename the ''profinfo.pfi'' file into a new name but keep the .pfi extension. The profiler wizard detects existing Execution Profiles by checking the file extensions. }}
|
||||
<br/>
|
||||
[[Image:profiler-wizard-second-state]] <br/>
|
||||
<br/>
|
||||
@@ -18,7 +18,7 @@ However, if you have not executed your system since the generation of the last '
|
||||
Clicking '''Next''' will lead you to the [[Select a Run-time information record to generate the Execution Profile|Third state]] if you have selected '''Generate a profile from Run-time information record'''. On the other hand if you have selected '''Use existing profile''' you will go to the [[Select the information you need and formulate your query|Final state]] .
|
||||
<br/>
|
||||
|
||||
{{seealso| '''See Also''' <br/>
|
||||
{{seealso|<br/>
|
||||
[[Profiler wizard: Introduction|How the Profiler wizard works]] <br/>
|
||||
[[Profiling|How to profile a system]] }}
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ If you have run a finalized system under the control of the profiler then select
|
||||
Clicking '''Next''' will lead you to the [[Reuse or Generate an Execution Profile|Second state]] or to the [[Select a Run-time information record to generate the Execution Profile|Third state]] depending on whether an ''Execution Profile'' has already been generated for this compilation mode or not. If no ''Execution Profile'' has been generated so far (which happens the first time you execute this wizard for a specified project in a given compilation mode) you will go to the [[Select a Run-time information record to generate the Execution Profile|Third state]] , otherwise you will go to the [[Reuse or Generate an Execution Profile|Second state]] .
|
||||
<br/>
|
||||
|
||||
{{seealso| '''See Also''' <br/>
|
||||
{{seealso|<br/>
|
||||
[[Profiler wizard: Introduction|How the profiler wizard works]] [[Profiling|How to profile a system]] }}
|
||||
|
||||
|
||||
|
||||
@@ -50,7 +50,7 @@ Each sub-query must have the following syntax 'attribute operator value' where:
|
||||
Clicking '''Next''' will open the [[Profile query window|Profile query window]] and display the results of the formulated query.
|
||||
<br/>
|
||||
|
||||
{{seealso| '''See Also''' <br/>
|
||||
{{seealso|<br/>
|
||||
[[Profiler wizard: Introduction|How the Profiler wizard works]] <br/>
|
||||
[[Profiling|How to profile a system]] }}
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ The third screen of the wizard lets you generate an ''Execution Profile'' from a
|
||||
|
||||
Then, in the combo box labeled '''Profiler used to produce the above record''', select the profiler that has been used to produce the ''Run-time information record'' you have entered. If the profiler used to execute the system does not appear in the combo box, you have to add it. See [[How to set up a Profiler Configuration File|How to set up a Profiler Configuration File]] for more details on how to do so.
|
||||
|
||||
{{note| '''Note''': ''The Run-time information record'' has to be located in the ''EIFGENs/target_name/W_code'' directory of your project. }}
|
||||
{{note|The Run-time information record'' has to be located in the ''EIFGENs/target_name/W_code'' directory of your project. }}
|
||||
|
||||
<br/>
|
||||
[[Image:profiler-wizard-third-state]] <br/>
|
||||
@@ -17,7 +17,7 @@ Clicking '''Next''' will lead you to the [[Select the information you need and f
|
||||
[[Image:profiler-wizard-rtir-error-state]] <br/>
|
||||
<br/>
|
||||
|
||||
{{seealso| '''See Also''' <br/>
|
||||
{{seealso|<br/>
|
||||
[[Profiler wizard: Introduction|How the Profiler wizard works]] <br/>
|
||||
[[Profiling|How to profile a system]] <br/>
|
||||
[[How to set up a Profiler Configuration File|How to set up a Profiler Configuration File]] }}
|
||||
|
||||
Reference in New Issue
Block a user