Value< ObserverType extends ValueChangedCallback > Interface Template Reference

Inheritance diagram for Value< ObserverType extends ValueChangedCallback >:

Public Member Functions
void	markInterested ()
void	addValueObserver (ObserverType callback)
Public Member Functions inherited from Subscribable
boolean	isSubscribed ()
void	setIsSubscribed (boolean value)
void	subscribe ()
void	unsubscribe ()

Detailed Description

The common interface that is shared by all value objects in the controller API.

Since

API version 1

Definition at line 10 of file Value.java.

Member Function Documentation

void addValueObserver

(

ObserverType

callback

)

Registers an observer that reports the current value.

Parameters

callback

a callback function that receives a single parameter

Since

API version 1

void markInterested

(

)

Marks this value as being of interest to the driver. This can only be called once during the driver's init method. A value that is of interest to the driver can be obtained using the value's get method. If a value has not been marked as interested then an error will be reported if the driver attempts to get the current value. Adding an observer to a value will automatically mark this value as interested.

Since

API version 2

---

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

• Value.java