fr.liglab.adele.icasa.simulator

Interface SimulationManager

All Superinterfaces:

ContextManager

public interface SimulationManager
extends ContextManager

The simulation Mananger deals with operations associated to simulation

Author:

Gabriel Pedraza Ferreira

Field Summary

Fields inherited from interface fr.liglab.adele.icasa.ContextManager

GATEWAY_ID_PROP_NAME

Method Summary

Methods

Modifier and Type	Method and Description
Person	addPerson(String personName, String personType) Creates an instance of a new simulated person.
PersonType	addPersonType(String personType) Add a new person type to the simulation only if it not exist.
void	attachDeviceToPerson(String deviceId, String personId) Attach a device to a person, When moving the person, the device will be also moved
void	attachDeviceToZone(String deviceId, String zoneId) Attach a device to a zone.
void	attachPersonToZone(String personId, String zoneId) Attach a person to a zone.
void	attachZoneToDevice(String zoneId, String deviceId) Attach a zone to a device.
LocatedDevice	createDevice(String deviceType, String deviceId, Map<String,Object> properties) Creates an instance of a simulated device.
void	detachDeviceFromPerson(String deviceId, String personId) Detach a device from a person.
void	detachDeviceFromZone(String deviceId, String zoneId) Detach a device from a zone.
void	detachPersonFromZone(String personId, String zoneId) Detach a person from a zone.
void	detachZoneFromDevice(String zoneId, String deviceId) Detach a zone from the device.
Person	getPerson(String personName) Get a person instance currently available in iCasa simulator.
List<Person>	getPersons() Retrieves the list of tha available person in the iCasa simulator.
Set<Person>	getPersonsIntoZone(Zone zone) Gets a set with person in the specified zone
PersonType	getPersonType(String personType) Get the person type if exist.
List<PersonType>	getPersonTypes() Get an non-modifiable list of person types available.
Set<String>	getSimulatedDeviceTypes() Get a non-modifiable set of the device types available in the iCasa context.
void	removeAllDevices() Removes all simulated device instance in iCasa.
void	removeAllPersons() Removes all simulated persons in iCasa.
void	removeDevice(String deviceId) Removes a simulated device instance.
void	removePerson(String personName) Removes a person currently available in iCasa simulator.
void	removePersonType(String personType) Removes a person type and all created persons having the removed type.
void	setDeviceFault(String deviceId, boolean value) Simulates a fail/reparation in a device.
void	setPersonPosition(String personName, Position position) Change the position of a given person.
void	setPersonZone(String personName, String zoneId) Moves a person to a zone, into a random generated position inside the given zone.

Methods inherited from interface fr.liglab.adele.icasa.ContextManager

addGlobalVariable, addListener, addZoneVariable, createZone, createZone, getDevice, getDeviceIds, getDevicePosition, getDevices, getDeviceTypes, getGenericDevice, getGlobalVariables, getGlobalVariableValue, getProvidedServices, getProvidedServices, getZone, getZoneFromPosition, getZoneIds, getZones, getZoneVariables, getZoneVariableValue, moveDeviceIntoZone, moveZone, removeAllZones, removeListener, removeZone, resetContext, resizeZone, setDevicePosition, setDeviceState, setGlobalVariable, setParentZone, setZoneVariable

Method Detail

setDeviceFault

void setDeviceFault(String deviceId,
                  boolean value)

Simulates a fail/reparation in a device.

Parameters:

deviceId - The device to manipulate.

value - true to simulate a fail. falseto repair.

createDevice

LocatedDevice createDevice(String deviceType,
                         String deviceId,
                         Map<String,Object> properties)

Creates an instance of a simulated device.

Parameters:

deviceType - The device type

deviceId - The new device identifier.

properties - The properties for the new simulated device.

Returns:

The device wrapper object.

Throws:

IllegalArgumentException - if a device instance exists with the same identifier.

IllegalStateException - if there no exists a factory matching the deviceType argument.

See Also:

LocatedDevice

removeDevice

void removeDevice(String deviceId)

Removes a simulated device instance.

Parameters:

deviceId - The identifier of the simulated device.

getSimulatedDeviceTypes

Set<String> getSimulatedDeviceTypes()

Get a non-modifiable set of the device types available in the iCasa context. The device type corresponds to the component factory name.

Returns:

a set of the device types.

removeAllDevices

void removeAllDevices()

Removes all simulated device instance in iCasa.

setPersonPosition

void setPersonPosition(String personName,
                     Position position)

Change the position of a given person.

Parameters:

personName - the name of the person to move.

position - the new position center absolute position

See Also:

LocatedObject.getCenterAbsolutePosition()

setPersonZone

void setPersonZone(String personName,
                 String zoneId)

Moves a person to a zone, into a random generated position inside the given zone.

Parameters:

personName - the name of the person.

zoneId - the zone identifier.

removeAllPersons

void removeAllPersons()

Removes all simulated persons in iCasa.

addPerson

Person addPerson(String personName,
               String personType)

Creates an instance of a new simulated person. There are six person types available [Grandfather, Grandmother,Father, Mother, Boy, Girl].

Parameters:

personName - the new person name.

personType - the person type

Returns:

the created person.

Throws:

IllegalArgumentException - when a person with the same name exists or if no exist the personType.

See Also:

addPersonType(String)

getPerson

Person getPerson(String personName)

Get a person instance currently available in iCasa simulator.

Parameters:

personName - the person to retrieve.

Returns:

the Person object instance. null if does not exist.

removePerson

void removePerson(String personName)

Removes a person currently available in iCasa simulator.

Parameters:

personName -

getPersons

List<Person> getPersons()

Retrieves the list of tha available person in the iCasa simulator.

Returns:

an unmodifiable list of persons.

addPersonType

PersonType addPersonType(String personType)

Add a new person type to the simulation only if it not exist. The call of this method will trigger a personTypeAdded event only it is not already added.

Parameters:

personType - the new person type name.

See Also:

.

getPersonType

PersonType getPersonType(String personType)

Get the person type if exist.

Parameters:

personType - the person type name.

Returns:

the personType if exist, null if not.

removePersonType

void removePersonType(String personType)

Removes a person type and all created persons having the removed type.

Parameters:

personType - the person type name to remove.

getPersonTypes

List<PersonType> getPersonTypes()

Get an non-modifiable list of person types available.

Returns:

getPersonsIntoZone

Set<Person> getPersonsIntoZone(Zone zone)

Gets a set with person in the specified zone

Parameters:

zone - the zone

Returns:

the person set

attachZoneToDevice

void attachZoneToDevice(String zoneId,
                      String deviceId)

Attach a zone to a device. When moving the device, the zone will be also moved.

Parameters:

zoneId - the identifier of the zone.

deviceId - the identifier of the device.

See Also:

detachZoneFromDevice(String, String)

detachZoneFromDevice

void detachZoneFromDevice(String zoneId,
                        String deviceId)

Detach a zone from the device.

Parameters:

zoneId - the zone identifier.

deviceId - the device identifier.

See Also:

attachZoneToDevice(String, String)

attachDeviceToPerson

void attachDeviceToPerson(String deviceId,
                        String personId)

Attach a device to a person, When moving the person, the device will be also moved

Parameters:

deviceId - the device identifier.

personId - the person name.

See Also:

detachDeviceFromPerson(String, String)

detachDeviceFromPerson

void detachDeviceFromPerson(String deviceId,
                          String personId)

Detach a device from a person.

Parameters:

deviceId - the device identifier.

personId - the person name.

See Also:

attachDeviceToPerson(String, String)

attachPersonToZone

void attachPersonToZone(String personId,
                      String zoneId)

Attach a person to a zone. When moving the zone, the person will be also moved.

Parameters:

personId - the person name.

zoneId - the zone identifier.

See Also:

detachPersonFromZone(String, String)

detachPersonFromZone

void detachPersonFromZone(String personId,
                        String zoneId)

Detach a person from a zone.

Parameters:

personId - the person name.

zoneId - the zone identifier.

See Also:

attachPersonToZone(String, String)

attachDeviceToZone

void attachDeviceToZone(String deviceId,
                      String zoneId)

Attach a device to a zone. When moving the zone, the device will be also moved.

Parameters:

deviceId - the device identifier.

zoneId - the zone identifier.

See Also:

detachDeviceFromZone(String, String)

detachDeviceFromZone

void detachDeviceFromZone(String deviceId,
                        String zoneId)

Detach a device from a zone.

Parameters:

deviceId - the device identifier.

zoneId - the zone identifier.

See Also:

(String, String)