Package org.opentcs.components.kernel.services

Schnittstelle PlantModelService

Alle Superschnittstellen:

TCSObjectService

Alle bekannten Unterschnittstellen:

InternalPlantModelService

public interface PlantModelService
extends TCSObjectService

Provides methods concerning the plant model.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	createPlantModel(PlantModelCreationTO to)	Creates a new plant model with the objects described in the given transfer object.
String	getModelName()	Returns the name of the model that is currently loaded in the kernel.
Map<String,String>	getModelProperties()	Returns the model's properties.
PlantModel	getPlantModel()	Returns a representation of the plant model's current state.
void	updateLocationLock(TCSObjectReference<Location> ref, boolean locked)	Updates a location's lock state.
void	updatePathLock(TCSObjectReference<Path> ref, boolean locked)	Updates a path's lock state.

Von Schnittstelle geerbte Methoden org.opentcs.components.kernel.services.TCSObjectService

appendObjectHistoryEntry, fetchObject, fetchObject, fetchObjects, fetchObjects, updateObjectProperty

Methodendetails

getPlantModel

PlantModel getPlantModel()
                  throws KernelRuntimeException

Returns a representation of the plant model's current state.

Gibt zurück:

The complete plant model.

Löst aus:

KernelRuntimeException - In case there is an exception executing this method.

createPlantModel

void createPlantModel(PlantModelCreationTO to)
               throws ObjectUnknownException,
ObjectExistsException,
KernelRuntimeException,
IllegalStateException

Creates a new plant model with the objects described in the given transfer object. Implicitly saves/persists the new plant model.

Parameter:

to - The transfer object describing the plant model objects to be created.

Löst aus:

ObjectUnknownException - If any referenced object does not exist.

ObjectExistsException - If an object with the same name already exists in the model.

KernelRuntimeException - In case there is an exception executing this method.

IllegalStateException - If there was a problem persisting the model.

getModelName

String getModelName()
             throws KernelRuntimeException

Returns the name of the model that is currently loaded in the kernel.

Gibt zurück:

The name of the currently loaded model.

Löst aus:

KernelRuntimeException - In case there is an exception executing this method.

getModelProperties

Map<String,String> getModelProperties()
                               throws KernelRuntimeException

Returns the model's properties.

Gibt zurück:

The model's properties.

Löst aus:

KernelRuntimeException - In case there is an exception executing this method.

updateLocationLock

void updateLocationLock(TCSObjectReference<Location> ref,
 boolean locked)
                 throws ObjectUnknownException,
KernelRuntimeException

Updates a location's lock state.

Parameter:

ref - A reference to the location to be updated.

locked - Indicates whether the location is to be locked (true) or unlocked (false).

Löst aus:

ObjectUnknownException - If the referenced location does not exist.

KernelRuntimeException - In case there is an exception executing this method.

updatePathLock

void updatePathLock(TCSObjectReference<Path> ref,
 boolean locked)
             throws ObjectUnknownException,
KernelRuntimeException

Updates a path's lock state.

Parameter:

ref - A reference to the path to be updated.

locked - Indicates whether the path is to be locked (true) or unlocked (false).

Löst aus:

ObjectUnknownException - If the referenced path does not exist.

KernelRuntimeException - In case there is an exception executing this method.