Package org.opentcs.components.kernel.services

Schnittstelle InternalVehicleService

Alle Superschnittstellen:

TCSObjectService, VehicleService

public interface InternalVehicleService
extends VehicleService

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

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	updateVehicleAllocatedResources(TCSObjectReference<Vehicle> ref, List<Set<TCSResourceReference<?>>> resources)	Updates a vehicle's allocated resources.
default void	updateVehicleBoundingBox(TCSObjectReference<Vehicle> ref, BoundingBox boundingBox)	Updates the vehicle's bounding box.
void	updateVehicleClaimedResources(TCSObjectReference<Vehicle> ref, List<Set<TCSResourceReference<?>>> resources)	Updates a vehicle's claimed resources.
void	updateVehicleEnergyLevel(TCSObjectReference<Vehicle> ref, int energyLevel)	Updates a vehicle's energy level.
void	updateVehicleLength(TCSObjectReference<Vehicle> ref, int length)	Veraltet. Use updateVehicleBoundingBox(TCSObjectReference, BoundingBox) instead.
void	updateVehicleLoadHandlingDevices(TCSObjectReference<Vehicle> ref, List<LoadHandlingDevice> devices)	Updates a vehicle's load handling devices.
void	updateVehicleNextPosition(TCSObjectReference<Vehicle> vehicleRef, TCSObjectReference<Point> pointRef)	Updates the point which a vehicle is expected to occupy next.
void	updateVehicleOrderSequence(TCSObjectReference<Vehicle> vehicleRef, TCSObjectReference<OrderSequence> sequenceRef)	Updates a vehicle's order sequence.
void	updateVehicleOrientationAngle(TCSObjectReference<Vehicle> ref, double angle)	Veraltet. Use updateVehiclePose(TCSObjectReference,Pose) instead.
default void	updateVehiclePose(TCSObjectReference<Vehicle> ref, Pose pose)	Updates the vehicle's pose.
void	updateVehiclePosition(TCSObjectReference<Vehicle> vehicleRef, TCSObjectReference<Point> pointRef)	Places a vehicle on a point.
void	updateVehiclePrecisePosition(TCSObjectReference<Vehicle> ref, Triple position)	Veraltet. Use updateVehiclePose(TCSObjectReference,Pose) instead.
void	updateVehicleProcState(TCSObjectReference<Vehicle> ref, Vehicle.ProcState state)	Updates a vehicle's processing state.
void	updateVehicleRechargeOperation(TCSObjectReference<Vehicle> ref, String rechargeOperation)	Updates a vehicle's recharge operation.
void	updateVehicleState(TCSObjectReference<Vehicle> ref, Vehicle.State state)	Updates a vehicle's state.
void	updateVehicleTransportOrder(TCSObjectReference<Vehicle> vehicleRef, TCSObjectReference<TransportOrder> orderRef)	Updates a vehicle's transport order.

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

appendObjectHistoryEntry, fetchObject, fetchObject, fetchObjects, fetchObjects, updateObjectProperty

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

attachCommAdapter, disableCommAdapter, enableCommAdapter, fetchAttachmentInformation, fetchProcessModel, sendCommAdapterCommand, sendCommAdapterMessage, updateVehicleAllowedOrderTypes, updateVehicleEnergyLevelThresholdSet, updateVehicleEnvelopeKey, updateVehicleIntegrationLevel, updateVehiclePaused

Methodendetails

updateVehicleEnergyLevel

void updateVehicleEnergyLevel(TCSObjectReference<Vehicle> ref,
 int energyLevel)
                       throws ObjectUnknownException

Updates a vehicle's energy level.

Parameter:

ref - A reference to the vehicle to be modified.

energyLevel - The vehicle's new energy level.

Löst aus:

ObjectUnknownException - If the referenced vehicle does not exist.

updateVehicleLoadHandlingDevices

void updateVehicleLoadHandlingDevices(TCSObjectReference<Vehicle> ref,
 List<LoadHandlingDevice> devices)
                               throws ObjectUnknownException

Updates a vehicle's load handling devices.

Parameter:

ref - A reference to the vehicle to be modified.

devices - The vehicle's new load handling devices.

Löst aus:

ObjectUnknownException - If the referenced vehicle does not exist.

updateVehicleNextPosition

void updateVehicleNextPosition(TCSObjectReference<Vehicle> vehicleRef,
 TCSObjectReference<Point> pointRef)
                        throws ObjectUnknownException

Updates the point which a vehicle is expected to occupy next.

Parameter:

vehicleRef - A reference to the vehicle to be modified.

pointRef - A reference to the point which the vehicle is expected to occupy next.

Löst aus:

ObjectUnknownException - If the referenced vehicle does not exist.

updateVehicleOrderSequence

void updateVehicleOrderSequence(TCSObjectReference<Vehicle> vehicleRef,
 TCSObjectReference<OrderSequence> sequenceRef)
                         throws ObjectUnknownException

Updates a vehicle's order sequence.

Parameter:

vehicleRef - A reference to the vehicle to be modified.

sequenceRef - A reference to the order sequence the vehicle processes.

Löst aus:

ObjectUnknownException - If the referenced vehicle does not exist.

updateVehicleOrientationAngle

@Deprecated
@ScheduledApiChange(when="7.0",
                    details="Will be removed.")
void updateVehicleOrientationAngle(TCSObjectReference<Vehicle> ref,
 double angle)
                            throws ObjectUnknownException

Veraltet.

Use updateVehiclePose(TCSObjectReference,Pose) instead.

Updates the vehicle's current orientation angle (-360..360 degrees, or Double.NaN, if the vehicle doesn't provide an angle).

Parameter:

ref - A reference to the vehicle to be modified.

angle - The vehicle's orientation angle.

Löst aus:

ObjectUnknownException - If the referenced vehicle does not exist.

updateVehiclePosition

void updateVehiclePosition(TCSObjectReference<Vehicle> vehicleRef,
 TCSObjectReference<Point> pointRef)
                    throws ObjectUnknownException

Places a vehicle on a point.

Parameter:

vehicleRef - A reference to the vehicle to be modified.

pointRef - A reference to the point on which the vehicle is to be placed.

Löst aus:

ObjectUnknownException - If the referenced vehicle does not exist.

updateVehiclePrecisePosition

@Deprecated
@ScheduledApiChange(when="7.0",
                    details="Will be removed.")
void updateVehiclePrecisePosition(TCSObjectReference<Vehicle> ref,
 Triple position)
                           throws ObjectUnknownException

Veraltet.

Use updateVehiclePose(TCSObjectReference,Pose) instead.

Updates the vehicle's current precise position in mm.

Parameter:

ref - A reference to the vehicle to be modified.

position - The vehicle's precise position in mm.

Löst aus:

ObjectUnknownException - If the referenced vehicle does not exist.

updateVehiclePose

@ScheduledApiChange(when="7.0",
                    details="Default implementation will be removed.")
default void updateVehiclePose(TCSObjectReference<Vehicle> ref,
 Pose pose)
                        throws ObjectUnknownException

Updates the vehicle's pose.

Parameter:

ref - A reference to the vehicle to be modified.

pose - The vehicle's new pose.

Löst aus:

ObjectUnknownException - If the referenced vehicle does not exist.

updateVehicleProcState

void updateVehicleProcState(TCSObjectReference<Vehicle> ref,
 Vehicle.ProcState state)
                     throws ObjectUnknownException

Updates a vehicle's processing state.

Parameter:

ref - A reference to the vehicle to be modified.

state - The vehicle's new processing state.

Löst aus:

ObjectUnknownException - If the referenced vehicle does not exist.

updateVehicleRechargeOperation

void updateVehicleRechargeOperation(TCSObjectReference<Vehicle> ref,
 String rechargeOperation)
                             throws ObjectUnknownException

Updates a vehicle's recharge operation.

Parameter:

ref - A reference to the vehicle to be modified.

rechargeOperation - The vehicle's new recharge action.

Löst aus:

ObjectUnknownException - If the referenced vehicle does not exist.

updateVehicleClaimedResources

void updateVehicleClaimedResources(TCSObjectReference<Vehicle> ref,
 List<Set<TCSResourceReference<?>>> resources)
                            throws ObjectUnknownException

Updates a vehicle's claimed resources.

Parameter:

ref - A reference to the vehicle to be modified.

resources - The new resources.

Löst aus:

ObjectUnknownException - If the referenced vehicle does not exist.

updateVehicleAllocatedResources

void updateVehicleAllocatedResources(TCSObjectReference<Vehicle> ref,
 List<Set<TCSResourceReference<?>>> resources)
                              throws ObjectUnknownException

Updates a vehicle's allocated resources.

Parameter:

ref - A reference to the vehicle to be modified.

resources - The new resources.

Löst aus:

ObjectUnknownException - If the referenced vehicle does not exist.

updateVehicleState

void updateVehicleState(TCSObjectReference<Vehicle> ref,
 Vehicle.State state)
                 throws ObjectUnknownException

Updates a vehicle's state.

Parameter:

ref - A reference to the vehicle to be modified.

state - The vehicle's new state.

Löst aus:

ObjectUnknownException - If the referenced vehicle does not exist.

updateVehicleLength

@Deprecated
@ScheduledApiChange(when="7.0",
                    details="Will be removed.")
void updateVehicleLength(TCSObjectReference<Vehicle> ref,
 int length)
                  throws ObjectUnknownException

Veraltet.

Use updateVehicleBoundingBox(TCSObjectReference, BoundingBox) instead.

Updates a vehicle's length.

Parameter:

ref - A reference to the vehicle to be modified.

length - The vehicle's new length.

Löst aus:

ObjectUnknownException - If the referenced vehicle does not exist.

updateVehicleBoundingBox

@ScheduledApiChange(when="7.0",
                    details="Default implementation will be removed.")
default void updateVehicleBoundingBox(TCSObjectReference<Vehicle> ref,
 BoundingBox boundingBox)
                               throws ObjectUnknownException,
KernelRuntimeException

Updates the vehicle's bounding box.

Parameter:

ref - A reference to the vehicle.

boundingBox - The vehicle's new bounding box (in mm).

Löst aus:

ObjectUnknownException - If the referenced vehicle does not exist.

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

updateVehicleTransportOrder

void updateVehicleTransportOrder(TCSObjectReference<Vehicle> vehicleRef,
 TCSObjectReference<TransportOrder> orderRef)
                          throws ObjectUnknownException

Updates a vehicle's transport order.

Parameter:

vehicleRef - A reference to the vehicle to be modified.

orderRef - A reference to the transport order the vehicle processes.

Löst aus:

ObjectUnknownException - If the referenced vehicle does not exist.