5.5.4. GUIPoll component

The GUIPoll component is a precompiled component that provides a periodic signal that can be used to drive a GUI refresh in a visualization component. It is intended to be used as a subcomponent inside of a LISA-based visualization component.

You can configure the period at which the GUIPoll component runs in milliseconds of real time, not simulation time. The component produces a gui_callback() signal at approximately this period, even when the simulation is paused.

You must implement the slave side of the gui_callback() signal in a LISA-based visualization component. Use this event to invoke the Visualisation::poll() method to keep the GUI updated.

Figure 5.73 shows a view of the component in System Canvas.

Figure 5.73. GUIPoll in System Canvas

GUIPoll in System Canvas

This component is written in LISA+.

Ports

The GUIPoll component generates signals on the port in Table 5.141.

Table 5.141. GUIPoll component ports

NamePort protocolTypeDescription
gui_callbackGUIPollCallbackMasterThis port is used to send callback requests to the visualization component

Additional protocols

The GUIPoll component has one additional protocol.

GUIPollCallback

This protocol defines a single method that is used to signal to the visualization component that the requested update period has elapsed. You can invoke this callback even when the simulation is stopped. The behavior of the protocol is:

gui_callback() : void

This is sent by the GUIPoll component, at the configured period.

Parameters

Table 5.142 provides a description of the configuration parameters for the GUIPoll component.

Table 5.142. GUIPoll configuration parameters

Parameter nameDescriptionTypeAllowed valueDefault value
delay_msDetermines the period, in milliseconds of real-time, between gui_callback() callsInteger-20

Registers

The GUIPoll component has no registers.

Debug features

The GUIPoll component has no debug features.

Verification and testing

The GUIPoll component has been tested as part of the PhoneSkin example platform, confirming that the GUI continues to be refreshed even when the simulation is stopped.

Performance

The GUIPoll component is not expected to significantly affect the performance of a PV system.

Library dependencies

The GUIPoll component has no dependencies on external libraries.

Copyright © 2008-2013 ARM. All rights reserved.ARM DUI 0423O
Non-ConfidentialID060613