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.
Modifier and Type | Class and Description |
---|---|
static class |
FoiEvent.Type
Possible event types for a FoiEvent
|
Modifier and Type | Field and Description |
---|---|
protected AbstractFeature |
foi
Description of Feature of Interest related to this event (by reference)
|
protected 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 |
relatedEntityID
Constructor and Description |
---|
FoiEvent(long timeStamp,
IDataProducerModule<?> srcModule,
AbstractFeature foi,
double startTime)
Creates a
FoiEvent.Type.NEW_FOI event with an attached feature object |
FoiEvent(long timeStamp,
IDataProducerModule<?> srcModule,
String foiID,
double startTime)
Creates a
FoiEvent.Type.NEW_FOI event with only the feature ID |
FoiEvent(long timeStamp,
String entityID,
IDataProducerModule<?> srcModule,
AbstractFeature foi,
double startTime)
Creates a
FoiEvent.Type.NEW_FOI event with an attached feature object for a specific entity |
FoiEvent(long timeStamp,
String entityID,
IDataProducerModule<?> srcModule,
String foiID,
double startTime)
Creates a
FoiEvent.Type.NEW_FOI event with only the feature ID for a specific entity |
Modifier and Type | Method and Description |
---|---|
AbstractFeature |
getFoi() |
String |
getFoiID() |
double |
getStartTime() |
double |
getStopTime() |
getRelatedEntityID
getSource, getTimeStamp, getType
protected AbstractFeature foi
protected String foiID
protected double startTime
Double.NaN
with a value for stopTime
to end the
FoI observation period.protected double stopTime
Double.NaN
with a value for startTime
to start a
new observation period for the FoIpublic FoiEvent(long timeStamp, IDataProducerModule<?> srcModule, String foiID, double startTime)
FoiEvent.Type.NEW_FOI
event with only the feature IDtimeStamp
- time of event generation (unix time in milliseconds, base 1970)srcModule
- module that generated the eventfoiID
- ID of feature of intereststartTime
- time at which observation of the FoI started (julian time in seconds, base 1970)public FoiEvent(long timeStamp, String entityID, IDataProducerModule<?> srcModule, String foiID, double startTime)
FoiEvent.Type.NEW_FOI
event with only the feature ID for a specific entitytimeStamp
- time of event generation (unix time in milliseconds, base 1970)entityID
- Unique ID of entity observing the FOI identified by foiIDsrcModule
- module that generated the eventfoiID
- ID of feature of intereststartTime
- time at which observation of the FoI started (julian time in seconds, base 1970)public FoiEvent(long timeStamp, IDataProducerModule<?> srcModule, AbstractFeature foi, double startTime)
FoiEvent.Type.NEW_FOI
event with an attached feature objecttimeStamp
- time of event generation (unix time in milliseconds, base 1970)srcModule
- module that generated the eventfoi
- feature objectstartTime
- time at which observation of the FoI started (julian time in seconds, base 1970)public FoiEvent(long timeStamp, String entityID, IDataProducerModule<?> srcModule, AbstractFeature foi, double startTime)
FoiEvent.Type.NEW_FOI
event with an attached feature object for a specific entitytimeStamp
- time of event generation (unix time in milliseconds, base 1970)entityID
- Unique ID of entity observing the attached FOIsrcModule
- module that generated the eventfoi
- feature objectstartTime
- time at which observation of the FoI started (julian time in seconds, base 1970)public AbstractFeature getFoi()
public String getFoiID()
public double getStartTime()
public double getStopTime()
Copyright © 2016 Sensia Software LLC. All rights reserved.