Public Member Functions | Public Attributes

ACS::Monitor Interface Reference

import "baci.idl";

Inheritance diagram for ACS::Monitor:
Inheritance graph
[legend]
Collaboration diagram for ACS::Monitor:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void set_timer_trigger (in TimeInterval timer)
void get_timer_trigger (out TimeInterval timer)

Public Attributes

readonly attribute Time start_time

Detailed Description

The monitor interface through which the client can control the flow of monitoring notifications. Monitors are created in Properties via the create_monitor and create_postponed_monitor methods. This interface is considered to be abstract as it cannot be used directly.


Member Function Documentation

void ACS::Monitor::get_timer_trigger ( out TimeInterval  timer  ) 

Returns the current TimeInterval between two consecutive monitor callbacks.

Parameters:
timer The duration of time between two consecutive monitor callbacks. 3AC90A250031

void ACS::Monitor::set_timer_trigger ( in TimeInterval  timer  ) 

Sets the requested delta time between two consecutive monitor callbacks. Note that the TimInterval timer is the minimal time, as real-time performance can not be guaranteed.

The TimeInterval is related to the monitor, not to the property, i.e. two clients can request monitors at different rates. Timer trigger can be disabled by passing the value 0 for timer parameter. Invalid values (out-of-limits) are treated as valid extremes (a time interval out-of-limits defined by the server is interpreted as maximum allowed time interval).

Parameters:
timer Duration of time between two consecutive monitor triggers. A value of 0 turns the monitor off. 3AC90A25002F


Member Data Documentation

readonly attribute Time ACS::Monitor::start_time

Returns the absolute time when the first monitor callback will occur for normal monitors.


The documentation for this interface was generated from the following file: