de.hawhamburg.reachability.tools.feeder

Class SensorDataFeeder

java.lang.Object

java.lang.Thread

de.hawhamburg.reachability.tools.feeder.SensorDataFeeder

All Implemented Interfaces:

StopableObject, java.lang.Runnable

public class SensorDataFeeder
extends java.lang.Thread
implements StopableObject

Main thread to transform defined sensor stories (*.sgs) into series of ActiveMQ sensor events.

This class takes, when started, the supplied simulation file (in "*.sgs" format) and maps it to sensor events on the ActiveMQ which can easily be received by a corresponding sensor adapter. This tool allows the simulation of complex scenarios to check the reaction of the reachability agent system. It may also serve as training environment for an learning based reasoner.

Version:

"2013.42"

Author:

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

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	FEEDER_HEARTBEAT The default instruction to send the actual simulation time each simulation minute as time sensor event.
static boolean	FEEDER_SILENT The default instruction to write informations to console/logfile.
static int	FEEDER_SPEED The default simulation speed in simulation minutes per real-time minute.
static int	FEEDER_WAIT The default waiting time before simulation starts in milliseconds.
private java.lang.String	file The actual name of the file that contains the story which shall be simulated.
private boolean	heartbeat The actual instruction to send the actual simulation time each simulation minute as time sensor event.
private java.util.SortedMap<SensorDataFeederItem,java.lang.String>	log The actual list of sent SensorDataFeederItem.
private java.util.List<SensorDataFeederNotifiable>	notifiable The list of threads, which shall be notified at change and simulation end.
private java.util.Map<java.lang.String,de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher>	outTopics The actual opened output topics on the ActiveMQ as Map of sensor name to LPPublisher.
private java.lang.String	path The actual path to the directory of the simulation files.
private boolean	shutDown Determines if the method shutDown() has been called.
private boolean	silent Determines if this service shall print out debug output or not.
private int	speed The actual simulation speed in simulation minutes per real-time minute.
private java.util.Map<java.lang.Integer,SensorDataFeederItem>	story The actual simulation story as Map of time index (Integer) to SensorDataFeederItem.
static java.lang.String	TEST_FILE The default name of the file that contains the story which shall be simulated.
static java.lang.String	TEST_PATH The default path to the directory of the simulation files.
static java.lang.String	TOPIC_ROOT The default prefix for simulated sensor result topics on the ActiveMQ.
private java.lang.String	topicRoot The actual prefix for simulated sensor result topics on the ActiveMQ.
private int	wait The actual delay time in milliseconds before the simulation shall start.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
SensorDataFeeder(java.lang.String[] args) Initializes a new SensorDataFeeder object with supplied command line arguments.
SensorDataFeeder(java.lang.String basepath, java.lang.String topicRootIn, int speedIn, int waitIn, boolean sendHeartbeat, boolean beQuite) Initializes a new SensorDataFeeder object.

Method Summary

Methods

Modifier and Type	Method and Description
void	addNotifiable(SensorDataFeederNotifiable object) Adds a new thread which shall be notified if this simulation feeder stops.
private void	end() Gracefully end the thread by disconnecting all open LPPublisher and notifying all registered SensorDataFeederNotifiable objects.
java.lang.String	getFile() Return the actual simulation files name.
java.util.SortedMap<SensorDataFeederItem,java.lang.String>	getLog() Returns the log of sent simulation events as list of SensorDataFeederItem.
java.lang.String	getPath() Returns the path where the simulation file is located.
int	getSpeed() Returns the actual simulation speed in simulation minutes per real-time minute.
java.util.Map<java.lang.Integer,SensorDataFeederItem>	getStory() Returns the whole actual simulation story as list of SensorDataFeederItem.
private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher	getTopic(java.lang.String type) Creates and returns a new LPPublisher object which holds an open ActiveMQ topic connection named as "topicRoot+[SENSOR_TYPE_NAME]".
java.lang.String	getTopicRoot() Returns the actual ActiveMQ topic prefix.
boolean	isActive() Determines whether the method StopableObject.shutDown() has been called on this object or not.
boolean	isSilent() Determines whether the simulation runs in silent mode or not.
private java.util.Map<java.lang.Integer,SensorDataFeederItem>	loadStory(java.lang.String storyFilePath) Loads and returns a story from a defined story file by using SensorDataFeederItem.fromFile(String).
static void	main(java.lang.String[] args) Main method to start the sensor data feeder as stand-alone thread.
void	run() Starts the simulation.
private void	sendData(SensorDataFeederItem item) Sends a new SensorDataFeederItem as JSON-object via the ActiveMQ.
boolean	sendsHeartbeats() Determines whether the simulation sends the actual simulation time as simulated time sensor each minute or not.
void	shutDown() Shuts the object down.
private void	simulateTime(int last, int next, int speedIn) Let the thread sleep, until the next sensor event shall be published onto the ActiveMQ.
void	unregisterNotifiable(SensorDataFeederNotifiable object) Unregisters a thread form the list of threats that shall be notified if the simulation feeder stops.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Field Detail

TOPIC_ROOT

public static final java.lang.String TOPIC_ROOT

The default prefix for simulated sensor result topics on the ActiveMQ.

See Also:

Constant Field Values

TEST_PATH

public static final java.lang.String TEST_PATH

The default path to the directory of the simulation files.

See Also:

Constant Field Values

TEST_FILE

public static final java.lang.String TEST_FILE

The default name of the file that contains the story which shall be simulated.

See Also:

Constant Field Values

FEEDER_SPEED

public static final int FEEDER_SPEED

The default simulation speed in simulation minutes per real-time minute.

See Also:

Constant Field Values

FEEDER_WAIT

public static final int FEEDER_WAIT

The default waiting time before simulation starts in milliseconds.

See Also:

Constant Field Values

FEEDER_HEARTBEAT

public static final boolean FEEDER_HEARTBEAT

The default instruction to send the actual simulation time each simulation minute as time sensor event.

See Also:

Constant Field Values

FEEDER_SILENT

public static final boolean FEEDER_SILENT

The default instruction to write informations to console/logfile.

See Also:

Constant Field Values

topicRoot

private java.lang.String topicRoot

The actual prefix for simulated sensor result topics on the ActiveMQ.

path

private java.lang.String path

The actual path to the directory of the simulation files.

file

private java.lang.String file

The actual name of the file that contains the story which shall be simulated.

speed

private int speed

The actual simulation speed in simulation minutes per real-time minute.

wait

private int wait

The actual delay time in milliseconds before the simulation shall start.

heartbeat

private boolean heartbeat

The actual instruction to send the actual simulation time each simulation minute as time sensor event.

silent

private boolean silent

Determines if this service shall print out debug output or not.

outTopics

private java.util.Map<java.lang.String,de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher> outTopics

The actual opened output topics on the ActiveMQ as Map of sensor name to LPPublisher.

shutDown

private boolean shutDown

Determines if the method shutDown() has been called.

notifiable

private java.util.List<SensorDataFeederNotifiable> notifiable

The list of threads, which shall be notified at change and simulation end.

log

private java.util.SortedMap<SensorDataFeederItem,java.lang.String> log

The actual list of sent SensorDataFeederItem.

story

private java.util.Map<java.lang.Integer,SensorDataFeederItem> story

The actual simulation story as Map of time index (Integer) to SensorDataFeederItem.

Constructor Detail

SensorDataFeeder

public SensorDataFeeder(java.lang.String[] args)

Initializes a new SensorDataFeeder object with supplied command line arguments.

Defined command line arguments:

--storyfile	Name of the used story file
	(Defaults to TEST_FILE)
--storypath	Path to the used story file
	(Defaults to TEST_PATH)
--feederwait	Delay time before start in milliseconds
--feederchannelroot	Default AMQ topic prefix
	(Defaults to TOPIC_ROOT)
--feederspeed	Speed of simulation in simulation minutes per real minute
	(Defaults to FEEDER_SPEED)
--feederheartbeat	Instruction to send the actual simulation time each simulation minute as time sensor event.
	(Defaults to FEEDER_HEARTBEAT)
--feedersilent	Determines if this service shall print out debug output or not.
	(Defaults to FEEDER_SILENT)
--wrapped	Informs the systems it wasn't started as stand-alone service and forces it to be silent.

Parameters:

args - The command line arguments (see method description for usage).

SensorDataFeeder

public SensorDataFeeder(java.lang.String basepath,
                java.lang.String topicRootIn,
                int speedIn,
                int waitIn,
                boolean sendHeartbeat,
                boolean beQuite)

Initializes a new SensorDataFeeder object.

Parameters:

basepath - The path to the simulation story file as String.

topicRootIn - The prefix of ActiveMQ topics for simulated sensor event output as String.

speedIn - The in simulation minutes per real-time minute as int.

waitIn - The delay in milliseconds before the simulation starts as int.

sendHeartbeat - The instruction to send a frequently heartbeat including the simulation time or not as boolean.

beQuite - Indicates if this simulation shall run in silent mode or not.

Method Detail

loadStory

private java.util.Map<java.lang.Integer,SensorDataFeederItem> loadStory(java.lang.String storyFilePath)

Loads and returns a story from a defined story file by using SensorDataFeederItem.fromFile(String).

Parameters:

storyFilePath - The path to the file that contains the story which shall be loaded.

Returns:

The story as Map of simulation time minute (Integer) to SensorDataFeederItem object.

addNotifiable

public final void addNotifiable(SensorDataFeederNotifiable object)

Adds a new thread which shall be notified if this simulation feeder stops.

Parameters:

object - The thread which shall be notified as SensorDataFeederNotifiable.

unregisterNotifiable

public final void unregisterNotifiable(SensorDataFeederNotifiable object)

Unregisters a thread form the list of threats that shall be notified if the simulation feeder stops.

Parameters:

object - The thread which shall be unregistered of the list of notifiables.

isActive

public final boolean isActive()

Description copied from interface: StopableObject

Determines whether the method StopableObject.shutDown() has been called on this object or not.

Specified by:

isActive in interface StopableObject

Returns:

true if shutDown() wasn't called, otherwise false.

See Also:

StopableObject.isActive()

shutDown

public final void shutDown()

Description copied from interface: StopableObject

Shuts the object down. The method shall ensure, that all opened or started resources (e.g. ActiveMQ connections, started threads) will be controlled shut down before the objects ends itself.

Specified by:

shutDown in interface StopableObject

See Also:

StopableObject.shutDown()

run

public final void run()

Starts the simulation.

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

end

private void end()

Gracefully end the thread by disconnecting all open LPPublisher and notifying all registered SensorDataFeederNotifiable objects.

sendData

private void sendData(SensorDataFeederItem item)

Sends a new SensorDataFeederItem as JSON-object via the ActiveMQ.

Parameters:

item - The new sensor event as SensorDataFeederItem.

getTopic

private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher getTopic(java.lang.String type)

Creates and returns a new LPPublisher object which holds an open ActiveMQ topic connection named as "topicRoot+[SENSOR_TYPE_NAME]".

Parameters:

type - The name of the sensor type as String.

Returns:

An LPPublisher as open topic on the ActiveMQ to publish the simulated sensor event.

getPath

public final java.lang.String getPath()

Returns the path where the simulation file is located.

Returns:

The path where the actual simulation file is located as String.

getFile

public final java.lang.String getFile()

Return the actual simulation files name.

Returns:

The actual simulation files name as String.

getTopicRoot

public final java.lang.String getTopicRoot()

Returns the actual ActiveMQ topic prefix.

Returns:

The actual ActiveMQ topic prefix as String.

getSpeed

public final int getSpeed()

Returns the actual simulation speed in simulation minutes per real-time minute.

Returns:

The actual simulation speed in simulation minutes per real-time minute.

getStory

public final java.util.Map<java.lang.Integer,SensorDataFeederItem> getStory()

Returns the whole actual simulation story as list of SensorDataFeederItem.

Returns:

The whole actual simulation story as list of SensorDataFeederItem.

getLog

public final java.util.SortedMap<SensorDataFeederItem,java.lang.String> getLog()

Returns the log of sent simulation events as list of SensorDataFeederItem.

Returns:

The log of sent simulation events as list of SensorDataFeederItem.

sendsHeartbeats

public final boolean sendsHeartbeats()

Determines whether the simulation sends the actual simulation time as simulated time sensor each minute or not.

Returns:

true if this simulation sends its actual simulation time as simulated time sensor, otherwise false.

isSilent

public final boolean isSilent()

Determines whether the simulation runs in silent mode or not.

Returns:

true if the simulation runs in silent mode, otherwise false.

simulateTime

private void simulateTime(int last,
                int next,
                int speedIn)

Let the thread sleep, until the next sensor event shall be published onto the ActiveMQ.

Parameters:

last - The simulation time in minutes where the last event took place.

next - The simulation time in minutes where the next event shall start.

speedIn - The current simulation time in simulation minutes per real-time minute.

main

public static void main(java.lang.String[] args)

Main method to start the sensor data feeder as stand-alone thread.

Defined command line arguments:

--storyfile	Name of the used story file
	(Defaults to TEST_FILE)
--storypath	Path to the used story file
	(Defaults to TEST_PATH)
--feederwait	Delay time before start in milliseconds
--feederchannelroot	Default AMQ topic prefix
	(Defaults to TOPIC_ROOT)
--feederspeed	Speed of simulation in simulation minutes per real minute
	(Defaults to FEEDER_SPEED)
--feederheartbeat	Instruction to send the actual simulation time each simulation minute as time sensor event.
	(Defaults to FEEDER_HEARTBEAT)
--feedersilent	Determines if this service shall print out debug output or not.
	(Defaults to FEEDER_SILENT)
--wrapped	Informs the systems it wasn't started as stand-alone service and forces it to be silent.

Parameters:

args - The command line arguments (see method description for usage).