de.hawhamburg.reachability.sensor

Interface SensorAdapter

All Superinterfaces:

StopableObject

All Known Implementing Classes:

ExampleAdapter, GoogleCalendarAdapter, GoogleCalendarHookAdapter, LP3DObjectLocationAdapter, RSDFAdapter, StressCompanionAdapter, TimeAdapter

public interface SensorAdapter
extends StopableObject

Interface which needs to be implemented by each SensorAdapter.

This interface defines the methods, which a SensorAdapter needs to implement to be used in common with the reachability project. Besides this interface, a SensorAdapter needs to implement the interface StopableObject as well.

Version:

"2013.42"

Author:

"Malte Kantak <malte.kantak@hotmail.de>"

Method Summary

Methods

Modifier and Type	Method and Description
void	connect() Connects the sensor to its data source, for it'll be able to provide new sensor data in an internal data format via the ActiveMQ.
ReasonerDimension	getDataDimension() Provides the context dimension of the sensors data as ReasonerDimension.
java.lang.String	getRequestTopicName() Provides the name of the request topic for ActiveMQ communication, if the SensorAdapter is connected to its data source via the ActiveMQ and the data source needs requests to supply data, otherwise null.
java.lang.String	getResultTopicName() Provides the name of the result topic for ActiveMQ communication, if the SensorAdapter is connected to its data source via the ActiveMQ, otherwise null.
SensorData	getSensorOutput() Requests the last measured sensor data from the SensorAdapter as SensorData.
void	setSilent(boolean state) Sets the silent state.
void	start() A SensorAdapter extends the class Thread.
boolean	stopped() Determines if the SensorAdapter has stopped working.

Methods inherited from interface de.hawhamburg.reachability.StopableObject

isActive, shutDown

Method Detail

connect

void connect()

Connects the sensor to its data source, for it'll be able to provide new sensor data in an internal data format via the ActiveMQ.

getSensorOutput

SensorData getSensorOutput()

Requests the last measured sensor data from the SensorAdapter as SensorData.

Returns:

The last measured sensor data as SensorData object.

getRequestTopicName

java.lang.String getRequestTopicName()

Provides the name of the request topic for ActiveMQ communication, if the SensorAdapter is connected to its data source via the ActiveMQ and the data source needs requests to supply data, otherwise null.

Returns:

The name of the request topic for this SensorAdapter, if it's connected via ActiveMQ, otherwise null.

getResultTopicName

java.lang.String getResultTopicName()

Provides the name of the result topic for ActiveMQ communication, if the SensorAdapter is connected to its data source via the ActiveMQ, otherwise null.

Returns:

The name of the result topic for this SensorAdapter, if it's connected via ActiveMQ, otherwise null.

getDataDimension

ReasonerDimension getDataDimension()

Provides the context dimension of the sensors data as ReasonerDimension.

Returns:

The ReasonerDimension of the sensors data.

start

void start()

A SensorAdapter extends the class Thread. To make the Thread.start() method visible, it needs to be included to this interface.

stopped

boolean stopped()

Determines if the SensorAdapter has stopped working.

Returns:

true if the SensorAdapter has stopped working, otherwise false.

setSilent

void setSilent(boolean state)

Sets the silent state. If silent is set to true, the worker won't publish his informations on the internal data topic.

Parameters:

state - The current state of silence as Boolean.