Package org.sensorhub.api.feature

Class FoiAddedEvent

java.lang.Object

org.sensorhub.api.event.Event

org.sensorhub.api.system.SystemEvent

org.sensorhub.api.feature.FoiAddedEvent

public class FoiAddedEvent
extends SystemEvent

Event sent when a new FOI is being targeted by an observing system. It is immutable and carries feature data by reference.

Since:

Apr 23, 2015

Field Summary

Fields

Modifier and Type	Field	Description
protected IFeature	foi
protected String	foiUID
protected Instant	startTime

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
FoiAddedEvent(long timeStamp, String sysUID, String foiUID, Instant startTime)	Creates a new event with only the feature UID
FoiAddedEvent(long timeStamp, IDataProducer producer, String foiUID, Instant startTime)	Creates a new event with only the feature UID
FoiAddedEvent(long timeStamp, IDataProducer producer, IFeature foi, Instant startTime)	Creates a new event with an attached feature object

Method Summary

Modifier and Type	Method	Description
IFeature	getFoi()
String	getFoiUID()
Instant	getStartTime()

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

assignSystemID, getSourceID, 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

foi

protected IFeature foi

foiUID

protected String foiUID

startTime

protected Instant startTime

Constructor Details

FoiAddedEvent

public FoiAddedEvent(long timeStamp,
 String sysUID,
 String foiUID,
 Instant startTime)

Creates a new event with only the feature UID

Parameters:

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

sysUID - Unique ID of producer that generated the event

foiUID - Unique ID of feature of interest

startTime - Time at which observation of the FoI started

FoiAddedEvent

public FoiAddedEvent(long timeStamp,
 IDataProducer producer,
 String foiUID,
 Instant startTime)

Creates a new event with only the feature UID

Parameters:

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

producer - Producer that generated the event

foiUID - Unique ID of feature of interest

startTime - Time at which observation of the FoI started

FoiAddedEvent

public FoiAddedEvent(long timeStamp,
 IDataProducer producer,
 IFeature foi,
 Instant startTime)

Creates a new event with an attached feature object

Parameters:

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

producer - producer that generated the event

foi - feature object

startTime - time at which observation of the FoI started

Method Details

getFoiUID

public String getFoiUID()

Returns:

The unique ID of the feature of interest related to this event

getFoi

public IFeature getFoi()

Returns:

The description of the feature of interest related to this event or null if the description was already registered by some other means. (in this case, only the UID is provided in the event)

getStartTime

public Instant getStartTime()

Returns:

The time at which the feature of interest started being observed.