de.dim.trafficos.device.api

Interface DeviceService

public interface DeviceService

Since:

Jun 26, 2019

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_CYCLE_COUNTER
static java.lang.String	PROP_DATA_ENTRY
static java.lang.String	PROP_DEVICE_ID
static java.lang.String	PROP_DEVICE_STATUS
static java.lang.String	TOPIC_ALL_DATA_ENTRY
static java.lang.String	TOPIC_CHANGE_DATA_ENTRY
static java.lang.String	TOPIC_DATA_ENTRY
static java.lang.String	TOPIC_DEVICE
static java.lang.String	TOPIC_DEVICE_ALL_ENTRIES
static java.lang.String	TOPIC_DEVICE_LIFECYCLE
static java.lang.String	TOPIC_DEVICE_REMOVE
static java.lang.String	TOPIC_DEVICE_UPDATE

Method Summary

Modifier and Type	Method and Description
DeviceConfiguration	getConfiguration()
java.util.List<DeviceConfiguration>	getConfigurations()
DataEntry	getCurrentDataEntry(java.util.Date timestamp)
java.util.List<DataEntry>	getDataEntries(java.util.Date startDate, java.util.Date endDate) Retrieves the list of DataEntry within the provided time range for the Device associated with the DeviceService instance.
Device	getDevice()
java.lang.String	getDeviceId()
LifeCycleDeviceType	getStatus()
void	initialize(boolean forceReload, boolean forceRestart) Initializes the device manually.
boolean	isRunning()
boolean	startDevice() Starts the Device associated with the DeviceService instance, if it is not running yet, and if it was possible to start.
boolean	stopDevice() Stops the Device associated with the DeviceService instance, in case it was running.
Device	updateDevice(Device device) Updates the Device associated with the DeviceService instance with the given Device.
DeviceConfiguration	updateDeviceConfiguration(DeviceConfiguration configuration) Updates the DeviceConfiguration associated with the current device.
DeviceInfo	updateDeviceInformation(DeviceInfo info) Updates the DeviceInfo associated with the current device.

Field Detail

TOPIC_DEVICE

static final java.lang.String TOPIC_DEVICE

See Also:

Constant Field Values

TOPIC_DEVICE_UPDATE

static final java.lang.String TOPIC_DEVICE_UPDATE

See Also:

Constant Field Values

TOPIC_DEVICE_REMOVE

static final java.lang.String TOPIC_DEVICE_REMOVE

See Also:

Constant Field Values

TOPIC_DEVICE_LIFECYCLE

static final java.lang.String TOPIC_DEVICE_LIFECYCLE

See Also:

Constant Field Values

PROP_DEVICE_ID

static final java.lang.String PROP_DEVICE_ID

See Also:

Constant Field Values

PROP_DEVICE_STATUS

static final java.lang.String PROP_DEVICE_STATUS

See Also:

Constant Field Values

TOPIC_DATA_ENTRY

static final java.lang.String TOPIC_DATA_ENTRY

See Also:

Constant Field Values

TOPIC_ALL_DATA_ENTRY

static final java.lang.String TOPIC_ALL_DATA_ENTRY

See Also:

Constant Field Values

TOPIC_CHANGE_DATA_ENTRY

static final java.lang.String TOPIC_CHANGE_DATA_ENTRY

See Also:

Constant Field Values

TOPIC_DEVICE_ALL_ENTRIES

static final java.lang.String TOPIC_DEVICE_ALL_ENTRIES

See Also:

Constant Field Values

PROP_DATA_ENTRY

static final java.lang.String PROP_DATA_ENTRY

See Also:

Constant Field Values

PROP_CYCLE_COUNTER

static final java.lang.String PROP_CYCLE_COUNTER

See Also:

Constant Field Values

Method Detail

getStatus

LifeCycleDeviceType getStatus()

Returns:

the LifeCycleDeviceType of the Device

getDevice

Device getDevice()

Returns:

the Device associated with the DeviceService instance

getDeviceId

java.lang.String getDeviceId()

Returns:

the id of the Device associated with the DeviceService instance

initialize

void initialize(boolean forceReload,
                boolean forceRestart)
         throws DeviceException

Initializes the device manually.

Parameters:

forceReload - forces to reload all data, independent from current running state

forceRestart - forces to restart a simulation, if it currently running

Throws:

DeviceException

updateDevice

Device updateDevice(Device device)

Updates the Device associated with the DeviceService instance with the given Device. If the provided Device is null or has a null update, no update is performed and the method returns the old Device. Otherwise the update is performed, the Device is saved to the DB and the updated Device is returned.

Parameters:

device - the updated Device to be saved

Returns:

the updated Device

updateDeviceConfiguration

DeviceConfiguration updateDeviceConfiguration(DeviceConfiguration configuration)

Updates the DeviceConfiguration associated with the current device. The new DeviceConfiguration is set as the current Configuration of the Device, and the Device is saved to the DB together with the updated Configuration.

Parameters:

configuration - the new Configuration

Returns:

the DeviceConfiguration after the update

updateDeviceInformation

DeviceInfo updateDeviceInformation(DeviceInfo info)

Updates the DeviceInfo associated with the current device. The new DeviceInfo is set as the current DeviceInfo of the Device, and the Device is saved to the DB together with the updated DeviceInfo.

Parameters:

info - the new DeviceInfo

Returns:

the DeviceInfo after the update

getConfiguration

DeviceConfiguration getConfiguration()

Returns:

the current configuration of the Device associated with the DeviceService instance

getConfigurations

java.util.List<DeviceConfiguration> getConfigurations()

Returns:

the list of DeviceConfigurations of the Device associated with the DeviceService instance

isRunning

boolean isRunning()

Returns:

true if the Device associated with the DeviceService instance is running, false otherwise

startDevice

boolean startDevice()
             throws DeviceException

Starts the Device associated with the DeviceService instance, if it is not running yet, and if it was possible to start. A Device can be started if it has a DeviceConfiguration with an Intersection in it.

Throws:

DeviceException

stopDevice

boolean stopDevice()
            throws DeviceException

Stops the Device associated with the DeviceService instance, in case it was running.

Throws:

DeviceException

getDataEntries

java.util.List<DataEntry> getDataEntries(java.util.Date startDate,
                                         java.util.Date endDate)

Retrieves the list of DataEntry within the provided time range for the Device associated with the DeviceService instance. If no DataEntry for the provided period is found, or if the start and end provided dates are inconsistent an empty list is returned.

Parameters:

startDate - the start date

endDate - the end date

Returns:

the list of DataEntry of the Device for the given period, or an empty list

getCurrentDataEntry

DataEntry getCurrentDataEntry(java.util.Date timestamp)

Parameters:

timestamp - the Date

Returns:

the DataEntry for the provided Date, or null, if there is none