org.openbase.bco.dal.remote.detector

Class PresenceDetector

java.lang.Object

org.openbase.bco.dal.remote.detector.PresenceDetector

All Implemented Interfaces:

org.openbase.jul.iface.Activatable, org.openbase.jul.iface.Initializable<org.openbase.jul.pattern.provider.DataProvider<rst.domotic.unit.location.LocationDataType.LocationData>>, org.openbase.jul.iface.Manageable<org.openbase.jul.pattern.provider.DataProvider<rst.domotic.unit.location.LocationDataType.LocationData>>, org.openbase.jul.iface.Shutdownable, org.openbase.jul.pattern.provider.DataProvider<rst.domotic.state.PresenceStateType.PresenceState>

public class PresenceDetector
extends Object
implements org.openbase.jul.iface.Manageable<org.openbase.jul.pattern.provider.DataProvider<rst.domotic.unit.location.LocationDataType.LocationData>>, org.openbase.jul.pattern.provider.DataProvider<rst.domotic.state.PresenceStateType.PresenceState>

Author:

Divine Threepwood

Nested Class Summary

Nested classes/interfaces inherited from interface org.openbase.jul.iface.Shutdownable

org.openbase.jul.iface.Shutdownable.ShutdownDeamon

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger
static long	PRESENCE_TIMEOUT Default 3 minute window of no movement unit the state switches to NO_MOTION.

Constructor Summary

Constructors

Constructor and Description
PresenceDetector()

Method Summary

Modifier and Type	Method and Description
void	activate()
void	addDataObserver(org.openbase.jul.pattern.Observer<rst.domotic.state.PresenceStateType.PresenceState> observer)
void	deactivate()
rst.domotic.state.PresenceStateType.PresenceState	getData()
Class<rst.domotic.state.PresenceStateType.PresenceState>	getDataClass()
CompletableFuture<rst.domotic.state.PresenceStateType.PresenceState>	getDataFuture()
void	init(org.openbase.jul.pattern.provider.DataProvider<rst.domotic.unit.location.LocationDataType.LocationData> locationDataProvider)
void	init(org.openbase.jul.pattern.provider.DataProvider<rst.domotic.unit.location.LocationDataType.LocationData> locationDataProvider, long motionTimeout)
boolean	isActive()
boolean	isDataAvailable()
void	removeDataObserver(org.openbase.jul.pattern.Observer<rst.domotic.state.PresenceStateType.PresenceState> observer)
void	shutdown()
void	waitForData()
void	waitForData(long timeout, TimeUnit timeUnit)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openbase.jul.iface.Shutdownable

registerShutdownHook, registerShutdownHook

Field Detail

PRESENCE_TIMEOUT

public static final long PRESENCE_TIMEOUT

Default 3 minute window of no movement unit the state switches to NO_MOTION.

logger

protected final org.slf4j.Logger logger

Constructor Detail

PresenceDetector

public PresenceDetector()

Method Detail

init

public void init(org.openbase.jul.pattern.provider.DataProvider<rst.domotic.unit.location.LocationDataType.LocationData> locationDataProvider)
          throws org.openbase.jul.exception.InitializationException,
                 InterruptedException

Specified by:

init in interface org.openbase.jul.iface.Initializable<org.openbase.jul.pattern.provider.DataProvider<rst.domotic.unit.location.LocationDataType.LocationData>>

Throws:

org.openbase.jul.exception.InitializationException

InterruptedException

init

public void init(org.openbase.jul.pattern.provider.DataProvider<rst.domotic.unit.location.LocationDataType.LocationData> locationDataProvider,
                 long motionTimeout)
          throws org.openbase.jul.exception.InitializationException,
                 InterruptedException

Throws:

org.openbase.jul.exception.InitializationException

InterruptedException

activate

public void activate()
              throws org.openbase.jul.exception.CouldNotPerformException,
                     InterruptedException

Specified by:

activate in interface org.openbase.jul.iface.Activatable

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

deactivate

public void deactivate()
                throws org.openbase.jul.exception.CouldNotPerformException,
                       InterruptedException

Specified by:

deactivate in interface org.openbase.jul.iface.Activatable

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

isActive

public boolean isActive()

Specified by:

isActive in interface org.openbase.jul.iface.Activatable

shutdown

public void shutdown()

Specified by:

shutdown in interface org.openbase.jul.iface.Manageable<org.openbase.jul.pattern.provider.DataProvider<rst.domotic.unit.location.LocationDataType.LocationData>>

Specified by:

shutdown in interface org.openbase.jul.iface.Shutdownable

isDataAvailable

public boolean isDataAvailable()

Specified by:

isDataAvailable in interface org.openbase.jul.pattern.provider.DataProvider<rst.domotic.state.PresenceStateType.PresenceState>

getDataClass

public Class<rst.domotic.state.PresenceStateType.PresenceState> getDataClass()

Specified by:

getDataClass in interface org.openbase.jul.pattern.provider.DataProvider<rst.domotic.state.PresenceStateType.PresenceState>

getData

public rst.domotic.state.PresenceStateType.PresenceState getData()
                                                          throws org.openbase.jul.exception.NotAvailableException

Specified by:

getData in interface org.openbase.jul.pattern.provider.DataProvider<rst.domotic.state.PresenceStateType.PresenceState>

Throws:

org.openbase.jul.exception.NotAvailableException

getDataFuture

public CompletableFuture<rst.domotic.state.PresenceStateType.PresenceState> getDataFuture()

Specified by:

getDataFuture in interface org.openbase.jul.pattern.provider.DataProvider<rst.domotic.state.PresenceStateType.PresenceState>

addDataObserver

public void addDataObserver(org.openbase.jul.pattern.Observer<rst.domotic.state.PresenceStateType.PresenceState> observer)

Specified by:

addDataObserver in interface org.openbase.jul.pattern.provider.DataProvider<rst.domotic.state.PresenceStateType.PresenceState>

removeDataObserver

public void removeDataObserver(org.openbase.jul.pattern.Observer<rst.domotic.state.PresenceStateType.PresenceState> observer)

Specified by:

removeDataObserver in interface org.openbase.jul.pattern.provider.DataProvider<rst.domotic.state.PresenceStateType.PresenceState>

waitForData

public void waitForData()
                 throws org.openbase.jul.exception.CouldNotPerformException,
                        InterruptedException

Specified by:

waitForData in interface org.openbase.jul.pattern.provider.DataProvider<rst.domotic.state.PresenceStateType.PresenceState>

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException

waitForData

public void waitForData(long timeout,
                        TimeUnit timeUnit)
                 throws org.openbase.jul.exception.CouldNotPerformException,
                        InterruptedException

Specified by:

waitForData in interface org.openbase.jul.pattern.provider.DataProvider<rst.domotic.state.PresenceStateType.PresenceState>

Throws:

org.openbase.jul.exception.CouldNotPerformException

InterruptedException