Commit cc8a5891 authored by Claes Sjofors's avatar Claes Sjofors

Doc, various changes

parent 9e9c70c4
......@@ -8025,19 +8025,19 @@ Helpfiles for xtt is generated with the command
The command generates a helpfile $pwrp_exe/'volumename'_xtthelp.dat, and it is proper to put
a link to the file in the xtt helpfile for the project $pwrp_exe/xtt_help.dat:
Example for the classvolume cvolvhxn2r
Example for the classvolume cvoltank
<i><topic> index
<i>...
<i>User classes<link>cvolssabtest,"",$pwrp_exe/cvolvhxn2r_xtthelp.dat
<i>User classes<link>cvoltank,"",$pwrp_exe/cvoltank_xtthelp.dat
<i></topic>
...
<i><include> $pwrp_exe/cvolssabtest_xtthelp.dat
<i><include> $pwrp_exe/cvoltank_xtthelp.dat
</topic>
<topic> class generate html
......
......@@ -624,11 +624,13 @@ Description of columns in the table
View <t>A checkbox from which you can choose to view or hide the curve.
Cursor <t>Shows the curve value where the cursor is placed.
Mark <t>Shows the curve value where the marker is placed.
Mark1 <t>Shows the curve value where the first marker is placed.
Mark2 <t>Shows the curve value where the second marker is placed.
Unit <t>Displays the unit of the curve.
Scale <t>From 'Scale' you can change the scale in y direction (Scale on
<t>the Time axis row changes in x direction).
Attribute <t>States the attribute of the trend curve.
Description <t>Description of the attribute.
<h2>Navigation
The tool panel contains buttons to zoom and move the view to the left or to the right.
......@@ -640,6 +642,53 @@ the view in x direction, and by dragging the middle button you can zoom in and o
Navigation from the keyboard is accomplished with the arrow keys. With arrow up and down
the zoom factor is changed, and arrow left and right moves the view to the left and to the
right.
<h2>Markers
There are two markers in the window that can be positioned at specific time values. The
curve value for the position is displayed in the table. The markers can be moved with
the cursor, or by clicking with MB1 (first marker) or with Ctrl+MB1 (second marker) in
the curve window.
<h2>Snapshot
For some trends it is possible to take snapshot of the current trend, in order to examine
it more carefully or save it to file. The snapshot is activated with the camera button in
the trend toolbar, and a new curve window is opened with the snapshot.
<option> printdisable
See Trend snapshot <link> opg_trend_snapshot
<option> printenable
<h2>Add curves
Curves can be added to the current trend window by selecting a DsTrendCurve object in the
runtime navigator and activating the '+' button in the toolbar.
<h2>Graph grid
When several curves are present, the graph grid is adapted to the scale of a specific
curve by clicking on the colored scale for this curve.
<h2>Export to text file
A trend can be exported to text file from File/Export in the menu. In the export dialog,
a specific attribute can be selected for export, or all attributes. To avoid overwriting
previous exported files, the filename can contain the string '$date' which will be replaces
by the current date in the actual file name.
</topic>
<topic> opg_trend_snapshot
Trend snapshot
The trend snapshot curve is a snapshot of a trend taken at a specific time.
<image> opg_fig42.png
<b>Fig Trend snapshot
A time interval can be selected in the time toolbar. When a new time intervall is
selected the 'Update curve' button is pressed to redraw the curve.
<h2>Store curve
A snapshot curve can be stored by activating File/Save in the menu.
<h2>Open stored curve
A saved snapshot curve is opened from File/Open in the menu. To open in a new window,
first activate File/New to open an empty snapshot window, and then activate File/Open in
this window.
</topic>
<topic> opg_fastcurves
......
src/doc/man/src/opg_fig31.png

30 KB | W: | H:

src/doc/man/src/opg_fig31.png

39.2 KB | W: | H:

src/doc/man/src/opg_fig31.png
src/doc/man/src/opg_fig31.png
src/doc/man/src/opg_fig31.png
src/doc/man/src/opg_fig31.png
  • 2-up
  • Swipe
  • Onion skin
src/doc/man/src/opg_fig5.png

25.8 KB | W: | H:

src/doc/man/src/opg_fig5.png

22.4 KB | W: | H:

src/doc/man/src/opg_fig5.png
src/doc/man/src/opg_fig5.png
src/doc/man/src/opg_fig5.png
src/doc/man/src/opg_fig5.png
  • 2-up
  • Swipe
  • Onion skin
......@@ -7908,19 +7908,19 @@ Hj
Kommandot genererar en hjälpfil $pwrp_exe/'volymsnamn'_xtthelp.dat som man lämpligt-vis
lägger en länk till i projektets xtt-hjälpfil $pwrp_exe/xtt_help.dat:
Exempel för klassvolymen cvolvhxn2r:
Exempel för klassvolymen cvolvhxtank:
<i><topic> index
<i>...
<i>Användar klasser<link>cvolssabtest,"",$pwrp_exe/cvolvhxn2r_xtthelp.dat
<i>Användar klasser<link>cvoltank,"",$pwrp_exe/cvoltank_xtthelp.dat
<i></topic>
...
<i><include> $pwrp_exe/cvolssabtest_xtthelp.dat
<i><include> $pwrp_exe/cvoltank_xtthelp.dat
</topic>
<topic> class generate html
......
......@@ -622,11 +622,13 @@ Beskrivning av kolumner i tabellen
View <t>En checkbox med vilken man kan välja om en kurva ska visas eller inte.
Cursor <t>Visar värdet för kurvan vid den tidpunk där cursorn är placerad.
Mark <t>Visar värdet för kurvan vid den tidpunkt där markören är placerad.
Mark1 <t>Visar värdet för kurvan vid den tidpunkt där den första markören är placerad.
Mark2 <t>Visar värdet för kurvan vid den tidpunkt där den andra markören är placerad.
Unit <t>Visar enhet för kurvan.
Scale <t>Från 'Scale' kan man ställa in skal-området i y-led (Scale för raden Time axis
<t>ställer om i x-led).
Attribute <t>Anger det attribut som trendkurvan visar.
Description <t>Beskrivning av attributet.
<h2>Navigering
Verktygspanelen innehåller knappar för att zooma in och ut, och för att flytta visningen
......@@ -638,6 +640,53 @@ genom att dra med mittenknappen, kan man zooma in eller ut.
Navigering med tangenbordet sker med pil tangenterna. Pil upp och ner ändrar zoomningsgraden
och pil vänster och höger flyttar visningen åt höger resp vänster.
<h2>Markörer
Det finns två makörer i fönstret som kan positioneras till specifika tider. Kurv-värdet
för positionen visas i tabellen. Markörerna kan flyttas med cursorn, eller genom att
klicka med MB1 (första markören) eller Ctrl+MB1 (andra markören) i kurv-fönstret.
<h2>Snapshot
För vissa trend-kurvor är det möjligt att ta en ögonblicksbild av trenden för att
undersökan den nogrannare eller spara den till fil. Ögonblicksbilden aktiveras med
kamera-knappen in verktygspanelen, då ett nytt fönster med ögonblicksbilden visas.
<option> printdisable
See Trend ögonblicksbild <link> opg_trend_snapshot
<option> printenable
<h2>Addera kurvor
Flera kurvor kan adderas till trendfönstret genom att välja ut ett DsTrendCurve objekt
i runtime-navigatören och aktivera '+'-knappen i verktygspanelen.
<h2>Rutnät
När flera kurvor visas kan rutnätet anpassas till skalan för en specifik kurva genom
att klicka på den färgade skalan för kurvan.
<h2>Exportera till text-fil
En trend kan exporteras till text-fil från Arkiv/Exportera i menyn. I export dialogen kan
ett specifikt attribut väljas för exportering, eller alla attribut. För att undvika att
skriva över tidigare exporterade filer kan filnamnet innehålla strängen '$date' som
kommer att ersättas med aktuell tid i det verkliga filnamnet.
</topic>
<topic> opg_trend_snapshot
Trend ögonblicksbild
Trend ögonblicksbilden är ett snapshot av trendkurvan tagen vid en specifik tillfälle.
<image> opg_fig42.png
<b>Fig Trend snapshot
Ett tidsintervall kan väljas i verktygspanelen för tider. När ett intervall har
valts trycks på knappen 'Uppdatera kurva' för att rita om kurvan.
<h2>Spara kurva
En snapshot-kurva kan lagra genom att aktivera Arkiv/Spara i menyn.
<h2>Öppna sparad kurva
En sparad snapshot kurva öppnas från Arkiv/Öppna i menyn. För att öppna i ett nytt
fönster aktiveras Arkiv/Ny för att öppna ett tomt snapshot fönster, och sedan
Arkiv/Öppna i detta fönster.
</topic>
<topic> opg_fastcurves
......
......@@ -1779,7 +1779,7 @@ gdh_GetNextObjectAttrRef (
* @brief Return the objid of the node object for a node identified by a
* node identifier (of type pwr_tNodeId).
*
* If the node idenetity is specified as zero,
* If the node identity is specified as zero,
* the node object for the local node is returned.
* @return pwr_tStatus
*/
......
......@@ -41,6 +41,10 @@ SObject pwrb:Class
! @Group Supervision,NodeConfiguration
! @Summary System supervisory
! System Supervisory.
! SystemSup objects are used by the event monitor to send
! system events and alarms to outunits.
! All SystemSup objects are placed in the SystemEvent array
! in the MessageHandler object.
!
! @b See Also
! @classlink MessageHandler pwrb_messagehandler.html
......
......@@ -43,7 +43,7 @@ SObject pwrb:Class
! Help text in plc document.
!
! Makes it possible to insert a text that also will be available as
! an help text and has html pages.
! an help text and as html pages.
!
! The help text can be opened from
! - help entry in the PlcPgm popup menu.
......@@ -51,13 +51,18 @@ SObject pwrb:Class
!
! Some help text tags can be used. h1, h2 and b should be placed in
! the first position of the row.
! <h1> Large header
! <h2> Header
! <b> Bold text
! <image> Display a gif or png image. The image is displayed
! in the help viewer, but not it the plc document.
! <link> Link to another help topic. The link will work in the help
! viewer, but not in the plc document.
! @i <h1> Large header
! @i <h2> Header
! @i <b> Bold text
! @i <image> Display a gif or png image. The image is displayed
! in the help viewer, but not it the plc document.
! @i <link> Link to another help topic. The link will work in the help
! viewer, but not in the plc document.
! Links to other plc windows can be made through the generated
! topic for the window which is 'plcw_' + the object identity for
! the window object, eg
!
! @i See subwindow <link>plcw_000_001_001_024_000037ed
!
! The maximum size for the text is 1023 characters. For larger texts
! se HelpTextL.
......
......@@ -253,6 +253,11 @@ SObject pwrb:Class
Attr TypeRef = "pwrs:Type-$Boolean"
EndBody
EndObject
!/**
! Alarms and events emitted by the system.
! An array of supervisory objects that is triggered by various
! system events or errors.
!*/
Object SystemEvents $Attribute 22
Body SysBody
Attr TypeRef = "pwrb:Class-SystemSup"
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment