org.sensorhub.api.data

Class FoiEvent

java.lang.Object

org.sensorhub.api.common.Event<EventTypeEnum>

org.sensorhub.api.common.EntityEvent<FoiEvent.Type>

org.sensorhub.api.data.FoiEvent

public class FoiEvent
extends EntityEvent<FoiEvent.Type>

Type of event generated when a new FOI is being targeted by a sensor or process. It is immutable and carries feature data by reference.

Since:

Apr 23, 2015

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FoiEvent.Type Possible event types for a FoiEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected net.opengis.gml.v32.AbstractFeature	foi Description of Feature of Interest related to this event (by reference)
protected java.lang.String	foiID ID of feature of interest related to this event
protected double	startTime Time at which the feature of interest started being observed. Use Double.NaN with a value for stopTime to end the FoI observation period.
protected double	stopTime Time at which the feature of interest stopped being observed. Use Double.NaN with a value for startTime to start a new observation period for the FoI

Fields inherited from class org.sensorhub.api.common.EntityEvent

relatedEntityID

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

source, timeStamp, type

Constructor Summary

Constructors

Constructor and Description
FoiEvent(long timeStamp, IDataProducerModule<?> srcModule, net.opengis.gml.v32.AbstractFeature foi, double startTime) Creates a FoiEvent.Type.NEW_FOI event with an attached feature object
FoiEvent(long timeStamp, IDataProducerModule<?> srcModule, java.lang.String foiID, double startTime) Creates a FoiEvent.Type.NEW_FOI event with only the feature ID
FoiEvent(long timeStamp, java.lang.String entityID, IDataProducerModule<?> srcModule, net.opengis.gml.v32.AbstractFeature foi, double startTime) Creates a FoiEvent.Type.NEW_FOI event with an attached feature object for a specific entity
FoiEvent(long timeStamp, java.lang.String entityID, IDataProducerModule<?> srcModule, java.lang.String foiID, double startTime) Creates a FoiEvent.Type.NEW_FOI event with only the feature ID for a specific entity

Method Summary

Modifier and Type	Method and Description
net.opengis.gml.v32.AbstractFeature	getFoi()
java.lang.String	getFoiID()
double	getStartTime()
double	getStopTime()

Methods inherited from class org.sensorhub.api.common.EntityEvent

getRelatedEntityID

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

getSource, getTimeStamp, getType

Methods inherited from class java.lang.Object

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

Field Detail

foi

protected net.opengis.gml.v32.AbstractFeature foi

Description of Feature of Interest related to this event (by reference)

foiID

protected java.lang.String foiID

ID of feature of interest related to this event

startTime

protected double startTime

Time at which the feature of interest started being observed.
Use Double.NaN with a value for stopTime to end the FoI observation period.

stopTime

protected double stopTime

Time at which the feature of interest stopped being observed.
Use Double.NaN with a value for startTime to start a new observation period for the FoI

Constructor Detail

FoiEvent

public FoiEvent(long timeStamp,
                IDataProducerModule<?> srcModule,
                java.lang.String foiID,
                double startTime)

Creates a FoiEvent.Type.NEW_FOI event with only the feature ID

Parameters:

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

srcModule - module that generated the event

foiID - ID of feature of interest

startTime - time at which observation of the FoI started (julian time in seconds, base 1970)

FoiEvent

public FoiEvent(long timeStamp,
                java.lang.String entityID,
                IDataProducerModule<?> srcModule,
                java.lang.String foiID,
                double startTime)

Creates a FoiEvent.Type.NEW_FOI event with only the feature ID for a specific entity

Parameters:

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

entityID - Unique ID of entity observing the FOI identified by foiID

srcModule - module that generated the event

foiID - ID of feature of interest

startTime - time at which observation of the FoI started (julian time in seconds, base 1970)

FoiEvent

public FoiEvent(long timeStamp,
                IDataProducerModule<?> srcModule,
                net.opengis.gml.v32.AbstractFeature foi,
                double startTime)

Creates a FoiEvent.Type.NEW_FOI event with an attached feature object

Parameters:

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

srcModule - module that generated the event

foi - feature object

startTime - time at which observation of the FoI started (julian time in seconds, base 1970)

FoiEvent

public FoiEvent(long timeStamp,
                java.lang.String entityID,
                IDataProducerModule<?> srcModule,
                net.opengis.gml.v32.AbstractFeature foi,
                double startTime)

Creates a FoiEvent.Type.NEW_FOI event with an attached feature object for a specific entity

Parameters:

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

entityID - Unique ID of entity observing the attached FOI

srcModule - module that generated the event

foi - feature object

startTime - time at which observation of the FoI started (julian time in seconds, base 1970)

Method Detail

getFoi

public net.opengis.gml.v32.AbstractFeature getFoi()

getFoiID

public java.lang.String getFoiID()

getStartTime

public double getStartTime()

getStopTime

public double getStopTime()