Package org.opentcs.components.kernel.services

Schnittstelle InternalPeripheralService

Alle Superschnittstellen:

PeripheralService, TCSObjectService

public interface InternalPeripheralService
extends PeripheralService

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

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	updatePeripheralJob(TCSResourceReference<Location> ref, TCSObjectReference<PeripheralJob> peripheralJob)	Updates a peripheral's current peripheral job.
void	updatePeripheralProcState(TCSResourceReference<Location> ref, PeripheralInformation.ProcState state)	Updates a peripheral's processing state.
void	updatePeripheralReservationToken(TCSResourceReference<Location> ref, String reservationToken)	Updates a peripheral's reservation token.
void	updatePeripheralState(TCSResourceReference<Location> ref, PeripheralInformation.State state)	Updates a peripheral's state.

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

attachCommAdapter, disableCommAdapter, enableCommAdapter, fetchAttachmentInformation, fetchProcessModel, sendCommAdapterCommand

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

appendObjectHistoryEntry, fetchObject, fetchObject, fetchObjects, fetchObjects, updateObjectProperty

Methodendetails

updatePeripheralProcState

void updatePeripheralProcState(TCSResourceReference<Location> ref,
 PeripheralInformation.ProcState state)
                        throws ObjectUnknownException

Updates a peripheral's processing state.

Parameter:

ref - A reference to the location to be modified.

state - The peripheral's new processing state.

Löst aus:

ObjectUnknownException - If the referenced location does not exist.

updatePeripheralReservationToken

void updatePeripheralReservationToken(TCSResourceReference<Location> ref,
 String reservationToken)
                               throws ObjectUnknownException

Updates a peripheral's reservation token.

Parameter:

ref - A reference to the location to be modified.

reservationToken - The peripheral's new reservation token.

Löst aus:

ObjectUnknownException - If the referenced location does not exist.

updatePeripheralState

void updatePeripheralState(TCSResourceReference<Location> ref,
 PeripheralInformation.State state)
                    throws ObjectUnknownException

Updates a peripheral's state.

Parameter:

ref - A reference to the location to be modified.

state - The peripheral's new state.

Löst aus:

ObjectUnknownException - If the referenced location does not exist.

updatePeripheralJob

void updatePeripheralJob(TCSResourceReference<Location> ref,
 TCSObjectReference<PeripheralJob> peripheralJob)
                  throws ObjectUnknownException

Updates a peripheral's current peripheral job.

Parameter:

ref - A reference to the location to be modified.

peripheralJob - A reference to the peripheral job the peripheral device processes.

Löst aus:

ObjectUnknownException - If the referenced location does not exist.