{"id":411,"date":"2007-06-24T14:59:04","date_gmt":"2007-06-24T14:59:04","guid":{"rendered":"http:\/\/www.amibroker.org\/userkb\/2007\/06\/24\/a-real-time-message-fifo\/"},"modified":"2007-10-17T23:13:54","modified_gmt":"2007-10-17T23:13:54","slug":"a-real-time-message-fifo","status":"publish","type":"post","link":"http:\/\/www.amibroker.org\/editable_userkb\/2007\/06\/24\/a-real-time-message-fifo\/","title":{"rendered":"A Real-Time Message FIFO"},"content":{"rendered":"

Real-time messages often appear on your screen only for the duration of a single chart-refresh interval and disappear before you have time to read them. The FIFO (First In First Out) n-line display presented here captures and scrolls messages in the chart Title so that they are easier to read. Logging messages to DebugView or the Interpretation window would require opening additional windows. Using the Title instead displays the messages right on the chart and is more space-efficient.<\/p>\n

A typical application would be to display real-time system status, such as order status, TWS error messages, partial fills, account balance, profits, etc.<\/p>\n

Since the chart Title does not support formatting, it is advisable to use a mono-spaced font, such as Lucida Console, and pad spaces to create columns. The integer part of the NumToStr() formatting parameter sets the overall length of the returned string and can be used to format columns. If you prefer more font and color options, you can use Gfx functions to display the messages.<\/p>\n

To prevent Title wrapping, you can truncate messages using the StrLeft() function. This works well for TWS error messages that can be long but carry the important info at the left of the error message. The demo below uses a simple PadString() function to space short messages in columns.<\/p>\n

The AddToFIFOTitle() function is called whenever you want to add a message to the table. Its first argument is the name of the static variable that contains the table, the second argument is the message you want to add to the table, and the third is the maximum number of lines in the table. Setting the third argument to zero clears the table.<\/p>\n

To keep things simple, the code below uses Param functions to simulate real-time messages; in a real system, these messages would be generated by real-time events. To test the code, click any of the numbered Event Messages<\/em> in the Parameter window.<\/p>\n

\"clip_image002\"<\/a><\/p>\n

The Title produced should look like this:<\/p>\n

\"clip_image004\"<\/a><\/p>\n

Note that messages in this example are padded to position the next column properly. The order of the messages is inverted to allow the last message to appear at the top of the message table. Whenever the maximum number of lines is exceeded, the oldest message is removed. To ensure that the table is updated at least once a second you should always include a RequestTimedRefresh(1) in your code.<\/p>\n

Finally, in Automated Trading you don’t always need charts, and you may prefer to display only a status table. Since the table is stored in a global Static Variable, you can read the table from any pane or window using just two lines of code:<\/p>\n

RequestTimedRefresh<\/span>( <\/span>1 <\/span>);\r<\/span>Title <\/span>= <\/span>"\\n"<\/span>+<\/span>StaticVarGetText<\/span>(<\/span>"FIFOTitle"<\/span>);<\/span><\/pre>\n
If you use several scrolling displays in different panes, you should key the Static Variables as explained in Keying Static Variables<\/a>. The complete demo code follows:<\/p>\n
<\/span>function <\/span>padString<\/span>( <\/span>String<\/span>, <\/span>ColWidth <\/span>)\r{\r<\/span>SpaceFill <\/span>= <\/span>" "<\/span>;\rif( <\/span>String <\/span>== <\/span>"{EMPTY}" <\/span>) <\/span>String <\/span>= <\/span>""<\/span>;\r<\/span>SL <\/span>= <\/span>StrLen<\/span>(String);\r<\/span>NS <\/span>= <\/span>StrLeft<\/span>(<\/span>SpaceFill<\/span>, <\/span>ColWidth<\/span>-<\/span>SL<\/span>);\rreturn <\/span>string<\/span>+<\/span>NS<\/span>;\r}\r\rfunction <\/span>AddToFIFOTitle<\/span>( <\/span>StrName<\/span>, <\/span>Str<\/span>, <\/span>MaxItems <\/span>)\r{\r<\/span>\/\/ Add New item\r<\/span>NewString <\/span>= <\/span>""<\/span>;\r<\/span>PrevStr <\/span>= <\/span>StaticVarGetText<\/span>( <\/span>StrName <\/span>);\r<\/span>ItemCount <\/span>= <\/span>Nz<\/span>(<\/span>StaticVarGet<\/span>(<\/span>"NumberItems"<\/span>));\rif( <\/span>MaxItems <\/span>== <\/span>0 <\/span>)\r{\r<\/span>StaticVarSetText<\/span>(<\/span>StrName<\/span>, <\/span>""<\/span>);\r<\/span>StaticVarSet<\/span>(<\/span>"NumberItems"<\/span>,<\/span>0<\/span>);\r<\/span>S1 <\/span>= <\/span>""<\/span>;\r}\relse if( <\/span>Str <\/span>!= <\/span>"" <\/span>)\r{\r<\/span>StaticVarSet<\/span>(<\/span>"NumberItems"<\/span>,++<\/span>ItemCount<\/span>);\r<\/span>NewTitle <\/span>= <\/span>NumToStr<\/span>(<\/span>ItemCount<\/span>,<\/span>3.0<\/span>,<\/span>False<\/span>)+<\/span>". "<\/span>+<\/span>Str <\/span>+ <\/span>"\\n"<\/span>+ <\/span>PrevStr<\/span>;\rfor(<\/span>s<\/span>=<\/span>0<\/span>, <\/span>n<\/span>=<\/span>0<\/span>, <\/span>S1<\/span>=<\/span>""<\/span>; ( <\/span>s2<\/span>=<\/span>StrMid<\/span>(<\/span>NewTitle<\/span>,<\/span>s<\/span>,<\/span>1<\/span>) ) != <\/span>"" <\/span>AND <\/span>n <\/span>&<\/span>lt<\/span>; <\/span>MaxItems<\/span>; <\/span>s<\/span>++ )\r{\r<\/span>S1 <\/span>= <\/span>S1 <\/span>+ <\/span>S2<\/span>;\rif( <\/span>S2<\/span>==<\/span>"\\n" <\/span>) <\/span>n<\/span>++;\r}\r}\relse <\/span>S1 <\/span>= <\/span>PrevStr<\/span>; <\/span>\/\/ come here when Str == \"\"\r<\/span>StaticVarSetText<\/span>(<\/span>StrName<\/span>, <\/span>S1<\/span>);\rreturn <\/span>StaticVarGetText<\/span>(<\/span>StrName<\/span>);\r}\r\r<\/span>RequestTimedRefresh<\/span>( <\/span>1 <\/span>);\r<\/span>\/\/ Simulate Transient (Trigger) Events\r<\/span>Event1 <\/span>= <\/span>ParamTrigger<\/span>(<\/span>"Event Message 1"<\/span>, <\/span>"EVENT1"<\/span>);\r<\/span>Event2 <\/span>= <\/span>ParamTrigger<\/span>(<\/span>"Event Message 2"<\/span>, <\/span>"EVENT2"<\/span>);\r<\/span>\/\/ Simulate State events and convert to triggers\r<\/span>PrevEvent3 <\/span>= <\/span>Nz<\/span>(<\/span>StaticVarGet<\/span>(<\/span>"Event3"<\/span>) );\r<\/span>Event3 <\/span>= <\/span>ParamToggle<\/span>(<\/span>"Event Message 3"<\/span>, <\/span>"EVENT3OFF|EVENT3ON"<\/span>,<\/span>0<\/span>);\r<\/span>StaticVarSet<\/span>(<\/span>"Event3"<\/span>,<\/span>Event3<\/span>);\r<\/span>Event3Trigger <\/span>= <\/span>Event3 <\/span>!= <\/span>PrevEvent3<\/span>;\r<\/span>PrevEvent4 <\/span>= <\/span>Nz<\/span>(<\/span>StaticVarGet<\/span>(<\/span>"Event4"<\/span>) );\r<\/span>Event4 <\/span>= <\/span>ParamToggle<\/span>(<\/span>"Event Message 4"<\/span>, <\/span>"EVENT4OFF|EVENT4ON"<\/span>,<\/span>0<\/span>);\r<\/span>StaticVarSet<\/span>(<\/span>"Event4"<\/span>,<\/span>Event4<\/span>);\r<\/span>Event4Trigger <\/span>= <\/span>Event4 <\/span>!= <\/span>PrevEvent4 <\/span>;\r<\/span>MaxEvents <\/span>= <\/span>Param<\/span>(<\/span>"Max. Number Events"<\/span>,<\/span>5<\/span>,<\/span>0<\/span>,<\/span>20<\/span>,<\/span>1<\/span>);\rif( <\/span>Event1 <\/span>)\r{\r<\/span>Msg1 <\/span>= <\/span>PadString<\/span>( <\/span>"EVENT1 MSG"<\/span>, <\/span>15<\/span>)+<\/span>Now<\/span>(<\/span>2<\/span>);\r<\/span>AddToFIFOTitle<\/span>( <\/span>"FIFOTitle"<\/span>, <\/span>MSG1<\/span>, <\/span>MaxEvents <\/span>);\r}\rif( <\/span>Event2 <\/span>)\r{\r<\/span>Msg2 <\/span>= <\/span>PadString<\/span>( <\/span>"EVENT2 MSG"<\/span>, <\/span>15<\/span>)+<\/span>Now<\/span>(<\/span>2<\/span>);\r<\/span>AddToFIFOTitle<\/span>( <\/span>"FIFOTitle"<\/span>, <\/span>Msg2<\/span>, <\/span>MaxEvents <\/span>);\r}\rif( <\/span>Event3Trigger <\/span>)\r{\r<\/span>Msg3 <\/span>= <\/span>PadString<\/span>( <\/span>WriteIf<\/span>(<\/span>Event3<\/span>,<\/span>"E3-ON MSG"<\/span>,<\/span>"E3-OFF MSG"<\/span>), <\/span>15<\/span>)+<\/span>Now<\/span>(<\/span>2<\/span>);\r<\/span>AddToFIFOTitle<\/span>( <\/span>"FIFOTitle"<\/span>, <\/span>Msg3<\/span>, <\/span>MaxEvents <\/span>);\r}\rif( <\/span>Event4Trigger <\/span>)\r{\r<\/span>Msg4 <\/span>= <\/span>PadString<\/span>(<\/span>WriteIf<\/span>(<\/span>Event4<\/span>,<\/span>"EVENT4-ON MSG"<\/span>,<\/span>"EVENT4-OFF MSG"<\/span>), <\/span>15<\/span>)+<\/span>Now<\/span>(<\/span>2<\/span>);\r<\/span>AddToFIFOTitle<\/span>( <\/span>"FIFOTitle"<\/span>, <\/span>Msg4<\/span>, <\/span>MaxEvents <\/span>);\r}\r<\/span>Title <\/span>= <\/span>"\\nFIFOTitle Demo\\n\\n"<\/span>+<\/span>AddToFIFOTitle<\/span>( <\/span>"FIFOTitle"<\/span>, <\/span>""<\/span>, <\/span>MaxEvents<\/span>);<\/span><\/pre>\n
Edited by Al Venosa<\/p>\n","protected":false},"excerpt":{"rendered":"
Real-time messages often appear on your screen only for the duration of a single chart-refresh interval and disappear before you have time to read them. The FIFO (First In First Out) n-line display presented here captures and scrolls messages in the chart Title so that they are easier to read. Logging messages to DebugView or […]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[64],"tags":[],"_links":{"self":[{"href":"http:\/\/www.amibroker.org\/editable_userkb\/wp-json\/wp\/v2\/posts\/411"}],"collection":[{"href":"http:\/\/www.amibroker.org\/editable_userkb\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/www.amibroker.org\/editable_userkb\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/www.amibroker.org\/editable_userkb\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"http:\/\/www.amibroker.org\/editable_userkb\/wp-json\/wp\/v2\/comments?post=411"}],"version-history":[{"count":0,"href":"http:\/\/www.amibroker.org\/editable_userkb\/wp-json\/wp\/v2\/posts\/411\/revisions"}],"wp:attachment":[{"href":"http:\/\/www.amibroker.org\/editable_userkb\/wp-json\/wp\/v2\/media?parent=411"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/www.amibroker.org\/editable_userkb\/wp-json\/wp\/v2\/categories?post=411"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/www.amibroker.org\/editable_userkb\/wp-json\/wp\/v2\/tags?post=411"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}