org.openbase.bco.dal.remote.unit

Class Units

java.lang.Object

org.openbase.bco.dal.remote.unit.Units

public class Units
extends Object

Author:

Divine Threepwood

Field Summary

Fields

Modifier and Type	Field and Description
static Units	instance

Constructor Summary

Constructors

Constructor and Description
Units()

Method Summary

Modifier and Type	Method and Description
static LightRemote	getLightUnit(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig, boolean waitForData)
static UnitRemote	getUnit(String unitId, boolean waitForData) Method establishes a connection to the unit referred by the given unit identifier.
static <UR extends UnitRemote> UR	getUnit(String unitId, boolean waitForData, Class<UR> unitRemoteClass) This method is a wrapper for getUnit(String, boolean) and casts the result to the given unitRemoteClass.
static UnitRemote	getUnit(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig, boolean waitForData) Method establishes a connection to the unit referred by the given unit identifier.
static <UR extends UnitRemote> UR	getUnit(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig, boolean waitForData, Class<UR> unitRemoteClass) This method is a wrapper for getUnit(UnitConfig, boolean) and casts the result to the given unitRemoteClass.
static UnitRemote	getUnitByLabel(String label, boolean waitForData) Method establishes a connection to the unit referred by the given unit label.
UnitRemote	getUnitByLabelAndLocationScope(String label, String locationScope, boolean waitForData) Method establishes a connection to the unit referred by the given unit label and location scope.
static UnitRemote	getUnitByScope(rsb.Scope scope, boolean waitForData) Method establishes a connection to the unit referred by the given unit scope.
static UnitRemote	getUnitByScope(rst.rsb.ScopeType.Scope scope, boolean waitForData) Method establishes a connection to the unit referred by the given unit scope.
static UnitRemote	getUnitByScope(String scope, boolean waitForData) Method establishes a connection to the unit referred by the given unit scope.
static org.openbase.bco.registry.unit.lib.UnitRegistry	getUnitRegistry() Method returns an instance of the unit registry.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

instance

public static Units instance

Constructor Detail

Units

public Units()

Method Detail

getUnitRegistry

public static org.openbase.bco.registry.unit.lib.UnitRegistry getUnitRegistry()
                                                                       throws InterruptedException,
                                                                              org.openbase.jul.exception.CouldNotPerformException

Method returns an instance of the unit registry. If this method is called for the first time, a new registry instance will be created. This method only returns if the unit registry synchronization is finished otherwise this method blocks forever. In case you won't wait for the synchronization, request your own instance by calling: Registries.getUnitRegistry();

Returns:

the unit registry instance.

Throws:

InterruptedException - is thrown if the current thread was externally interrupted.

org.openbase.jul.exception.CouldNotPerformException - Is thrown in case an error occurs during registry connection.

getUnit

public static UnitRemote getUnit(String unitId,
                                 boolean waitForData)
                          throws org.openbase.jul.exception.NotAvailableException,
                                 InterruptedException

Method establishes a connection to the unit referred by the given unit identifier. The returned unit remote object is fully synchronized with the unit controller and all states locally cached. Use the waitForData flag to block the current thread until the unit remote is fully synchronized with the unit controller during the startup phase. This synchronization is just done once and the current thread will not block if the unit remote was already synchronized before. To force a resynchronization call Remote.requestData() on the remote instance. Please avoid polling unit states! If you want to get informed about unit config or unit data state changes, please register new config or data observer on this remote instance.

Parameters:

unitId - the unit identifier.

waitForData - if this flag is set to true the current thread will block until the unit remote is fully synchronized with the unit controller.

Returns:

a new or cached unit remote which can be used to control the unit or request all current unit states.

Throws:

org.openbase.jul.exception.NotAvailableException - is thrown in case the unit is not available.

InterruptedException - is thrown in case the thread is externally interrupted

getUnit

public static UnitRemote getUnit(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig,
                                 boolean waitForData)
                          throws org.openbase.jul.exception.NotAvailableException,
                                 InterruptedException

Method establishes a connection to the unit referred by the given unit identifier. The returned unit remote object is fully synchronized with the unit controller and all states locally cached. Use the waitForData flag to block the current thread until the unit remote is fully synchronized with the unit controller during the startup phase. This synchronization is just done once and the current thread will not block if the unit remote was already synchronized before. To force a resynchronization call Remote.requestData() on the remote instance. Please avoid polling unit states! If you want to get informed about unit config or unit data state changes, please register new config or data observer on this remote instance.

Parameters:

unitConfig - the unit configuration.

waitForData - if this flag is set to true the current thread will block until the unit remote is fully synchronized with the unit controller.

Returns:

a new or cached unit remote which can be used to control the unit or request all current unit states.

Throws:

org.openbase.jul.exception.NotAvailableException - is thrown in case the unit is not available.

InterruptedException - is thrown in case the thread is externally interrupted

getUnit

public static <UR extends UnitRemote> UR getUnit(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig,
                                                 boolean waitForData,
                                                 Class<UR> unitRemoteClass)
                                          throws org.openbase.jul.exception.NotAvailableException,
                                                 InterruptedException

This method is a wrapper for getUnit(UnitConfig, boolean) and casts the result to the given unitRemoteClass.

Type Parameters:

UR - the unit remote class type.

Parameters:

unitConfig - Checkout wrapped method doc getUnit(UnitConfig, boolean)

waitForData - Checkout wrapped method doc getUnit(UnitConfig, boolean)

unitRemoteClass - the unit remote class.

Returns:

an instance of the given remote class.

Throws:

org.openbase.jul.exception.NotAvailableException - Is thrown if the remote instance is not compatible with the given class. See {getUnit(UnitConfig, boolean) for further cases.

InterruptedException - Checkout wrapped method doc getUnit(UnitConfig, boolean)

See Also:

getUnit(rst.domotic.unit.UnitConfigType.UnitConfig, boolean)

getUnit

public static <UR extends UnitRemote> UR getUnit(String unitId,
                                                 boolean waitForData,
                                                 Class<UR> unitRemoteClass)
                                          throws org.openbase.jul.exception.NotAvailableException,
                                                 InterruptedException

This method is a wrapper for getUnit(String, boolean) and casts the result to the given unitRemoteClass.

Type Parameters:

UR - the unit remote class type.

Parameters:

unitId - Checkout wrapped method doc getUnit(String, boolean)

waitForData - Checkout wrapped method doc getUnit(String, boolean)

unitRemoteClass - the unit remote class.

Returns:

an instance of the given remote class.

Throws:

org.openbase.jul.exception.NotAvailableException - Is thrown if the remote instance is not compatible with the given class. See getUnit(String, boolean) for further cases.

InterruptedException - Checkout wrapped method doc getUnit(String, boolean)

See Also:

getUnit(java.lang.String, boolean)

getUnitByLabel

public static UnitRemote getUnitByLabel(String label,
                                        boolean waitForData)
                                 throws org.openbase.jul.exception.NotAvailableException,
                                        InterruptedException

Method establishes a connection to the unit referred by the given unit label. The returned unit remote object is fully synchronized with the unit controller and all states locally cached. Use the waitForData flag to block the current thread until the unit remote is fully synchronized with the unit controller during the startup phase. This synchronization is just done once and the current thread will not block if the unit remote was already synchronized before. To force a resynchronization call Remote.requestData() on the remote instance. Please avoid polling unit states! If you want to get informed about unit config or unit data state changes, please register new config or data observer on this remote instance.

Parameters:

label - the label to identify the unit.

waitForData - if this flag is set to true the current thread will block until the unit remote is fully synchronized with the unit controller.

Returns:

a new or cached unit remote which can be used to control the unit or request all current unit states.

Throws:

org.openbase.jul.exception.NotAvailableException - is thrown in case the unit is not available or the label is not unique enough to identify the unit.

InterruptedException - is thrown in case the thread is externally interrupted.

getUnitByScope

public static UnitRemote getUnitByScope(rst.rsb.ScopeType.Scope scope,
                                        boolean waitForData)
                                 throws org.openbase.jul.exception.NotAvailableException,
                                        InterruptedException

Method establishes a connection to the unit referred by the given unit scope. The returned unit remote object is fully synchronized with the unit controller and all states locally cached. Use the waitForData flag to block the current thread until the unit remote is fully synchronized with the unit controller during the startup phase. This synchronization is just done once and the current thread will not block if the unit remote was already synchronized before. To force a resynchronization call Remote.requestData() on the remote instance. Please avoid polling unit states! If you want to get informed about unit config or unit data state changes, please register new config or data observer on this remote instance.

Parameters:

scope - the scope to identify the unit.

waitForData - if this flag is set to true the current thread will block until the unit remote is fully synchronized with the unit controller.

Returns:

a new or cached unit remote which can be used to control the unit or request all current unit states.

Throws:

org.openbase.jul.exception.NotAvailableException - is thrown in case the unit is not available or the label is not unique enough to identify the unit.

InterruptedException - is thrown in case the thread is externally interrupted.

getUnitByScope

public static UnitRemote getUnitByScope(rsb.Scope scope,
                                        boolean waitForData)
                                 throws org.openbase.jul.exception.NotAvailableException,
                                        InterruptedException

Method establishes a connection to the unit referred by the given unit scope. The returned unit remote object is fully synchronized with the unit controller and all states locally cached. Use the waitForData flag to block the current thread until the unit remote is fully synchronized with the unit controller during the startup phase. This synchronization is just done once and the current thread will not block if the unit remote was already synchronized before. To force a resynchronization call Remote.requestData() on the remote instance. Please avoid polling unit states! If you want to get informed about unit config or unit data state changes, please register new config or data observer on this remote instance.

Parameters:

scope - the scope to identify the unit.

waitForData - if this flag is set to true the current thread will block until the unit remote is fully synchronized with the unit controller.

Returns:

a new or cached unit remote which can be used to control the unit or request all current unit states.

Throws:

org.openbase.jul.exception.NotAvailableException - is thrown in case the unit is not available or the label is not unique enough to identify the unit.

InterruptedException - is thrown in case the thread is externally interrupted.

getUnitByScope

public static UnitRemote getUnitByScope(String scope,
                                        boolean waitForData)
                                 throws org.openbase.jul.exception.NotAvailableException,
                                        InterruptedException

Method establishes a connection to the unit referred by the given unit scope. The returned unit remote object is fully synchronized with the unit controller and all states locally cached. Use the waitForData flag to block the current thread until the unit remote is fully synchronized with the unit controller during the startup phase. This synchronization is just done once and the current thread will not block if the unit remote was already synchronized before. To force a resynchronization call Remote.requestData() on the remote instance. Please avoid polling unit states! If you want to get informed about unit config or unit data state changes, please register new config or data observer on this remote instance.

Parameters:

scope - the scope to identify the unit.

waitForData - if this flag is set to true the current thread will block until the unit remote is fully synchronized with the unit controller.

Returns:

a new or cached unit remote which can be used to control the unit or request all current unit states.

Throws:

org.openbase.jul.exception.NotAvailableException - is thrown in case the unit is not available or the label is not unique enough to identify the unit.

InterruptedException - is thrown in case the thread is externally interrupted.

getUnitByLabelAndLocationScope

public UnitRemote getUnitByLabelAndLocationScope(String label,
                                                 String locationScope,
                                                 boolean waitForData)
                                          throws org.openbase.jul.exception.NotAvailableException,
                                                 InterruptedException

Method establishes a connection to the unit referred by the given unit label and location scope. The returned unit remote object is fully synchronized with the unit controller and all states locally cached. Use the waitForData flag to block the current thread until the unit remote is fully synchronized with the unit controller during the startup phase. This synchronization is just done once and the current thread will not block if the unit remote was already synchronized before. To force a resynchronization call Remote.requestData() on the remote instance. Please avoid polling unit states! If you want to get informed about unit config or unit data state changes, please register new config or data observer on this remote instance.

Parameters:

label - the label to identify the unit.

locationScope - the location scope to identify the unit.

waitForData - if this flag is set to true the current thread will block until the unit remote is fully synchronized with the unit controller.

Returns:

a new or cached unit remote which can be used to control the unit or request all current unit states.

Throws:

org.openbase.jul.exception.NotAvailableException - is thrown in case the unit is not available or the label is not unique enough to identify the unit.

InterruptedException - is thrown in case the thread is externally interrupted.

getLightUnit

public static LightRemote getLightUnit(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig,
                                       boolean waitForData)
                                throws org.openbase.jul.exception.NotAvailableException,
                                       InterruptedException

Throws:

org.openbase.jul.exception.NotAvailableException

InterruptedException