Package org.sensorhub.api.command

Class CommandStreamEvent

java.lang.Object

org.sensorhub.api.event.Event

org.sensorhub.api.system.SystemEvent

org.sensorhub.api.command.CommandStreamEvent

Direct Known Subclasses:

CommandEvent, CommandStatusEvent, CommandStreamAddedEvent, CommandStreamChangedEvent, CommandStreamDisabledEvent, CommandStreamEnabledEvent, CommandStreamRemovedEvent

public abstract class CommandStreamEvent
extends SystemEvent

Base class for all command stream (i.e. tasking/control input) related events

Field Summary

Fields

Modifier and Type	Field	Description
protected BigId	cmdStreamID

Fields inherited from class org.sensorhub.api.system.SystemEvent

sourceID, systemID, systemUID

Fields inherited from class org.sensorhub.api.event.Event

source, timeStamp

Constructor Summary

Constructors

Constructor	Description
CommandStreamEvent(long timeStamp, String sysUID, String controlInputName)
CommandStreamEvent(String sysUID, String controlInputName)	Helper constructor that sets the timestamp to current system time
CommandStreamEvent(ICommandStreamInfo csInfo)	Helper constructor that sets the timestamp to current system time

Method Summary

Modifier and Type	Method	Description
void	assignCommandStreamID(BigId internalID)	Called by the framework to assign the command stream's local ID to this event.
BigId	getCommandStreamID()
String	getControlInputName()
String	getSourceID()	Gets the ID of the source of event.

Methods inherited from class org.sensorhub.api.system.SystemEvent

assignSystemID, getSystemID, getSystemUID

Methods inherited from class org.sensorhub.api.event.Event

getSource, getTimeStamp, toString

Methods inherited from class java.lang.Object

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

Field Details

cmdStreamID

protected BigId cmdStreamID

Constructor Details

CommandStreamEvent

public CommandStreamEvent(long timeStamp,
 String sysUID,
 String controlInputName)

Parameters:

timeStamp - time of event generation (unix time in milliseconds, base 1970)

sysUID - Unique ID of parent system

controlInputName - Name of control input

CommandStreamEvent

public CommandStreamEvent(String sysUID,
 String controlInputName)

Helper constructor that sets the timestamp to current system time

Parameters:

sysUID - Unique ID of parent system

controlInputName - Name of output producing the datastream

CommandStreamEvent

public CommandStreamEvent(ICommandStreamInfo csInfo)

Helper constructor that sets the timestamp to current system time

Parameters:

csInfo - Command stream the event relates to

Method Details

getControlInputName

public String getControlInputName()

Returns:

Name of control input

getCommandStreamID

public BigId getCommandStreamID()

Returns:

Internal ID of the command stream related to this event

assignCommandStreamID

public void assignCommandStreamID(BigId internalID)

Called by the framework to assign the command stream's local ID to this event. This can only be called once and must be called before the event is dispatched.

Parameters:

internalID - Internal ID of related command stream

getSourceID

public String getSourceID()

Description copied from class: Event

Gets the ID of the source of event.

Overrides:

getSourceID in class SystemEvent

Returns:

ID of the event source