Package org.opentcs.components.kernel.services

Schnittstelle InternalPlantModelService

Alle Superschnittstellen:

PlantModelService, TCSObjectService

public interface InternalPlantModelService
extends PlantModelService

Declares the methods the plant model service must provide which are not accessible to remote peers.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
Set<TCSResource<?>>	expandResources(Set<TCSResourceReference<?>> resources)	Expands a set of resources A to a set of resources B.
void	loadPlantModel()	Loads the saved model into the kernel.
void	savePlantModel()	Saves the current model under the given name.

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

createPlantModel, getModelName, getModelProperties, getPlantModel, updateLocationLock, updatePathLock

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

appendObjectHistoryEntry, fetchObject, fetchObject, fetchObjects, fetchObjects, updateObjectProperty

Methodendetails

expandResources

Set<TCSResource<?>> expandResources(Set<TCSResourceReference<?>> resources)
                             throws ObjectUnknownException

Expands a set of resources A to a set of resources B. B contains the resources in A with blocks expanded to their actual members. The given set is not modified.

Parameter:

resources - The set of resources to be expanded.

Gibt zurück:

The given set with resources expanded.

Löst aus:

ObjectUnknownException - If any of the referenced objects does not exist.

loadPlantModel

void loadPlantModel()
             throws IllegalStateException

Loads the saved model into the kernel. If there is no saved model, a new empty model will be loaded.

Löst aus:

IllegalStateException - If the model cannot be loaded.

savePlantModel

void savePlantModel()
             throws IllegalStateException

Saves the current model under the given name. If there is a saved model, it will be overwritten.

Löst aus:

IllegalStateException - If the model could not be persisted for some reason.