Public Member Functions

ACS::Monitorlong Interface Reference

import "baci.idl";

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

List of all members.

Public Member Functions

void set_value_trigger (in long delta, in boolean enable)
void get_value_trigger (out long delta, out boolean enable)
void set_value_percent_trigger (in double delta, in boolean enable)
void get_value_percent_trigger (out double delta, out boolean enable)

Detailed Description

The Monitor for Properties that have value of type long or longSeq. On creation, the only trigger present will be the timer trigger. Calling the set_value_trigger method determines the behaviour of the value trigger. The enable parameter determines whether the value trigger is active or not . Value 0 assigned to delta trigger means that a notification should be sent on every change of the monitored value. Invalid values (out-of-limits) are treated as valid extremes (a delta trigger below the min_delta_trigger found in the ACS CDB is treated as min_delta_trigger).

Todo:
There should be a seperate MonitorlongSeq interface.

Member Function Documentation

void ACS::Monitorlong::get_value_percent_trigger ( out double  delta,
out boolean  enable 
)

Returns the current on-change delta percentage value and a boolean value which tells whether on-change monitors are being utilized.

Parameters:
delta Current on-change delta percentage value
enable Boolean value which tells whether on-change monitors are being utilized. 3AC90A25005A

void ACS::Monitorlong::get_value_trigger ( out long  delta,
out boolean  enable 
)

Returns the current on-change delta value and a boolean value which tells whether on-change monitors are being utilized.

Parameters:
delta Current on-change delta value
enable Boolean value which tells whether on-change monitors are being utilized. 3AC90A250078

void ACS::Monitorlong::set_value_percent_trigger ( in double  delta,
in boolean  enable 
)

set_value_percent_trigger is a method used to enable or disable percentual on-change monitors. When enabled,the monitor * is triggered by one of two conditions: 1. If an amount of time equivalent to the value returned by the get_timer_trigger method has passed, the callback will be invoked. 2. If the value we're interested in changes by a percentage delta at some point in time inbetween T0 and T1 (where T1-T0==get_timer_trigger()), the callback is invoked.

Parameters:
delta For a description of what this does, see 2.
enable A value of true enables on-change monitors and false disables them. 3AC90A250057

void ACS::Monitorlong::set_value_trigger ( in long  delta,
in boolean  enable 
)

set_value_trigger is a method used to enable or disable on-change monitors. When enabled,the monitor is triggered by one of two conditions: 1. If an amount of time equivalent to the value returned by the get_timer_trigger method has passed, the callback will be invoked. 2. If the value we're interested in changes by delta at some point in time inbetween T0 and T1 (where T1-T0==get_timer_trigger()), the callback is invoked.

Parameters:
delta For a description of what this does, see 2.
enable A value of true enables on-change monitors and false disables them. 3AC90A250075


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