Index

A B C D E F G H I J K L M N O P Q R S T U V W 
All Classes All Packages

A

abortDriveOrder() - Method in interface org.opentcs.drivers.vehicle.VehicleController
Notifies the controller that the current drive order is to be aborted.
ACTIVE - org.opentcs.data.order.TransportOrder.State
Set (by a user/client) when a transport order's parameters have been set up completely and the kernel should dispatch it when possible.
ActiveInAllModes - Annotation Type in org.opentcs.customizations.kernel
Annotation type for binding injectable components meant to be used in all kernel modes.
ActiveInModellingMode - Annotation Type in org.opentcs.customizations.controlcenter
Annotation type for binding injectable components meant to be used in modelling mode.
ActiveInModellingMode - Annotation Type in org.opentcs.customizations.kernel
Annotation type for binding injectable components meant to be used in modelling mode.
ActiveInOperatingMode - Annotation Type in org.opentcs.customizations.controlcenter
Annotation type for binding injectable components meant to be used in operating mode.
ActiveInOperatingMode - Annotation Type in org.opentcs.customizations.kernel
Annotation type for binding injectable components meant to be used in operating mode.
AdapterCommand - Interface in org.opentcs.drivers.vehicle
A command a comm adapter may execute.
addKernelExtension(KernelExtension) - Method in interface org.opentcs.access.LocalKernel
Adds a KernelExtension to this kernel.
addPropertyChangeListener(PropertyChangeListener) - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Registers a new property change listener with this model.
AFTER_MOVEMENT - org.opentcs.data.peripherals.PeripheralOperation.ExecutionTrigger
 
allocate(Scheduler.Client, Set<TCSResource<?>>) - Method in interface org.opentcs.components.kernel.Scheduler
Requests allocation of the given resources.
allocateNow(Scheduler.Client, Set<TCSResource<?>>) - Method in interface org.opentcs.components.kernel.Scheduler
Informs the scheduler that a set of resources are to be allocated for the given client immediately, i.e.
allocationFailed(Set<TCSResource<?>>) - Method in interface org.opentcs.components.kernel.Scheduler.Client
Called if it was impossible to allocate a requested set of resources for this client.
allocationReleased(Scheduler.Client, Set<TCSResource<?>>) - Method in interface org.opentcs.components.kernel.Scheduler.Module
Informs this module about resources being fully released by a client.
allocationSuccessful(Set<TCSResource<?>>) - Method in interface org.opentcs.components.kernel.Scheduler.Client
Called when resources have been reserved for this client.
appendObjectHistoryEntry(ClientID, TCSObjectReference<?>, ObjectHistory.Entry) - Method in interface org.opentcs.access.rmi.services.RemoteTCSObjectService
 
appendObjectHistoryEntry(TCSObjectReference<?>, ObjectHistory.Entry) - Method in interface org.opentcs.components.kernel.services.TCSObjectService
Appends a history entry to a TCSObject.
ApplicationEventBus - Annotation Type in org.opentcs.customizations
Annotation type to mark a single application-wide injectable EventBus.
ApplicationFrame - Annotation Type in org.opentcs.customizations.plantoverview
Annotation type to mark the application's main frame.
ApplicationHome - Annotation Type in org.opentcs.customizations
A binding annotation that can be used to have the application's home directory injected.
Assertions - Class in org.opentcs.util
Utility methods for checking preconditions, postconditions etc..
asStringArray(Class<E>) - Static method in class org.opentcs.util.Enums
Returns the String representations of all elements of the given enum class as an array.
asStringSet(Class<? extends Enum<?>>) - Static method in class org.opentcs.util.Enums
Returns the String representations of all elements of the given enum class as a set.
attachCommAdapter(ClientID, TCSResourceReference<Location>, PeripheralCommAdapterDescription) - Method in interface org.opentcs.access.rmi.services.RemotePeripheralService
 
attachCommAdapter(ClientID, TCSObjectReference<Vehicle>, VehicleCommAdapterDescription) - Method in interface org.opentcs.access.rmi.services.RemoteVehicleService
 
attachCommAdapter(TCSResourceReference<Location>, PeripheralCommAdapterDescription) - Method in interface org.opentcs.components.kernel.services.PeripheralService
Attaches the described comm adapter to the referenced location.
attachCommAdapter(TCSObjectReference<Vehicle>, VehicleCommAdapterDescription) - Method in interface org.opentcs.components.kernel.services.VehicleService
Attaches the described comm adapter to the referenced vehicle.
AttachmentEvent - Class in org.opentcs.drivers.vehicle.management
Instances of this class represent events emitted by/for attaching comm adapters.
AttachmentEvent(String, AttachmentInformation) - Constructor for class org.opentcs.drivers.vehicle.management.AttachmentEvent
Creates a new instance.
AttachmentInformation - Class in org.opentcs.drivers.vehicle.management
Describes which communication adapter a vehicle is currently associated with and which adapters are available.
AttachmentInformation(TCSObjectReference<Vehicle>, List<VehicleCommAdapterDescription>, VehicleCommAdapterDescription) - Constructor for class org.opentcs.drivers.vehicle.management.AttachmentInformation
Creates a new instance.
AWAITING_ORDER - org.opentcs.data.model.Vehicle.ProcState
The vehicle is currently processing a transport order and is waiting for the next drive order to be assigned to it.

B

BACKWARD - org.opentcs.data.model.Vehicle.Orientation
Indicates that the vehicle is driving/standing oriented towards its back.
BasicPeripheralCommAdapter - Class in org.opentcs.drivers.peripherals
A base class for peripheral communication adapters mainly providing command queue processing.
BasicPeripheralCommAdapter(PeripheralProcessModel, EventHandler) - Constructor for class org.opentcs.drivers.peripherals.BasicPeripheralCommAdapter
Creates a new instance.
BasicVehicleCommAdapter - Class in org.opentcs.drivers.vehicle
A base class for communication adapters mainly providing command queue processing.
BasicVehicleCommAdapter(VehicleProcessModel, int, int, String, Executor) - Constructor for class org.opentcs.drivers.vehicle.BasicVehicleCommAdapter
Creates a new instance.
BEFORE_MOVEMENT - org.opentcs.data.peripherals.PeripheralOperation.ExecutionTrigger
 
BEING_PROCESSED - org.opentcs.data.order.TransportOrder.State
Marks a transport order as being processed by a vehicle.
BEING_PROCESSED - org.opentcs.data.peripherals.PeripheralJob.State
 
BEZIER - org.opentcs.data.model.Path.Layout.ConnectionType
A bezier curve with 2 control points.
BEZIER_3 - org.opentcs.data.model.Path.Layout.ConnectionType
A bezier curve with 3 control points.
Block - Class in org.opentcs.data.model
An aggregation of resources with distinct usage rules depending on the block's type.
Block(String) - Constructor for class org.opentcs.data.model.Block
Creates an empty block.
BLOCK_COLOR - Static variable in interface org.opentcs.data.model.visualization.ElementPropKeys
Color in which block elements are to be emphasized.
Block.Layout - Class in org.opentcs.data.model
Contains information regarding the grahical representation of a block.
Block.Type - Enum in org.opentcs.data.model
Describes the types of blocks in a driving course.
BlockCreationTO - Class in org.opentcs.access.to.model
A transfer object describing a block in the plant model.
BlockCreationTO(String) - Constructor for class org.opentcs.access.to.model.BlockCreationTO
Creates a new instance.
BlockCreationTO.Layout - Class in org.opentcs.access.to.model
Contains information regarding the grahical representation of a block.
build() - Method in class org.opentcs.access.rmi.KernelServicePortalBuilder
Builds and returns a KernelServicePortal with the configured parameters.

C

call(Runnable) - Method in interface org.opentcs.util.CallWrapper
Calls a mehtod that has no return value.
call(Callable<R>) - Method in interface org.opentcs.util.CallWrapper
Calls a method that has a return value.
CallWrapper - Interface in org.opentcs.util
Provides methods for wrapping other method calls.
canProcess(List<String>) - Method in interface org.opentcs.drivers.vehicle.VehicleCommAdapter
Checks if the vehicle would be able to process the given sequence of operations, taking into account its current state.
canProcess(List<String>) - Method in interface org.opentcs.drivers.vehicle.VehicleController
Checks if the vehicle would be able to process the given sequence of operations, taking into account its current state.
canProcess(PeripheralJob) - Method in interface org.opentcs.drivers.peripherals.PeripheralCommAdapter
Checks if the peripheral device would be able to process the given job, taking into account its current state.
canProcess(PeripheralJob) - Method in interface org.opentcs.drivers.peripherals.PeripheralController
Checks if the peripheral device would be able to process the given job, taking into account its current state.
canSendNextCommand() - Method in class org.opentcs.drivers.vehicle.BasicVehicleCommAdapter
Checks whether a new command can be sent to the vehicle.
CHARGING - org.opentcs.data.model.Vehicle.State
The vehicle is currently recharging its battery/refilling fuel.
checkArgument(boolean, String) - Static method in class org.opentcs.util.Assertions
Ensures the given expression is true.
checkArgument(boolean, String, Object...) - Static method in class org.opentcs.util.Assertions
Ensures the given expression is true.
checkInRange(int, int, int) - Static method in class org.opentcs.util.Assertions
Ensures that value is not smaller than minimum and not greater than maximum.
checkInRange(int, int, int, String) - Static method in class org.opentcs.util.Assertions
Ensures that value is not smaller than minimum and not greater than maximum.
checkInRange(long, long, long) - Static method in class org.opentcs.util.Assertions
Ensures that value is not smaller than minimum and not greater than maximum.
checkInRange(long, long, long, String) - Static method in class org.opentcs.util.Assertions
Ensures that value is not smaller than minimum and not greater than maximum.
checkRoutability(TransportOrder) - Method in interface org.opentcs.components.kernel.Router
Checks the general routability of a given transport order.
checkState(boolean, String) - Static method in class org.opentcs.util.Assertions
Ensures the given expression is true.
checkState(boolean, String, Object...) - Static method in class org.opentcs.util.Assertions
Ensures the given expression is true.
claim(Scheduler.Client, List<Set<TCSResource<?>>>) - Method in interface org.opentcs.components.kernel.Scheduler
Claims a set of resources for a vehicle.
claim(Scheduler.Client, List<Set<TCSResource<?>>>) - Method in interface org.opentcs.components.kernel.Scheduler.Module
Sets a client's total claim.
ClassMatcher - Class in org.opentcs.util
Checks whether the input argument is assignable to any of a given set of classes.
ClassMatcher(Class<?>...) - Constructor for class org.opentcs.util.ClassMatcher
Creates a new instance.
clearCommandQueue() - Method in class org.opentcs.drivers.vehicle.BasicVehicleCommAdapter
 
clearCommandQueue() - Method in interface org.opentcs.drivers.vehicle.VehicleCommAdapter
Clears this communication adapter's command queue.
clearCommandQueue() - Method in interface org.opentcs.drivers.vehicle.VehicleController
Clears the associated vehicle's command queue and frees all resources reserved for the removed commands/movements.
clearDriveOrder() - Method in interface org.opentcs.drivers.vehicle.VehicleController
Resets the current drive order for the vehicle associated with this controller.
ClearError - Class in org.opentcs.drivers.vehicle.messages
A message that informs a communication adapter that it/the vehicle should reset currently active errors if possible.
ClearError() - Constructor for class org.opentcs.drivers.vehicle.messages.ClearError
Creates a new instance.
ClientID - Class in org.opentcs.access.rmi
Identifies a remote client unambiguously.
ClientID(String) - Constructor for class org.opentcs.access.rmi.ClientID
Creates a new ClientID.
close() - Method in interface org.opentcs.access.SharedKernelServicePortal
 
COMM_ADAPTER_CONNECTED - org.opentcs.drivers.peripherals.PeripheralProcessModel.Attribute
Indicates a change of the comm adapter connected property.
COMM_ADAPTER_CONNECTED - org.opentcs.drivers.vehicle.VehicleProcessModel.Attribute
Indicates a change of the comm adapter's connected setting.
COMM_ADAPTER_ENABLED - org.opentcs.drivers.peripherals.PeripheralProcessModel.Attribute
Indicates a change of the comm adapter enabled property.
COMM_ADAPTER_ENABLED - org.opentcs.drivers.vehicle.VehicleProcessModel.Attribute
Indicates a change of the comm adapter's enabled setting.
COMM_ADAPTER_EVENT - org.opentcs.drivers.vehicle.VehicleProcessModel.Attribute
Indicates a new comm adapter event was published.
CommAdapterEvent - Class in org.opentcs.drivers.vehicle.management
Instances of this class represent events emitted by/for comm adapter changes.
CommAdapterEvent() - Constructor for class org.opentcs.drivers.vehicle.management.CommAdapterEvent
Creates an empty event.
COMMAND_ENQUEUED - org.opentcs.drivers.vehicle.VehicleProcessModel.Attribute
Indicates a command was enqueued.
COMMAND_EXECUTED - org.opentcs.drivers.vehicle.VehicleProcessModel.Attribute
Indicates a command was executed successfully.
COMMAND_FAILED - org.opentcs.drivers.vehicle.VehicleProcessModel.Attribute
Indicates a command failed.
COMMAND_SENT - org.opentcs.drivers.vehicle.VehicleProcessModel.Attribute
Indicates a command was sent.
commandEnqueued(MovementCommand) - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Notifies observers that the given command has been added to the comm adapter's command queue.
commandExecuted(MovementCommand) - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Notifies observers that the given command has been executed by the comm adapter/vehicle.
commandFailed(MovementCommand) - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Notifies observers that the given command could not be executed by the comm adapter/vehicle.
commandSent(MovementCommand) - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Notifies observers that the given command has been sent to the associated vehicle.
computeWeight(Edge, Vehicle) - Method in interface org.opentcs.components.kernel.routing.EdgeEvaluator
Computes the weight of an edge in the routing graph.
ConfigurationBindingProvider - Interface in org.opentcs.configuration
A provider to get bindings (implementations) for configuration interfaces.
ConfigurationEntry - Annotation Type in org.opentcs.configuration
Marks an interface's method that provides a configuration value.
ConfigurationPrefix - Annotation Type in org.opentcs.configuration
Marks an interface that provides some configuration for a specific class.
connectPeripheral() - Method in class org.opentcs.drivers.peripherals.BasicPeripheralCommAdapter
Initiates a communication channel to the peripheral device.
connectVehicle() - Method in class org.opentcs.drivers.vehicle.BasicVehicleCommAdapter
Initiates a communication channel to the vehicle.
ControlCenterPanel - Class in org.opentcs.components.kernelcontrolcenter
A panel that can be plugged into the kernel control center.
ControlCenterPanel() - Constructor for class org.opentcs.components.kernelcontrolcenter.ControlCenterPanel
 
Couple - Class in org.opentcs.data.model
A generic 2-tuple of long integer values, usable for 2D coordinates and vectors, for instance.
Couple(long, long) - Constructor for class org.opentcs.data.model.Couple
Creates a new instance.
createCustomTransferableProcessModel() - Method in class org.opentcs.drivers.vehicle.BasicVehicleCommAdapter
Creates a transferable process model with the specific attributes of this comm adapter's process model set.
createOrderSequence(ClientID, OrderSequenceCreationTO) - Method in interface org.opentcs.access.rmi.services.RemoteTransportOrderService
 
createOrderSequence(OrderSequenceCreationTO) - Method in interface org.opentcs.components.kernel.services.TransportOrderService
Creates a new order sequence.
createPanel(Kernel.State) - Method in interface org.opentcs.components.plantoverview.PluggablePanelFactory
Returns a newly created panel.
createPeripheralJob(ClientID, PeripheralJobCreationTO) - Method in interface org.opentcs.access.rmi.services.RemotePeripheralJobService
 
createPeripheralJob(PeripheralJobCreationTO) - Method in interface org.opentcs.components.kernel.services.PeripheralJobService
Creates a peripheral job.
createPlantModel(ClientID, PlantModelCreationTO) - Method in interface org.opentcs.access.rmi.services.RemotePlantModelService
 
createPlantModel(PlantModelCreationTO) - Method in interface org.opentcs.components.kernel.services.PlantModelService
Creates a new plant model with the objects described in the given transfer object.
createTransferableProcessModel() - Method in class org.opentcs.drivers.vehicle.BasicVehicleCommAdapter
 
createTransferableProcessModel() - Method in interface org.opentcs.drivers.vehicle.VehicleCommAdapter
Returns a transferable/serializable model of the vehicle's and its comm adapter's attributes.
createTransportOrder(ClientID, TransportOrderCreationTO) - Method in interface org.opentcs.access.rmi.services.RemoteTransportOrderService
 
createTransportOrder(TransportOrderCreationTO) - Method in interface org.opentcs.components.kernel.services.TransportOrderService
Creates a new transport order.
CreationTO - Class in org.opentcs.access.to
The base class for all creation transfer objects.
CreationTO(String) - Constructor for class org.opentcs.access.to.CreationTO
Creates a new instance.
CreationTO(String, Map<String, String>) - Constructor for class org.opentcs.access.to.CreationTO
 
CredentialsException - Exception in org.opentcs.access
Thrown when there are insufficient user permissions to perform an operation.
CredentialsException() - Constructor for exception org.opentcs.access.CredentialsException
Constructs a CredentialsException with no detail message.
CredentialsException(String) - Constructor for exception org.opentcs.access.CredentialsException
Constructs a CredentialsException with the specified detail message.
CredentialsException(String, Throwable) - Constructor for exception org.opentcs.access.CredentialsException
Constructs a CredentialsException with the specified detail message and cause.
CredentialsException(Throwable) - Constructor for exception org.opentcs.access.CredentialsException
Constructs a CredentialsException with the specified cause and a detail message of (cause == null ? null : cause.toString()) (which typically contains the class and detail message of cause).
CyclicTask - Class in org.opentcs.util
A template for cyclic tasks.
CyclicTask(long) - Constructor for class org.opentcs.util.CyclicTask
Creates a new CyclicTask.

D

DEFAULT - org.opentcs.data.model.visualization.LocationRepresentation
The default representation inherited from the assigned location type.
DEFAULT_KEYSTORE_TYPE - Static variable in class org.opentcs.access.SslParameterSet
The default type used for truststore and keystore files.
DEFAULT_LAYER_GROUP_ID - Static variable in interface org.opentcs.data.model.ModelConstants
The ID of the default layer group.
DEFAULT_LAYER_GROUP_NAME - Static variable in interface org.opentcs.data.model.ModelConstants
The name of the default layer group.
DEFAULT_LAYER_ID - Static variable in interface org.opentcs.data.model.ModelConstants
The ID of the default layer.
DEFAULT_LAYER_NAME - Static variable in interface org.opentcs.data.model.ModelConstants
The name of the default layer.
DEFAULT_LAYER_ORDINAL - Static variable in interface org.opentcs.data.model.ModelConstants
The ordinal of the default layer.
DEFAULT_MODEL_NAME - Static variable in interface org.opentcs.access.Kernel
The default name used for the empty model created on startup.
DEFAULT_VISUAL_LAYOUT_NAME - Static variable in interface org.opentcs.data.model.ModelConstants
The default name for the visual layout.
DefaultVehicleCommAdapterDescription - Class in org.opentcs.drivers.vehicle
The default implementation of VehicleCommAdapterDescription.
DefaultVehicleCommAdapterDescription(String, boolean) - Constructor for class org.opentcs.drivers.vehicle.DefaultVehicleCommAdapterDescription
Creates a new instance.
description() - Method in annotation type org.opentcs.configuration.ConfigurationEntry
Returns a list of paragraphs describing what the key/value configures.
Destination(TCSObjectReference<?>) - Constructor for class org.opentcs.data.order.DriveOrder.Destination
Creates a new instance.
DestinationCreationTO - Class in org.opentcs.access.to.order
A transfer object describing a destination of a drive order.
DestinationCreationTO(String, String) - Constructor for class org.opentcs.access.to.order.DestinationCreationTO
Creates a new instance.
details() - Method in annotation type org.opentcs.util.annotations.ScheduledApiChange
Returns optional details about the scheduled change.
DIRECT - org.opentcs.data.model.Path.Layout.ConnectionType
A direct connection.
disable() - Method in class org.opentcs.drivers.peripherals.BasicPeripheralCommAdapter
Disables this comm adapter, i.e.
disable() - Method in interface org.opentcs.drivers.peripherals.PeripheralCommAdapter
Disables this comm adapter, i.e.
disable() - Method in class org.opentcs.drivers.vehicle.BasicVehicleCommAdapter
Disables this comm adapter, i.e.
disable() - Method in interface org.opentcs.drivers.vehicle.VehicleCommAdapter
Disables this comm adapter, i.e.
disableCommAdapter(ClientID, TCSResourceReference<Location>) - Method in interface org.opentcs.access.rmi.services.RemotePeripheralService
 
disableCommAdapter(ClientID, TCSObjectReference<Vehicle>) - Method in interface org.opentcs.access.rmi.services.RemoteVehicleService
 
disableCommAdapter(TCSResourceReference<Location>) - Method in interface org.opentcs.components.kernel.services.PeripheralService
Disables the comm adapter attached to the referenced location.
disableCommAdapter(TCSObjectReference<Vehicle>) - Method in interface org.opentcs.components.kernel.services.VehicleService
Disables the comm adapter attached to the referenced vehicle.
disconnectPeripheral() - Method in class org.opentcs.drivers.peripherals.BasicPeripheralCommAdapter
Closes the communication channel to the peripheral device.
disconnectVehicle() - Method in class org.opentcs.drivers.vehicle.BasicVehicleCommAdapter
Closes the communication channel to the vehicle.
dispatch() - Method in interface org.opentcs.components.kernel.Dispatcher
Notifies the dispatcher that it should start the dispatching process.
dispatch() - Method in interface org.opentcs.components.kernel.PeripheralJobDispatcher
Notifies the dispatcher that it should start the dispatching process.
dispatch() - Method in interface org.opentcs.components.kernel.services.DispatcherService
Explicitly trigger the dispatching process.
dispatch() - Method in interface org.opentcs.components.kernel.services.PeripheralDispatcherService
Explicitly trigger the dispatching process for peripheral jobs.
dispatch(ClientID) - Method in interface org.opentcs.access.rmi.services.RemoteDispatcherService
 
dispatch(ClientID) - Method in interface org.opentcs.access.rmi.services.RemotePeripheralDispatcherService
 
DISPATCHABLE - org.opentcs.data.order.TransportOrder.State
Marks a transport order as ready to be dispatched to a vehicle (i.e.
Dispatcher - Interface in org.opentcs.components.kernel
This interface declares the methods a dispatcher module for the openTCS kernel must implement.
DispatcherService - Interface in org.opentcs.components.kernel.services
Provides methods concerning the Dispatcher.
DriveOrder - Class in org.opentcs.data.order
Describes a sequence of movements and an optional operation at the end that a Vehicle is supposed to execute.
DriveOrder(DriveOrder.Destination) - Constructor for class org.opentcs.data.order.DriveOrder
Creates a new DriveOrder.
DriveOrder.Destination - Class in org.opentcs.data.order
Describes the destination of a drive order.
DriveOrder.State - Enum in org.opentcs.data.order
Defines the various potential states of a drive order.

E

Edge - Class in org.opentcs.components.kernel.routing
A wrapper for Paths that can be used to build routing graphs.
Edge(Path, boolean) - Constructor for class org.opentcs.components.kernel.routing.Edge
Creates a new instance.
EdgeEvaluator - Interface in org.opentcs.components.kernel.routing
Computes the weight of edges in the routing graph.
ELBOW - org.opentcs.data.model.Path.Layout.ConnectionType
An elbow connection.
ElementPropKeys - Interface in org.opentcs.data.model.visualization
Defines some reserved/commonly used property keys of LayoutElements.
enable() - Method in class org.opentcs.drivers.peripherals.BasicPeripheralCommAdapter
Enables this comm adapter, i.e.
enable() - Method in interface org.opentcs.drivers.peripherals.PeripheralCommAdapter
Enables this comm adapter, i.e.
enable() - Method in class org.opentcs.drivers.vehicle.BasicVehicleCommAdapter
Enables this comm adapter, i.e.
enable() - Method in interface org.opentcs.drivers.vehicle.VehicleCommAdapter
Enables this comm adapter, i.e.
enableCommAdapter(ClientID, TCSResourceReference<Location>) - Method in interface org.opentcs.access.rmi.services.RemotePeripheralService
 
enableCommAdapter(ClientID, TCSObjectReference<Vehicle>) - Method in interface org.opentcs.access.rmi.services.RemoteVehicleService
 
enableCommAdapter(TCSResourceReference<Location>) - Method in interface org.opentcs.components.kernel.services.PeripheralService
Enables the comm adapter attached to the referenced location.
enableCommAdapter(TCSObjectReference<Vehicle>) - Method in interface org.opentcs.components.kernel.services.VehicleService
Enables the comm adapter attached to the referenced vehicle.
ENERGY_LEVEL - org.opentcs.drivers.vehicle.VehicleProcessModel.Attribute
Indicates a change of the vehicle's energy level.
enqueueCommand(MovementCommand) - Method in class org.opentcs.drivers.vehicle.BasicVehicleCommAdapter
 
enqueueCommand(MovementCommand) - Method in interface org.opentcs.drivers.vehicle.VehicleCommAdapter
Appends a command to this communication adapter's command queue.
Entry(String) - Constructor for class org.opentcs.data.ObjectHistory.Entry
Creates a new instance with the timestamp set to the current point of time and an empty supplement.
Entry(String, Object) - Constructor for class org.opentcs.data.ObjectHistory.Entry
Creates a new instance with the timestamp set to the current point of time.
Entry(Instant, String) - Constructor for class org.opentcs.data.ObjectHistory.Entry
Creates a new instance with an empty supplement.
Entry(Instant, String, Object) - Constructor for class org.opentcs.data.ObjectHistory.Entry
Creates a new instance.
Enums - Class in org.opentcs.util
Provides helper methods for working with enums.
equals(Object) - Method in class org.opentcs.access.rmi.ClientID
Checks if this object equals another one.
equals(Object) - Method in class org.opentcs.data.model.Couple
 
equals(Object) - Method in class org.opentcs.data.model.Location.Link
Checks if this object is equal to another one.
equals(Object) - Method in class org.opentcs.data.model.Triple
 
equals(Object) - Method in class org.opentcs.data.notification.UserNotification
 
equals(Object) - Method in class org.opentcs.data.order.DriveOrder.Destination
 
equals(Object) - Method in class org.opentcs.data.order.Route
 
equals(Object) - Method in class org.opentcs.data.order.Route.Step
 
equals(Object) - Method in class org.opentcs.data.TCSObject
Checks if this object is equal to another one.
equals(Object) - Method in class org.opentcs.data.TCSObjectReference
 
equals(Object) - Method in class org.opentcs.drivers.peripherals.PeripheralCommAdapterDescription
 
equals(Object) - Method in class org.opentcs.drivers.vehicle.LoadHandlingDevice
 
equals(Object) - Method in class org.opentcs.drivers.vehicle.VehicleCommAdapterDescription
 
ERROR - org.opentcs.data.model.PeripheralInformation.State
There is a problem with the peripheral device.
ERROR - org.opentcs.data.model.Vehicle.State
There is a problem with the vehicle.
EventBus - Interface in org.opentcs.util.event
A distributor of events.
EventHandler - Interface in org.opentcs.util.event
A handler for events emitted by an EventSource.
EventSource - Interface in org.opentcs.util.event
A source of events that can be subscribed to.
execute(PeripheralAdapterCommand) - Method in interface org.opentcs.drivers.peripherals.PeripheralCommAdapter
Executes the given PeripheralAdapterCommand.
execute(PeripheralCommAdapter) - Method in interface org.opentcs.drivers.peripherals.PeripheralAdapterCommand
Executes the command.
execute(AdapterCommand) - Method in class org.opentcs.drivers.vehicle.BasicVehicleCommAdapter
 
execute(AdapterCommand) - Method in interface org.opentcs.drivers.vehicle.VehicleCommAdapter
Executes the given AdapterCommand.
execute(VehicleCommAdapter) - Method in interface org.opentcs.drivers.vehicle.AdapterCommand
Executes the command.
execute(VehicleCommAdapter) - Method in class org.opentcs.drivers.vehicle.commands.InitPositionCommand
 
EXECUTING - org.opentcs.data.model.PeripheralInformation.State
The peripheral device is processing a job.
EXECUTING - org.opentcs.data.model.Vehicle.State
The vehicle is processing a movement order.
expandResources(Set<TCSResourceReference<?>>) - Method in interface org.opentcs.components.kernel.services.InternalPlantModelService
Expands a set of resources A to a set of resources B.
ExplainedBoolean - Class in org.opentcs.util
A boolean with an explanation/reason for its value.
ExplainedBoolean(boolean, String) - Constructor for class org.opentcs.util.ExplainedBoolean
Creates a new instance.
exportPlantModel(PlantModelCreationTO) - Method in interface org.opentcs.components.plantoverview.PlantModelExporter
Exports the given plant model data.

F

FAILED - org.opentcs.data.order.DriveOrder.State
Marks a drive order as failed.
FAILED - org.opentcs.data.order.TransportOrder.State
General failure state that marks a transport order as failed.
FAILED - org.opentcs.data.peripherals.PeripheralJob.State
 
fetchAttachmentInformation(ClientID, TCSResourceReference<Location>) - Method in interface org.opentcs.access.rmi.services.RemotePeripheralService
 
fetchAttachmentInformation(ClientID, TCSObjectReference<Vehicle>) - Method in interface org.opentcs.access.rmi.services.RemoteVehicleService
 
fetchAttachmentInformation(TCSResourceReference<Location>) - Method in interface org.opentcs.components.kernel.services.PeripheralService
Returns attachment information for the referenced location.
fetchAttachmentInformation(TCSObjectReference<Vehicle>) - Method in interface org.opentcs.components.kernel.services.VehicleService
Returns attachment information for the referenced vehicle.
fetchEvents(long) - Method in interface org.opentcs.access.KernelServicePortal
Fetches events buffered for the client.
fetchEvents(long) - Method in class org.opentcs.access.rmi.services.RemoteKernelServicePortalProxy
 
fetchEvents(ClientID, long) - Method in interface org.opentcs.access.rmi.services.RemoteKernelServicePortal
 
fetchObject(Class<T>, String) - Method in interface org.opentcs.components.kernel.services.TCSObjectService
Returns a single TCSObject of the given class.
fetchObject(Class<T>, TCSObjectReference<T>) - Method in interface org.opentcs.components.kernel.services.TCSObjectService
Returns a single TCSObject of the given class.
fetchObject(ClientID, Class<T>, String) - Method in interface org.opentcs.access.rmi.services.RemoteTCSObjectService
 
fetchObject(ClientID, Class<T>, TCSObjectReference<T>) - Method in interface org.opentcs.access.rmi.services.RemoteTCSObjectService
 
fetchObjects(Class<T>) - Method in interface org.opentcs.components.kernel.services.TCSObjectService
Returns all existing TCSObjects of the given class.
fetchObjects(Class<T>, Predicate<? super T>) - Method in interface org.opentcs.components.kernel.services.TCSObjectService
Returns all existing TCSObjects of the given class for which the given predicate is true.
fetchObjects(ClientID, Class<T>) - Method in interface org.opentcs.access.rmi.services.RemoteTCSObjectService
 
fetchObjects(ClientID, Class<T>, Predicate<? super T>) - Method in interface org.opentcs.access.rmi.services.RemoteTCSObjectService
 
fetchProcessModel(ClientID, TCSResourceReference<Location>) - Method in interface org.opentcs.access.rmi.services.RemotePeripheralService
 
fetchProcessModel(ClientID, TCSObjectReference<Vehicle>) - Method in interface org.opentcs.access.rmi.services.RemoteVehicleService
 
fetchProcessModel(TCSResourceReference<Location>) - Method in interface org.opentcs.components.kernel.services.PeripheralService
Returns the process model for the referenced location.
fetchProcessModel(TCSObjectReference<Vehicle>) - Method in interface org.opentcs.components.kernel.services.VehicleService
Returns the process model for the referenced vehicle.
fetchSchedulerAllocations() - Method in interface org.opentcs.components.kernel.services.SchedulerService
Returns the current state of resource allocations.
fetchSchedulerAllocations(ClientID) - Method in interface org.opentcs.access.rmi.services.RemoteSchedulerService
 
fetchUserNotifications(Predicate<UserNotification>) - Method in interface org.opentcs.components.kernel.services.NotificationService
Returns a list of user notifications.
fetchUserNotifications(ClientID, Predicate<UserNotification>) - Method in interface org.opentcs.access.rmi.services.RemoteNotificationService
 
FINISHED - org.opentcs.data.order.DriveOrder.State
Marks a drive order as successfully completed.
FINISHED - org.opentcs.data.order.TransportOrder.State
Marks a transport order as successfully completed.
FINISHED - org.opentcs.data.peripherals.PeripheralJob.State
 
FORWARD - org.opentcs.data.model.Vehicle.Orientation
Indicates that the vehicle is driving/standing oriented towards its front.
free(Scheduler.Client, Set<TCSResource<?>>) - Method in interface org.opentcs.components.kernel.Scheduler
Releases a set of resources allocated by a client.
freeAll(Scheduler.Client) - Method in interface org.opentcs.components.kernel.Scheduler
Releases all resources allocation by the given client.

G

get(String, Class<T>) - Method in interface org.opentcs.configuration.ConfigurationBindingProvider
Returns a binding for a configuration interface.
getAdapterFor(Location) - Method in interface org.opentcs.drivers.peripherals.PeripheralCommAdapterFactory
Returns a communication adapter for controlling the given location/peripheral device.
getAdapterFor(Vehicle) - Method in interface org.opentcs.drivers.vehicle.VehicleCommAdapterFactory
Returns a communication adapter for controlling the given vehicle.
getAdapterName() - Method in class org.opentcs.drivers.vehicle.VehicleCommAdapterEvent
Returns the name of the adapter that emitted this event.
getAllDriveOrders() - Method in class org.opentcs.data.order.TransportOrder
Returns a list of all drive orders, i.e.
getAllocations() - Method in interface org.opentcs.components.kernel.Scheduler
Returns all resource allocations as a map of client IDs to resources.
getAllocationStates() - Method in class org.opentcs.access.SchedulerAllocationState
Returns the current state of allocations.
getAllowedOperations() - Method in class org.opentcs.access.to.model.LocationTypeCreationTO
Returns the allowed operations for this location type.
getAllowedOperations() - Method in class org.opentcs.data.model.Location.Link
Returns the operations allowed at this link.
getAllowedOperations() - Method in class org.opentcs.data.model.LocationType
Returns a set of operations allowed with locations of this type.
getAllowedOrderTypes() - Method in class org.opentcs.data.model.Vehicle
Returns the set of order types this vehicle is allowed to process.
getAllowedPeripheralOperations() - Method in class org.opentcs.access.to.model.LocationTypeCreationTO
Returns the allowed peripheral operations for this location type.
getAllowedPeripheralOperations() - Method in class org.opentcs.data.model.LocationType
Returns a set of peripheral operations allowed with locations of this type.
getAppendix() - Method in class org.opentcs.drivers.vehicle.VehicleCommAdapterEvent
Returns the (optional) appendix containing additional arbitrary information about the event.
getAttachedCommAdapter() - Method in class org.opentcs.drivers.peripherals.management.PeripheralAttachmentInformation
Returns the comm adapter attached to the referenced location.
getAttachedCommAdapter() - Method in class org.opentcs.drivers.vehicle.management.AttachmentInformation
Returns the comm adapter attached to the referenced vehicle.
getAttachedLinks() - Method in class org.opentcs.data.model.Location
Returns a set of links attached to this location.
getAttachedLinks() - Method in class org.opentcs.data.model.Point
Returns a set of links attached to this point.
getAttachmentInformation() - Method in class org.opentcs.drivers.peripherals.management.PeripheralAttachmentEvent
Returns the information to the actual attachment.
getAttributeChanged() - Method in class org.opentcs.drivers.peripherals.management.PeripheralProcessModelEvent
Returns the name of the attribute that has changed in the process model.
getAttributeChanged() - Method in class org.opentcs.drivers.vehicle.management.ProcessModelEvent
Returns the attribute's name that changed in the process model.
getAvailableCommAdapters() - Method in class org.opentcs.drivers.vehicle.management.AttachmentInformation
Returns the list of comm adapters available to be attached to the referenced vehicle.
getBlocks() - Method in class org.opentcs.access.to.model.PlantModelCreationTO
Returns this plant model's blocks.
getCategorySuggestions() - Method in interface org.opentcs.components.plantoverview.OrderCategorySuggestions
Deprecated.
Returns a set of categories that can be assigned to a transport order.
getClientName() - Method in class org.opentcs.access.rmi.ClientID
Return the client's name.
getClientSocketFactory() - Method in class org.opentcs.access.rmi.factories.NullSocketFactoryProvider
 
getClientSocketFactory() - Method in class org.opentcs.access.rmi.factories.SecureSocketFactoryProvider
 
getClientSocketFactory() - Method in interface org.opentcs.access.rmi.factories.SocketFactoryProvider
Returns a RMIClientSocketFactory.
getColor() - Method in class org.opentcs.access.to.model.BlockCreationTO.Layout
Returns the color in which block elements are to be emphasized.
getColor() - Method in class org.opentcs.data.model.Block.Layout
Returns the color in which block elements are to be emphasized.
getCommandQueue() - Method in class org.opentcs.drivers.vehicle.BasicVehicleCommAdapter
 
getCommandQueue() - Method in interface org.opentcs.drivers.vehicle.VehicleCommAdapter
Returns this adapter's command queue.
getCommandQueueCapacity() - Method in class org.opentcs.drivers.vehicle.BasicVehicleCommAdapter
 
getCommandQueueCapacity() - Method in interface org.opentcs.drivers.vehicle.VehicleCommAdapter
Indicates how many commands this comm adapter's command queue accepts.
getCommandsSent() - Method in interface org.opentcs.drivers.vehicle.VehicleController
Returns a list of MovementCommands that have been sent to the communication adapter.
getConnectionType() - Method in class org.opentcs.access.to.model.PathCreationTO.Layout
Returns the connection type the path is represented as.
getConnectionType() - Method in class org.opentcs.data.model.Path.Layout
Returns the connection type the path is represented as.
getContent() - Method in class org.opentcs.data.model.visualization.ImageData
Deprecated.
Returns the binary data describing the actual image.
getContentFormat() - Method in class org.opentcs.data.model.visualization.ImageData
Deprecated.
Returns the content type/format of this image.
getControlPoints() - Method in class org.opentcs.access.to.model.PathCreationTO.Layout
Returns the control points describing the way the path is drawn.
getControlPoints() - Method in class org.opentcs.data.model.Path.Layout
Returns the control points describing the way the path is drawn.
getCosts() - Method in class org.opentcs.data.order.Route
Returns the costs for travelling this route.
getCosts(Vehicle, Point, Point) - Method in interface org.opentcs.components.kernel.Router
Returns the costs for travelling a route from one point to another with a given vehicle.
getCostsByPointRef(Vehicle, TCSObjectReference<Point>, TCSObjectReference<Point>) - Method in interface org.opentcs.components.kernel.Router
Returns the costs for travelling a route from one point to another with a given vehicle.
getCreationTime() - Method in class org.opentcs.data.order.TransportOrder
Returns this transport order's creation time.
getCreationTime() - Method in class org.opentcs.data.peripherals.PeripheralJob
Returns the point of time at which this peripheral job was created.
getCurrentDriveOrder() - Method in class org.opentcs.data.order.TransportOrder
Returns the current drive order, or null, if no drive order is currently being processed.
getCurrentDriveOrderIndex() - Method in class org.opentcs.data.order.TransportOrder
Returns the index of the currently processed drive order.
getCurrentObjectState() - Method in class org.opentcs.data.TCSObjectEvent
Returns the current state of the object for which this event was created.
getCurrentOrPreviousObjectState() - Method in class org.opentcs.data.TCSObjectEvent
Returns the current state of the object for which this event was created, or, if the current state is null, the previous state.
getCurrentPosition() - Method in class org.opentcs.data.model.Vehicle
Returns a reference to the point this vehicle currently occupies.
getDeadline() - Method in class org.opentcs.access.to.order.TransportOrderCreationTO
Returns the point of time at which execution of the transport order is supposed to be finished.
getDeadline() - Method in class org.opentcs.data.order.TransportOrder
Returns this transport order's deadline.
getDependencies() - Method in class org.opentcs.data.order.TransportOrder
Returns the set of transport orders this order depends on.
getDependencyNames() - Method in class org.opentcs.access.to.order.TransportOrderCreationTO
Returns the (optional) names of transport orders the transport order depends on.
getDescription() - Method in interface org.opentcs.components.plantoverview.PlantModelExporter
Returns a (localized) short textual description of this importer.
getDescription() - Method in interface org.opentcs.components.plantoverview.PlantModelImporter
Returns a (localized) short textual description of this importer.
getDescription() - Method in class org.opentcs.drivers.peripherals.PeripheralCommAdapterDescription
Returns the description for a peripheral communication adapter.
getDescription() - Method in interface org.opentcs.drivers.peripherals.PeripheralCommAdapterFactory
Returns a PeripheralCommAdapterDescription for the factory/the adapters provided.
getDescription() - Method in class org.opentcs.drivers.vehicle.DefaultVehicleCommAdapterDescription
 
getDescription() - Method in class org.opentcs.drivers.vehicle.VehicleCommAdapterDescription
Returns the description for a vehicle comm adapter.
getDescription() - Method in interface org.opentcs.drivers.vehicle.VehicleCommAdapterFactory
Returns a VehicleCommAdapterDescription for the factory/the adapters provided.
getDestination() - Method in class org.opentcs.data.order.DriveOrder.Destination
Returns the actual destination (a location or point).
getDestination() - Method in class org.opentcs.data.order.DriveOrder
Returns this drive order's destination.
getDestinationPoint() - Method in class org.opentcs.data.model.Path
Returns a reference to the point which this path ends in.
getDestinationPoint() - Method in class org.opentcs.data.order.Route.Step
Returns the point that is reached by travelling the path.
getDestinations() - Method in class org.opentcs.access.to.order.TransportOrderCreationTO
Returns the destinations that need to be travelled to.
getDestLocationName() - Method in class org.opentcs.access.to.order.DestinationCreationTO
Returns the destination location (or point) name.
getDestOperation() - Method in class org.opentcs.access.to.order.DestinationCreationTO
Returns the operation to be performed at the destination.
getDestPointName() - Method in class org.opentcs.access.to.model.PathCreationTO
Returns the point name this path ends in.
getDispatcherService() - Method in interface org.opentcs.access.KernelServicePortal
Returns the service a client can use to access methods regarding the dispatcher.
getDispatcherService() - Method in class org.opentcs.access.rmi.services.RemoteKernelServicePortalProxy
 
getEnergyLevel() - Method in class org.opentcs.data.model.Vehicle
Returns this vehicle's remaining energy (in percent of the maximum).
getEnergyLevel() - Method in class org.opentcs.drivers.vehicle.management.VehicleProcessModelTO
 
getEnergyLevelCritical() - Method in class org.opentcs.access.to.model.VehicleCreationTO
Returns this vehicle's critical energy level (in percent of the maximum).
getEnergyLevelCritical() - Method in class org.opentcs.data.model.Vehicle
Returns this vehicle's critical energy level (in percent of the maximum).
getEnergyLevelFullyRecharged() - Method in class org.opentcs.access.to.model.VehicleCreationTO
Returns this vehicle's fully recharged energy level (in percent of the maximum).
getEnergyLevelFullyRecharged() - Method in class org.opentcs.data.model.Vehicle
Returns this vehicle's energy level for being fully recharged (in percent of the maximum).
getEnergyLevelGood() - Method in class org.opentcs.access.to.model.VehicleCreationTO
Returns this vehicle's good energy level (in percent of the maximum).
getEnergyLevelGood() - Method in class org.opentcs.data.model.Vehicle
Returns this vehicle's good energy level (in percent of the maximum).
getEnergyLevelSufficientlyRecharged() - Method in class org.opentcs.access.to.model.VehicleCreationTO
Returns this vehicle's sufficiently recharged energy level (in percent of the maximum).
getEnergyLevelSufficientlyRecharged() - Method in class org.opentcs.data.model.Vehicle
Returns this vehicle's energy level for being sufficiently recharged (in percent of the maximum).
getEnteredState() - Method in class org.opentcs.access.KernelStateTransitionEvent
Returns the state for which this event was generated.
getEntries() - Method in class org.opentcs.data.ObjectHistory
Returns this history's entries.
getEventCode() - Method in class org.opentcs.data.ObjectHistory.Entry
Returns this entry's event code.
getEventFilter() - Method in class org.opentcs.access.rmi.KernelServicePortalBuilder
Returns the event filter to be applied for the built portal.
getEventHandler() - Method in class org.opentcs.drivers.peripherals.BasicPeripheralCommAdapter
 
getExecutionTrigger() - Method in class org.opentcs.access.to.peripherals.PeripheralOperationCreationTO
Returns the moment at which this operation is to be performed.
getExecutionTrigger() - Method in class org.opentcs.data.peripherals.PeripheralOperation
Returns the moment at which this operation is to be executed.
getFinalDestination() - Method in interface org.opentcs.drivers.vehicle.MovementCommand
Returns the final destination of the drive order this MovementCommand was created for.
getFinalDestinationLocation() - Method in interface org.opentcs.drivers.vehicle.MovementCommand
Returns the destination location of the whole drive order.
getFinalDestinationPoint() - Method in class org.opentcs.data.order.Route
Returns the final destination point that is reached by travelling this route.
getFinalOperation() - Method in interface org.opentcs.drivers.vehicle.MovementCommand
Returns the operation to be executed at the final destination position.
getFinishedIndex() - Method in class org.opentcs.data.order.OrderSequence
Returns the index of the order that was last finished in the sequence, or -1, if none was finished, yet.
getFinishedTime() - Method in class org.opentcs.data.order.TransportOrder
Returns the point of time at which this transport order was finished.
getFinishedTime() - Method in class org.opentcs.data.peripherals.PeripheralJob
Returns the point of time at which processing of this peripheral job was finished.
getFutureDriveOrders() - Method in class org.opentcs.data.order.TransportOrder
Returns a list of DriveOrders that still need to be processed.
getGroupId() - Method in class org.opentcs.data.model.visualization.Layer
Returns the ID of the layer group this layer is assigned to.
getGroups() - Method in class org.opentcs.access.to.model.PlantModelCreationTO
Deprecated.
getHistory() - Method in class org.opentcs.data.TCSObject
 
getId() - Method in interface org.opentcs.components.kernel.Scheduler.Client
Returns an ID string for this client.
getId() - Method in class org.opentcs.data.model.visualization.Layer
Returns the unique ID of this layer.
getId() - Method in class org.opentcs.data.model.visualization.LayerGroup
Returns the unique ID of this layer group.
getImageData() - Method in class org.opentcs.data.model.visualization.ImageLayoutElement
Deprecated.
Returns this layout element's image data.
getImageFor(Location, LocationType) - Method in interface org.opentcs.components.plantoverview.LocationTheme
Returns the image for the given location (type).
getImageFor(LocationRepresentation) - Method in interface org.opentcs.components.plantoverview.LocationTheme
Returns the image for the given location representation.
getIncomingPaths() - Method in class org.opentcs.data.model.Point
Returns a set of references to paths ending in this point.
getIntegrationLevel() - Method in class org.opentcs.data.model.Vehicle
Returns this vehicle's integration level.
getIntendedVehicle() - Method in class org.opentcs.data.order.OrderSequence
Returns a reference to the vehicle that is intended to process this order sequence.
getIntendedVehicle() - Method in class org.opentcs.data.order.TransportOrder
Returns a reference to the vehicle that is intended to process this transport order.
getIntendedVehicleName() - Method in class org.opentcs.access.to.order.OrderSequenceCreationTO
Returns the (optional) name of the vehicle that is supposed to execute the transport order.
getIntendedVehicleName() - Method in class org.opentcs.access.to.order.TransportOrderCreationTO
Returns the (optional) name of the vehicle that is supposed to execute the transport order.
getKey() - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel.PropertyUpdate
Returns the property's key.
getKeystoreFile() - Method in class org.opentcs.access.SslParameterSet
Returns the file path of the keystore file.
getKeystorePassword() - Method in class org.opentcs.access.SslParameterSet
Returns the password for the keystore file.
getKeystoreType() - Method in class org.opentcs.access.SslParameterSet
Returns the keystoreType used to decrypt the keystore and truststore.
getKeySuggestions() - Method in interface org.opentcs.components.plantoverview.PropertySuggestions
Returns suggested property keys.
getLabel() - Method in class org.opentcs.data.model.visualization.ImageData
Deprecated.
Returns a label/name for this image.
getLabel() - Method in class org.opentcs.drivers.vehicle.LoadHandlingDevice
Returns this load handling device's name/label.
getLabelOffset() - Method in class org.opentcs.access.to.model.LocationCreationTO.Layout
Returns the offset of the label's position to the location's position (in lu).
getLabelOffset() - Method in class org.opentcs.access.to.model.PointCreationTO.Layout
Returns the offset of the label's position to the point's position (in lu).
getLabelOffset() - Method in class org.opentcs.data.model.Location.Layout
Returns the offset of the label's position to the location's position (in lu).
getLabelOffset() - Method in class org.opentcs.data.model.Point.Layout
Returns the offset of the label's position to the point's position (in lu).
getLayer() - Method in class org.opentcs.access.to.model.ModelLayoutElementCreationTO
Deprecated.
Returns the layer on which this model layout element is to be displayed.
getLayer() - Method in class org.opentcs.access.to.model.ShapeLayoutElementCreationTO
Deprecated.
Returns the layer on which this shape layout element is to be displayed.
getLayer() - Method in class org.opentcs.data.model.visualization.LayoutElement
Deprecated.
Returns the layer on which this layout element is to be displayed.
getLayerGroups() - Method in class org.opentcs.access.to.model.VisualLayoutCreationTO
Returns the layer groups of this visual layout.
getLayerGroups() - Method in class org.opentcs.data.model.visualization.VisualLayout
Returns the layer groups of this layout.
getLayerId() - Method in class org.opentcs.access.to.model.LocationCreationTO.Layout
Returns the ID of the layer on which the location is to be drawn.
getLayerId() - Method in class org.opentcs.access.to.model.PathCreationTO.Layout
Returns the ID of the layer on which the path is to be drawn.
getLayerId() - Method in class org.opentcs.access.to.model.PointCreationTO.Layout
Returns the ID of the layer on which the point is to be drawn.
getLayerId() - Method in class org.opentcs.data.model.Location.Layout
Returns the ID of the layer on which the location is to be drawn.
getLayerId() - Method in class org.opentcs.data.model.Path.Layout
Returns the ID of the layer on which the path is to be drawn.
getLayerId() - Method in class org.opentcs.data.model.Point.Layout
Returns the ID of the layer on which the point is to be drawn.
getLayers() - Method in class org.opentcs.access.to.model.VisualLayoutCreationTO
Returns the layers of this visual layout.
getLayers() - Method in class org.opentcs.data.model.visualization.VisualLayout
Returns the layers of this layout.
getLayout() - Method in class org.opentcs.access.to.model.BlockCreationTO
Returns the information regarding the grahical representation of this block.
getLayout() - Method in class org.opentcs.access.to.model.LocationCreationTO
Returns the information regarding the grahical representation of this location.
getLayout() - Method in class org.opentcs.access.to.model.LocationTypeCreationTO
Returns the information regarding the grahical representation of this location type.
getLayout() - Method in class org.opentcs.access.to.model.PathCreationTO
Returns the information regarding the grahical representation of this path.
getLayout() - Method in class org.opentcs.access.to.model.PointCreationTO
Returns the information regarding the grahical representation of this point.
getLayout() - Method in class org.opentcs.access.to.model.VehicleCreationTO
Returns the information regarding the grahical representation of this vehicle.
getLayout() - Method in class org.opentcs.data.model.Block
Returns the information regarding the grahical representation of this block.
getLayout() - Method in class org.opentcs.data.model.Location
Returns the information regarding the grahical representation of this location.
getLayout() - Method in class org.opentcs.data.model.LocationType
Returns the information regarding the grahical representation of this location type.
getLayout() - Method in class org.opentcs.data.model.Path
Returns the information regarding the grahical representation of this path.
getLayout() - Method in class org.opentcs.data.model.Point
Returns the information regarding the grahical representation of this point.
getLayout() - Method in class org.opentcs.data.model.Vehicle
Returns the information regarding the grahical representation of this vehicle.
getLayoutElements() - Method in class org.opentcs.data.model.visualization.VisualLayout
Deprecated.
getLeftState() - Method in class org.opentcs.access.KernelStateTransitionEvent
Returns the state the kernel is leaving.
getLength() - Method in class org.opentcs.access.to.model.PathCreationTO
Returns the length of this path (in mm).
getLength() - Method in class org.opentcs.access.to.model.VehicleCreationTO
Returns the vehicle's length (in mm).
getLength() - Method in class org.opentcs.data.model.Path
Return the length of this path (in mm).
getLength() - Method in class org.opentcs.data.model.Vehicle
Returns this vehicle's current length.
getLevel() - Method in class org.opentcs.data.notification.UserNotification
Returns this message's type.
getLinks() - Method in class org.opentcs.access.to.model.LocationCreationTO
Returns the links attaching points to this location.
getLoadHandlingDevices() - Method in class org.opentcs.data.model.Vehicle
Returns the current (state of the) load handling devices of this vehicle.
getLoadHandlingDevices() - Method in class org.opentcs.drivers.vehicle.management.VehicleProcessModelTO
 
getLocation() - Method in class org.opentcs.data.model.Location.Link
Returns a reference to the location end of this link.
getLocation() - Method in class org.opentcs.data.peripherals.PeripheralOperation
Returns the location the peripheral device is associated with.
getLocation() - Method in class org.opentcs.drivers.peripherals.management.PeripheralAttachmentEvent
Returns the location a comm adapter has been attached to.
getLocation() - Method in class org.opentcs.drivers.peripherals.management.PeripheralProcessModelEvent
Returns the location assiciated with the peripheral device.
getLocation() - Method in class org.opentcs.drivers.peripherals.PeripheralProcessModel
Returns the reference to the location that is attached to this model.
getLocationName() - Method in class org.opentcs.access.to.peripherals.PeripheralOperationCreationTO
Returns the name of the location the peripheral device is associated with.
getLocationReference() - Method in class org.opentcs.drivers.peripherals.management.PeripheralAttachmentInformation
Returns the location this attachment information belongs to.
getLocationRepresentation() - Method in class org.opentcs.access.to.model.LocationCreationTO.Layout
Returns the location representation to use.
getLocationRepresentation() - Method in class org.opentcs.access.to.model.LocationTypeCreationTO.Layout
Returns the location representation to use for locations with this location type.
getLocationRepresentation() - Method in class org.opentcs.data.model.Location.Layout
Returns the location representation to use.
getLocationRepresentation() - Method in class org.opentcs.data.model.LocationType.Layout
Returns the location representation to use for locations with this location type.
getLocations() - Method in class org.opentcs.access.to.model.PlantModelCreationTO
Returns this plant model's locations.
getLocationTypes() - Method in class org.opentcs.access.to.model.PlantModelCreationTO
Returns this plant model's location types.
getMaxReverseVelocity() - Method in class org.opentcs.access.to.model.PathCreationTO
Returns the maximum allowed reverse velocity (in mm/s) for this path.
getMaxReverseVelocity() - Method in class org.opentcs.access.to.model.VehicleCreationTO
 
getMaxReverseVelocity() - Method in class org.opentcs.data.model.Path
Return the maximum allowed reverse velocity (in mm/s) for this path.
getMaxReverseVelocity() - Method in class org.opentcs.data.model.Vehicle
Returns this vehicle's maximum reverse velocity (in mm/s).
getMaxVelocity() - Method in class org.opentcs.access.to.model.PathCreationTO
Returns the maximum allowed forward velocity (in mm/s) for this path.
getMaxVelocity() - Method in class org.opentcs.access.to.model.VehicleCreationTO
 
getMaxVelocity() - Method in class org.opentcs.data.model.Path
Return the maximum allowed forward velocity (in mm/s) for this path.
getMaxVelocity() - Method in class org.opentcs.data.model.Vehicle
Returns this vehicle's maximum velocity (in mm/s).
getMemberNames() - Method in class org.opentcs.access.to.model.BlockCreationTO
Returns the names of this block's members.
getMemberNames() - Method in class org.opentcs.access.to.model.GroupCreationTO
Deprecated.
Returns the names of this group's members.
getMembers() - Method in class org.opentcs.data.model.Block
Returns an unmodifiable set of all members of this block.
getMembers() - Method in class org.opentcs.data.model.Group
Deprecated.
Returns an unmodifiable set of all members of this group.
getModelElements() - Method in class org.opentcs.access.to.model.VisualLayoutCreationTO
Deprecated.
getModelName() - Method in interface org.opentcs.components.kernel.services.PlantModelService
Returns the name of the model that is currently loaded in the kernel.
getModelName(ClientID) - Method in interface org.opentcs.access.rmi.services.RemotePlantModelService
 
getModelProperties() - Method in interface org.opentcs.components.kernel.services.PlantModelService
Returns the model's properties.
getModelProperties(ClientID) - Method in interface org.opentcs.access.rmi.services.RemotePlantModelService
 
getModifiableProperties() - Method in class org.opentcs.access.to.CreationTO
Returns the properties of this transfer object.
getMultiplier() - Method in class org.opentcs.drivers.vehicle.messages.SetSpeedMultiplier
Returns the speed multiplier in percent.
getName() - Method in class org.opentcs.access.to.CreationTO
Returns the name of this transfer object.
getName() - Method in class org.opentcs.data.model.visualization.Layer
Returns the name of this layer.
getName() - Method in class org.opentcs.data.model.visualization.LayerGroup
Returns the name of this layer group.
getName() - Method in class org.opentcs.data.TCSObject
Returns this object's name.
getName() - Method in class org.opentcs.data.TCSObjectReference
Returns the referenced object's name.
getName() - Method in class org.opentcs.drivers.vehicle.BasicVehicleCommAdapter
Returns this communication adapter's name.
getName() - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Returns the vehicle's name.
getNewModelName() - Method in class org.opentcs.access.ModelTransitionEvent
Returns the model for which this event was generated.
getNextPosition() - Method in class org.opentcs.data.model.Vehicle
Returns a reference to the point this vehicle is expected to be seen at next.
getNextUnfinishedOrder() - Method in class org.opentcs.data.order.OrderSequence
Returns the next order in the sequence that hasn't been finished, yet.
getNotification() - Method in class org.opentcs.access.NotificationPublicationEvent
Returns the message being published.
getNotifications() - Method in class org.opentcs.drivers.vehicle.management.VehicleProcessModelTO
 
getNotifications() - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Returns user notifications published by the comm adapter.
getNotificationService() - Method in interface org.opentcs.access.KernelServicePortal
Returns the service a client can use to access methods regarding user notifications.
getNotificationService() - Method in class org.opentcs.access.rmi.services.RemoteKernelServicePortalProxy
 
getOccupyingVehicle() - Method in class org.opentcs.data.model.Point
Returns a reference to the vehicle occupying this point.
getOldModelName() - Method in class org.opentcs.access.ModelTransitionEvent
Returns the model name the kernel is leaving.
getOperation() - Method in class org.opentcs.access.to.peripherals.PeripheralOperationCreationTO
Returns the operation to be performed by the peripheral device.
getOperation() - Method in class org.opentcs.data.order.DriveOrder.Destination
Returns the operation to be performed at the destination location.
getOperation() - Method in class org.opentcs.data.peripherals.PeripheralOperation
Returns the actual operation to be executed by the peripheral device.
getOperation() - Method in interface org.opentcs.drivers.vehicle.MovementCommand
Returns the operation to be executed after moving.
getOpLocation() - Method in interface org.opentcs.drivers.vehicle.MovementCommand
Returns the location at which the operation is to be executed.
getOrders() - Method in class org.opentcs.data.order.OrderSequence
Returns the list of orders making up this sequence.
getOrderSequence() - Method in class org.opentcs.data.model.Vehicle
Returns a reference to the order sequence this vehicle is currently processing.
getOrdinal() - Method in class org.opentcs.data.model.visualization.Layer
Returns the ordinal of this layer.
getOrientationAngle() - Method in class org.opentcs.data.model.Vehicle
Returns the vehicle's current orientation angle (-360..360).
getOrientationAngle() - Method in class org.opentcs.drivers.vehicle.management.VehicleProcessModelTO
 
getOutgoingPaths() - Method in class org.opentcs.data.model.Point
Returns a set of references to paths originating in this point.
getPanelDescription() - Method in interface org.opentcs.components.plantoverview.PluggablePanelFactory
Returns a string describing the factory/the panels provided.
getPanelsFor(PeripheralCommAdapterDescription, TCSResourceReference<Location>, PeripheralProcessModel) - Method in interface org.opentcs.drivers.peripherals.management.PeripheralCommAdapterPanelFactory
Returns a list of PeripheralCommAdapterPanels.
getPanelsFor(VehicleCommAdapterDescription, TCSObjectReference<Vehicle>, VehicleProcessModelTO) - Method in interface org.opentcs.drivers.vehicle.management.VehicleCommAdapterPanelFactory
Returns a list of VehicleCommAdapterPanels.
getPassword() - Method in class org.opentcs.access.rmi.KernelServicePortalBuilder
Returns the password used for logging in.
getPastDriveOrders() - Method in class org.opentcs.data.order.TransportOrder
Returns a list of DriveOrders that have been processed already.
getPath() - Method in class org.opentcs.components.kernel.routing.Edge
Returns the path in the model that is traversed on this edge.
getPath() - Method in class org.opentcs.data.order.Route.Step
Returns the path to travel.
getPaths() - Method in class org.opentcs.access.to.model.PlantModelCreationTO
Returns this plant model's paths.
getPeripheralController(TCSResourceReference<Location>) - Method in interface org.opentcs.drivers.peripherals.PeripheralControllerPool
Returns the peripheral controller associated with the given location.
getPeripheralDispatcherService() - Method in interface org.opentcs.access.KernelServicePortal
Returns the service a client can use to access methods regarding the peripheral dispatcher.
getPeripheralDispatcherService() - Method in class org.opentcs.access.rmi.services.RemoteKernelServicePortalProxy
 
getPeripheralInformation() - Method in class org.opentcs.data.model.Location
Returns details about the peripheral devices this location may represent.
getPeripheralJob() - Method in class org.opentcs.data.model.PeripheralInformation
Returns a reference to the peripheral job this peripheral device is currently processing.
getPeripheralJobService() - Method in interface org.opentcs.access.KernelServicePortal
Returns the service a client can use to access methods regarding peripheral jobs.
getPeripheralJobService() - Method in class org.opentcs.access.rmi.services.RemoteKernelServicePortalProxy
 
getPeripheralOperation() - Method in class org.opentcs.access.to.peripherals.PeripheralJobCreationTO
Returns the operation that is to be performed by the pripheral device.
getPeripheralOperation() - Method in class org.opentcs.data.peripherals.PeripheralJob
Returns the operation that is to be performed by the peripheral device.
getPeripheralOperations() - Method in class org.opentcs.access.to.model.PathCreationTO
Returns the peripheral operations to be performed when a vehicle travels along this path.
getPeripheralOperations() - Method in class org.opentcs.data.model.Path
Returns the peripheral operations to be performed when a vehicle travels along this path.
getPeripheralReservationToken() - Method in class org.opentcs.access.to.order.TransportOrderCreationTO
Returns an optional token for reserving peripheral devices while processing this transport order.
getPeripheralReservationToken() - Method in class org.opentcs.data.order.TransportOrder
Returns an optional token for reserving peripheral devices while processing this transport order.
getPeripheralService() - Method in interface org.opentcs.access.KernelServicePortal
Returns the service a client can use to access methods regarding peripherals.
getPeripheralService() - Method in class org.opentcs.access.rmi.services.RemoteKernelServicePortalProxy
 
getPlantModelService() - Method in interface org.opentcs.access.KernelServicePortal
Returns the service a client can use to access methods regarding the plant model.
getPlantModelService() - Method in class org.opentcs.access.rmi.services.RemoteKernelServicePortalProxy
 
getPoint() - Method in class org.opentcs.data.model.Location.Link
Returns a reference to the point end of this link.
getPoints() - Method in class org.opentcs.access.to.model.PlantModelCreationTO
Returns this plant model's points.
getPortal() - Method in interface org.opentcs.access.SharedKernelServicePortal
Returns the KernelServicePortal instance being shared.
getPortalDescription() - Method in interface org.opentcs.access.SharedKernelServicePortalProvider
Returns a description for the portal currently being shared.
getPosition() - Method in class org.opentcs.access.to.model.LocationCreationTO
Returns the position of this location (in mm).
getPosition() - Method in class org.opentcs.access.to.model.LocationCreationTO.Layout
Returns the coordinates at which the location is to be drawn (in mm).
getPosition() - Method in class org.opentcs.access.to.model.PointCreationTO
Returns the position of this point (in mm).
getPosition() - Method in class org.opentcs.access.to.model.PointCreationTO.Layout
Returns the coordinates at which the point is to be drawn (in mm).
getPosition() - Method in class org.opentcs.data.model.Location
Returns the physical coordinates of this location in mm.
getPosition() - Method in class org.opentcs.data.model.Location.Layout
Returns the coordinates at which the location is to be drawn (in mm).
getPosition() - Method in class org.opentcs.data.model.Point
Returns the physical coordinates of this point in mm.
getPosition() - Method in class org.opentcs.data.model.Point.Layout
Returns the coordinates at which the point is to be drawn (in mm).
getPrecisePosition() - Method in class org.opentcs.data.model.Vehicle
Returns the vehicle's position in world coordinates [mm], independent from logical positions/point names.
getPrecisePosition() - Method in class org.opentcs.drivers.vehicle.management.VehicleProcessModelTO
 
getPreviousObjectState() - Method in class org.opentcs.data.TCSObjectEvent
Returns the previous state of the object for which this event was created.
getProcessingVehicle() - Method in class org.opentcs.data.order.OrderSequence
Returns a reference to the vehicle currently processing this sequence.
getProcessingVehicle() - Method in class org.opentcs.data.order.TransportOrder
Returns a reference to the vehicle currently processing this transport order.
getProcessModel() - Method in class org.opentcs.drivers.peripherals.BasicPeripheralCommAdapter
 
getProcessModel() - Method in class org.opentcs.drivers.peripherals.management.PeripheralProcessModelEvent
Returns the process model with its current/changed state.
getProcessModel() - Method in interface org.opentcs.drivers.peripherals.PeripheralCommAdapter
Returns a model of the peripheral device's and its communication adapter's attributes.
getProcessModel() - Method in class org.opentcs.drivers.vehicle.BasicVehicleCommAdapter
 
getProcessModel() - Method in interface org.opentcs.drivers.vehicle.VehicleCommAdapter
Returns an observable model of the vehicle's and its comm adapter's attributes.
getProcState() - Method in class org.opentcs.data.model.PeripheralInformation
Returns the peripheral device's current processing state.
getProcState() - Method in class org.opentcs.data.model.Vehicle
Returns this vehicle's current processing state.
getProperties() - Method in class org.opentcs.access.to.CreationTO
Returns the properties of this transfer object in an unmodifiable map.
getProperties() - Method in class org.opentcs.data.model.visualization.LayoutElement
Deprecated.
Returns this layout element's properties, a generic set of key-value pairs that can contain basically any information describing this element.
getProperties() - Method in class org.opentcs.data.order.DriveOrder.Destination
Returns the properties of this destination.
getProperties() - Method in class org.opentcs.data.TCSObject
Returns an unmodifiable view on this object's properties.
getProperties() - Method in interface org.opentcs.drivers.vehicle.MovementCommand
Returns the properties of the order this command is part of.
getProperty(String) - Method in class org.opentcs.data.TCSObject
Returns the property value for the given key.
getPropertyChangeSupport() - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
 
getQueryService() - Method in interface org.opentcs.access.KernelServicePortal
Returns the service a client can use to access methods for generic queries.
getQueryService() - Method in class org.opentcs.access.rmi.services.RemoteKernelServicePortalProxy
 
getReason() - Method in class org.opentcs.util.ExplainedBoolean
A reason/explanation for the value.
getRechargeOperation() - Method in class org.opentcs.data.model.Vehicle
Returns the operation that the vehicle's current communication adapter accepts as a command to recharge the vehicle.
getRechargeOperation() - Method in class org.opentcs.drivers.vehicle.BasicVehicleCommAdapter
 
getRechargeOperation() - Method in interface org.opentcs.drivers.vehicle.VehicleCommAdapter
Returns the string the comm adapter recognizes as a recharge operation.
getReference() - Method in class org.opentcs.data.model.TCSResource
 
getReference() - Method in class org.opentcs.data.TCSObject
Returns a transient/soft reference to this object.
getReferentClass() - Method in class org.opentcs.data.TCSObjectReference
Returns the referenced object's class.
getRelatedTransportOrder() - Method in class org.opentcs.data.peripherals.PeripheralJob
Returns the transport order for which this peripheral job was created.
getRelatedTransportOrderName() - Method in class org.opentcs.access.to.peripherals.PeripheralJobCreationTO
Returns the name of the transport order for which this peripheral job is to be created.
getRelatedVehicle() - Method in class org.opentcs.data.peripherals.PeripheralJob
Returns the vehicle for which this peripheral job was created.
getRelatedVehicleName() - Method in class org.opentcs.access.to.peripherals.PeripheralJobCreationTO
Returns the name of the vehicle for which this peripheral job is to be created.
getReservationToken() - Method in class org.opentcs.access.to.peripherals.PeripheralJobCreationTO
Returns the token that may be used to reserve a peripheral device.
getReservationToken() - Method in class org.opentcs.data.model.PeripheralInformation
Returns a token for which a location/peripheral device is currently reserved.
getReservationToken() - Method in class org.opentcs.data.peripherals.PeripheralJob
Returns the token that may be used to reserve a peripheral device.
getRoute() - Method in class org.opentcs.data.order.DriveOrder
Returns this drive order's route.
getRoute() - Method in interface org.opentcs.drivers.vehicle.MovementCommand
Returns the route that this movement belongs to.
getRoute(Vehicle, Point, Point) - Method in interface org.opentcs.components.kernel.Router
Returns a route from one point to another, passable for a given vehicle.
getRoute(Vehicle, Point, TransportOrder) - Method in interface org.opentcs.components.kernel.Router
Returns a complete route for a given vehicle that starts on a specified point and allows the vehicle to process a given transport order.
getRouteColor() - Method in class org.opentcs.access.to.model.VehicleCreationTO.Layout
Returns the color in which vehicle routes are to be emphasized.
getRouteColor() - Method in class org.opentcs.data.model.Vehicle.Layout
Returns the color in which vehicle routes are to be emphasized.
getRouteIndex() - Method in class org.opentcs.data.order.Route.Step
Returns this step's index in the vehicle's route.
getRouteProgressIndex() - Method in class org.opentcs.data.model.Vehicle
Returns the index of the last route step travelled for the current drive order of the current transport order.
getRouterService() - Method in interface org.opentcs.access.KernelServicePortal
Returns the service a client can use to access methods regarding the router.
getRouterService() - Method in class org.opentcs.access.rmi.services.RemoteKernelServicePortalProxy
 
getScaleX() - Method in class org.opentcs.access.to.model.VisualLayoutCreationTO
Returns this layout's scale on the X axis (in mm/pixel).
getScaleX() - Method in class org.opentcs.data.model.visualization.VisualLayout
Returns this layout's scale on the X axis (in mm/pixel).
getScaleY() - Method in class org.opentcs.access.to.model.VisualLayoutCreationTO
Returns this layout's scale on the Y axis (in mm/pixel).
getScaleY() - Method in class org.opentcs.data.model.visualization.VisualLayout
Returns this layout's scale on the Y axis (in mm/pixel).
getSchedulerService() - Method in interface org.opentcs.access.KernelServicePortal
Returns the service a client can use to access methods regarding the scheduler.
getSchedulerService() - Method in class org.opentcs.access.rmi.services.RemoteKernelServicePortalProxy
 
getSelectedRoutes() - Method in interface org.opentcs.components.kernel.Router
Returns an unmodifiable view on the selected routes the router knows about.
getSentQueue() - Method in class org.opentcs.drivers.vehicle.BasicVehicleCommAdapter
 
getSentQueue() - Method in interface org.opentcs.drivers.vehicle.VehicleCommAdapter
Returns a queue containing the commands that this adapter has sent to the vehicle already but which have not yet been processed by it.
getSentQueueCapacity() - Method in class org.opentcs.drivers.vehicle.BasicVehicleCommAdapter
 
getSentQueueCapacity() - Method in interface org.opentcs.drivers.vehicle.VehicleCommAdapter
Returns the capacity of this adapter's sent queue.
getServerSocketFactory() - Method in class org.opentcs.access.rmi.factories.NullSocketFactoryProvider
 
getServerSocketFactory() - Method in class org.opentcs.access.rmi.factories.SecureSocketFactoryProvider
 
getServerSocketFactory() - Method in interface org.opentcs.access.rmi.factories.SocketFactoryProvider
Returns a RMIServerSocketFactory.
getServiceListener() - Method in class org.opentcs.access.rmi.services.RemoteKernelServicePortalProxy
 
getShapeElements() - Method in class org.opentcs.access.to.model.VisualLayoutCreationTO
Deprecated.
getSocketFactoryProvider() - Method in class org.opentcs.access.rmi.KernelServicePortalBuilder
Returns the socket factory provider used for RMI.
getSource() - Method in class org.opentcs.data.notification.UserNotification
Returns this notification's (optional) source.
getSourcePoint() - Method in class org.opentcs.data.model.Path
Returns a reference to the point which this path originates in.
getSourcePoint() - Method in class org.opentcs.data.order.Route.Step
Returns the point that the vehicle is starting from.
getSrcPointName() - Method in class org.opentcs.access.to.model.PathCreationTO
Returns the point name this path originates in.
getState() - Method in interface org.opentcs.access.Kernel
Returns the current state of the kernel.
getState() - Method in interface org.opentcs.access.KernelServicePortal
Returns the current state of the kernel.
getState() - Method in class org.opentcs.access.rmi.services.RemoteKernelServicePortalProxy
 
getState() - Method in class org.opentcs.data.model.PeripheralInformation
Returns the peripheral device's current state.
getState() - Method in class org.opentcs.data.model.Vehicle
Returns this vehicle's current state.
getState() - Method in class org.opentcs.data.order.DriveOrder
Returns this drive order's state.
getState() - Method in class org.opentcs.data.order.TransportOrder
Returns this transport order's current state.
getState() - Method in class org.opentcs.data.peripherals.PeripheralJob
Returns this peripheral job's current state.
getState() - Method in class org.opentcs.drivers.peripherals.PeripheralProcessModel
Returns the peripheral device's current state.
getState(ClientID) - Method in interface org.opentcs.access.rmi.services.RemoteKernelServicePortal
 
getStep() - Method in interface org.opentcs.drivers.vehicle.MovementCommand
Returns the step describing the movement.
getSteps() - Method in class org.opentcs.data.order.Route
Returns the sequence of steps this route consists of.
getSupplement() - Method in class org.opentcs.data.ObjectHistory.Entry
Returns a supplemental object providing details about the event.
getTargetedPoints() - Method in interface org.opentcs.components.kernel.Router
Returns all points which are currently targeted by any vehicle.
getText() - Method in class org.opentcs.data.notification.UserNotification
Returns this message's text.
getTimestamp() - Method in class org.opentcs.data.notification.UserNotification
Returns this message's creation timestamp.
getTimestamp() - Method in class org.opentcs.data.ObjectHistory.Entry
Returns this entry's timestamp.
getTitle() - Method in class org.opentcs.components.kernelcontrolcenter.ControlCenterPanel
Returns a title for this panel.
getTitle() - Method in class org.opentcs.drivers.peripherals.management.PeripheralCommAdapterPanel
Returns the title for this comm adapter panel.
getTitle() - Method in class org.opentcs.drivers.vehicle.management.VehicleCommAdapterPanel
Returns the title for this comm adapter panel.
getTransportOrder() - Method in class org.opentcs.data.model.Vehicle
Returns a reference to the transport order this vehicle is currently processing.
getTransportOrder() - Method in class org.opentcs.data.order.DriveOrder
Returns a reference to the transport order this drive order belongs to.
getTransportOrderService() - Method in interface org.opentcs.access.KernelServicePortal
Returns the service a client can use to access methods regarding transport orders and order sequences.
getTransportOrderService() - Method in class org.opentcs.access.rmi.services.RemoteKernelServicePortalProxy
 
getTruststoreFile() - Method in class org.opentcs.access.SslParameterSet
Returns the file path of the truststore file.
getTruststorePassword() - Method in class org.opentcs.access.SslParameterSet
Returns the password for the truststore file.
getType() - Method in class org.opentcs.access.to.model.BlockCreationTO
Returns the type of this block.
getType() - Method in class org.opentcs.access.to.model.PointCreationTO
Returns the type of this point.
getType() - Method in class org.opentcs.access.to.order.OrderSequenceCreationTO
Returns the (optional) type of the order sequence.
getType() - Method in class org.opentcs.access.to.order.TransportOrderCreationTO
Returns the (optional) type of the transport order.
getType() - Method in class org.opentcs.data.model.Block
Retruns the type of this block.
getType() - Method in class org.opentcs.data.model.Location
Returns a reference to the type of this location.
getType() - Method in class org.opentcs.data.model.Point
Returns this point's type.
getType() - Method in class org.opentcs.data.order.OrderSequence
Returns this order sequence's type.
getType() - Method in class org.opentcs.data.order.TransportOrder
Retruns this transport order's type.
getType() - Method in class org.opentcs.data.TCSObjectEvent
Returns this event's type.
getTypeName() - Method in class org.opentcs.access.to.model.LocationCreationTO
Returns the name of this location's type.
getTypeSuggestions() - Method in interface org.opentcs.components.plantoverview.OrderTypeSuggestions
Returns a set of types that can be assigned to a transport order.
getUpdatedAttachmentInformation() - Method in class org.opentcs.drivers.vehicle.management.AttachmentEvent
Returns the AttachmentInformation to the actual attachment.
getUpdatedProcessModel() - Method in class org.opentcs.drivers.vehicle.management.ProcessModelEvent
Returns a serializable representation of the corresponding process model.
getUserName() - Method in class org.opentcs.access.rmi.KernelServicePortalBuilder
Returns the user name used for logging in.
getValue() - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel.PropertyUpdate
Returns the property's new value.
getValue() - Method in class org.opentcs.util.ExplainedBoolean
Returns the actual value.
getValueSuggestions() - Method in interface org.opentcs.components.plantoverview.PropertySuggestions
Returns suggested property values.
getValueSuggestionsFor(String) - Method in interface org.opentcs.components.plantoverview.PropertySuggestions
Returns suggested property values that are specified for the key.
getVehicleController(String) - Method in interface org.opentcs.drivers.vehicle.VehicleControllerPool
Returns the vehicle controller associated with the vehicle with the given name.
getVehicleEnergyLevel() - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Returns the vehicle's current energy level.
getVehicleLoadHandlingDevices() - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Returns the vehicle's load handling devices.
getVehicleName() - Method in class org.opentcs.drivers.vehicle.management.AttachmentEvent
Returns the vehicle's name a comm adapter has been attached to.
getVehicleName() - Method in class org.opentcs.drivers.vehicle.management.VehicleProcessModelTO
 
getVehicleOrientation() - Method in class org.opentcs.data.order.Route.Step
Returns the direction into which the vehicle is supposed to travel.
getVehicleOrientationAngle() - Method in class org.opentcs.access.to.model.PointCreationTO
Returns a vehicle's orientation angle at this position.
getVehicleOrientationAngle() - Method in class org.opentcs.data.model.Point
Returns a vehicle's orientation angle at this position.
getVehicleOrientationAngle() - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Returns the vehicle's current orientation angle.
getVehiclePosition() - Method in class org.opentcs.drivers.vehicle.management.VehicleProcessModelTO
 
getVehiclePosition() - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Returns the vehicle's current position.
getVehiclePrecisePosition() - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Returns the vehicle's precise position.
getVehicleReference() - Method in class org.opentcs.drivers.vehicle.management.AttachmentInformation
Returns the vehicle this attachment information belongs to.
getVehicleReference() - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Returns a reference to the vehicle.
getVehicles() - Method in class org.opentcs.access.to.model.PlantModelCreationTO
Returns this plant model's vehicles.
getVehicleService() - Method in interface org.opentcs.access.KernelServicePortal
Returns the service a client can use to access methods regarding vehicles.
getVehicleService() - Method in class org.opentcs.access.rmi.services.RemoteKernelServicePortalProxy
 
getVehicleState() - Method in class org.opentcs.drivers.vehicle.management.VehicleProcessModelTO
 
getVehicleState() - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Returns the vehicle's current state.
getVisualizedObject() - Method in class org.opentcs.data.model.visualization.ModelLayoutElement
Deprecated.
Returns a reference to the object this layout element corresponds to.
getVisualLayout() - Method in class org.opentcs.access.to.model.PlantModelCreationTO
Returns this plant model's visual layout.
getVisualLayouts() - Method in class org.opentcs.access.to.model.PlantModelCreationTO
getWrappingSequence() - Method in class org.opentcs.access.to.order.TransportOrderCreationTO
Returns the (optional) name of the order sequence the transport order belongs to.
getWrappingSequence() - Method in class org.opentcs.data.order.TransportOrder
Returns the order sequence this order belongs to, or null, if it doesn't belong to any sequence.
getX() - Method in class org.opentcs.data.model.Couple
Returns the x coordinate.
getX() - Method in class org.opentcs.data.model.Triple
Returns the x coordinate.
getY() - Method in class org.opentcs.data.model.Couple
Returns the y coordinate.
getY() - Method in class org.opentcs.data.model.Triple
Returns the y coordinate.
getZ() - Method in class org.opentcs.data.model.Triple
Returns the z coordinate.
GlobalSyncObject - Annotation Type in org.opentcs.customizations.kernel
Annotation type to mark an injectable synchronization object for the kernel.
Group - Class in org.opentcs.data.model
Deprecated.
Will be removed.
Group(String) - Constructor for class org.opentcs.data.model.Group
Deprecated.
Creates a new, empty group.
GroupCreationTO - Class in org.opentcs.access.to.model
Deprecated.
Will be removed.
GroupCreationTO(String) - Constructor for class org.opentcs.access.to.model.GroupCreationTO
Deprecated.
Creates a new instance.
GroupMapper - Interface in org.opentcs.components.kernel.routing
Determines the routing group for a Vehicle instance.

H

HALT_POSITION - org.opentcs.data.model.Point.Type
Indicates a position at which a vehicle may halt temporarily, e.g.
hasAllowedOperation(String) - Method in class org.opentcs.data.model.Location.Link
Checks if a vehicle is allowed to execute a given operation at this link.
hashCode() - Method in class org.opentcs.access.rmi.ClientID
 
hashCode() - Method in class org.opentcs.data.model.Couple
 
hashCode() - Method in class org.opentcs.data.model.Location.Link
Returns a hash code for this link.
hashCode() - Method in class org.opentcs.data.model.Triple
 
hashCode() - Method in class org.opentcs.data.notification.UserNotification
 
hashCode() - Method in class org.opentcs.data.order.DriveOrder.Destination
 
hashCode() - Method in class org.opentcs.data.order.Route
 
hashCode() - Method in class org.opentcs.data.order.Route.Step
 
hashCode() - Method in class org.opentcs.data.TCSObject
Returns this object's hashcode.
hashCode() - Method in class org.opentcs.data.TCSObjectReference
 
hashCode() - Method in class org.opentcs.drivers.peripherals.PeripheralCommAdapterDescription
 
hashCode() - Method in class org.opentcs.drivers.vehicle.LoadHandlingDevice
 
hashCode() - Method in class org.opentcs.drivers.vehicle.VehicleCommAdapterDescription
 
hasIncompleteName() - Method in class org.opentcs.access.to.order.OrderSequenceCreationTO
Indicates whether the name is incomplete and requires to be completed when creating the actual order sequence.
hasIncompleteName() - Method in class org.opentcs.access.to.order.TransportOrderCreationTO
Indicates whether the name is incomplete and requires to be completed when creating the actual transport order.
hasIncompleteName() - Method in class org.opentcs.access.to.peripherals.PeripheralJobCreationTO
Indicates whether the name is incomplete and requires to be completed when creating the actual transport order.
hasModelContentChanged() - Method in class org.opentcs.access.ModelTransitionEvent
Returns true if, and only if, the content of the model actually changed with the transition.
hasPreparedAllocation(Scheduler.Client, Set<TCSResource<?>>) - Method in interface org.opentcs.components.kernel.Scheduler.Module
Checks if this module is done preparing the given resources for a client.
hasProcState(Vehicle.ProcState) - Method in class org.opentcs.data.model.Vehicle
Checks if this vehicle's current processing state is equal to the given one.
hasState(Vehicle.State) - Method in class org.opentcs.data.model.Vehicle
Checks if this vehicle's current state is equal to the given one.
hasState(TransportOrder.State) - Method in class org.opentcs.data.order.TransportOrder
Checks if this transport order's current state is equal to the given one.

I

IDLE - org.opentcs.data.model.PeripheralInformation.ProcState
The peripheral device is currently not processing a job.
IDLE - org.opentcs.data.model.PeripheralInformation.State
The peripheral device is currently idle/available for processing jobs.
IDLE - org.opentcs.data.model.Vehicle.ProcState
The vehicle is currently not processing a transport order.
IDLE - org.opentcs.data.model.Vehicle.State
The vehicle is currently idle/available for processing movement orders.
ImageData - Class in org.opentcs.data.model.visualization
Deprecated.
Will be removed.
ImageData() - Constructor for class org.opentcs.data.model.visualization.ImageData
Deprecated.
Creates a new ImageData.
ImageLayoutElement - Class in org.opentcs.data.model.visualization
Deprecated.
Will be removed.
ImageLayoutElement() - Constructor for class org.opentcs.data.model.visualization.ImageLayoutElement
Deprecated.
Creates a new ImageLayoutElement.
IMPORTANT - org.opentcs.data.notification.UserNotification.Level
Marks important content the user should not miss.
importPlantModel() - Method in interface org.opentcs.components.plantoverview.PlantModelImporter
Imports (or generates) plant model data.
INFORMATIONAL - org.opentcs.data.notification.UserNotification.Level
Marks usual, informational content.
initialize() - Method in interface org.opentcs.components.Lifecycle
(Re-)Initializes this component before it is being used.
initialize() - Method in class org.opentcs.drivers.peripherals.BasicPeripheralCommAdapter
(Re-)Initializes this component before it is being used.
initialize() - Method in class org.opentcs.drivers.vehicle.BasicVehicleCommAdapter
(Re-)Initializes this component before it is being used.
InitPositionCommand - Class in org.opentcs.drivers.vehicle.commands
A command for initializing the comm adapter's position.
InitPositionCommand(String) - Constructor for class org.opentcs.drivers.vehicle.commands.InitPositionCommand
Creates a new instance.
initVehiclePosition(String) - Method in interface org.opentcs.drivers.vehicle.SimVehicleCommAdapter
Sets an initial vehicle position.
InternalPeripheralJobService - Interface in org.opentcs.components.kernel.services
Declares the methods the peripheral job service must provide which are not accessible to remote peers.
InternalPeripheralService - Interface in org.opentcs.components.kernel.services
Declares the methods the peripheral service must provide which are not accessible to remote peers.
InternalPlantModelService - Interface in org.opentcs.components.kernel.services
Declares the methods the plant model service must provide which are not accessible to remote peers.
InternalQueryService - Interface in org.opentcs.components.kernel.services
Declares query-related methods not accessible to remote peers.
InternalTransportOrderService - Interface in org.opentcs.components.kernel.services
Declares the methods the transport order service must provide which are not accessible to remote peers.
InternalVehicleService - Interface in org.opentcs.components.kernel.services
Declares the methods the vehicle service must provide which are not accessible to remote peers.
isAllowedOperation(String) - Method in class org.opentcs.data.model.LocationType
Checks if a given operation is allowed with locations of this type.
isClosed() - Method in interface org.opentcs.access.SharedKernelServicePortal
Indicates whether this instance is closed/unregistered from the shared portal pool.
isCommAdapterConnected() - Method in class org.opentcs.drivers.peripherals.PeripheralProcessModel
Returns whether the communication adapter is currently connected to the peripheral device.
isCommAdapterConnected() - Method in class org.opentcs.drivers.vehicle.management.VehicleProcessModelTO
 
isCommAdapterConnected() - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Indicates whether the comm adapter is currently connected or not.
isCommAdapterEnabled() - Method in class org.opentcs.drivers.peripherals.PeripheralProcessModel
Returns whether the communication adapter is currently enabled.
isCommAdapterEnabled() - Method in class org.opentcs.drivers.vehicle.management.VehicleProcessModelTO
 
isCommAdapterEnabled() - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Indicates whether the comm adapter is currently enabled or not.
isComplete() - Method in class org.opentcs.data.order.OrderSequence
Indicates whether this order sequence is complete and will not be extended by more orders.
isCompletionRequired() - Method in class org.opentcs.access.to.peripherals.PeripheralOperationCreationTO
Returns whether the completion of this operation is required to allow a vehicle to continue driving.
isCompletionRequired() - Method in class org.opentcs.data.peripherals.PeripheralOperation
Returns whether the completion of this operation is required to allow a vehicle to continue driving.
isDispensable() - Method in class org.opentcs.access.to.order.TransportOrderCreationTO
Returns whether the transport order is dispensable or not.
isDispensable() - Method in class org.opentcs.data.order.TransportOrder
Checks if this order is dispensable.
isEnabled() - Method in class org.opentcs.drivers.peripherals.BasicPeripheralCommAdapter
 
isEnabled() - Method in interface org.opentcs.drivers.peripherals.PeripheralCommAdapter
Checks whether this communication adapter is enabled.
isEnabled() - Method in class org.opentcs.drivers.vehicle.BasicVehicleCommAdapter
 
isEnabled() - Method in interface org.opentcs.drivers.vehicle.VehicleCommAdapter
Checks whether this communication adapter is enabled.
isEnergyLevelCritical() - Method in class org.opentcs.data.model.Vehicle
Checks whether the vehicle's energy level is critical.
isEnergyLevelDegraded() - Method in class org.opentcs.data.model.Vehicle
Checks whether the vehicle's energy level is degraded (not good any more).
isEnergyLevelFullyRecharged() - Method in class org.opentcs.data.model.Vehicle
Checks whether the vehicle's energy level is fully recharged.
isEnergyLevelGood() - Method in class org.opentcs.data.model.Vehicle
Checks whether the vehicle's energy level is good.
isEnergyLevelSufficientlyRecharged() - Method in class org.opentcs.data.model.Vehicle
Checks whether the vehicle's energy level is sufficiently recharged.
isExecutionAllowed() - Method in class org.opentcs.data.order.Route.Step
Returns whether execution of this step is allowed.
isFailureFatal() - Method in class org.opentcs.access.to.order.OrderSequenceCreationTO
Returns whether failure of one transport order in the sequence makes subsequent ones fail, too.
isFailureFatal() - Method in class org.opentcs.data.order.OrderSequence
Indicates whether the failure of a single order in this sequence implies that all subsequent orders in this sequence are to be considered failed, too.
isFinalMovement() - Method in interface org.opentcs.drivers.vehicle.MovementCommand
Indicates whether this movement is the final one in the driver order it belongs to.
isFinalState() - Method in enum org.opentcs.data.order.TransportOrder.State
Checks if this state is a final state for a transport order.
isFinished() - Method in class org.opentcs.data.order.OrderSequence
Indicates whether this order sequence has been processed completely.
isFull() - Method in class org.opentcs.drivers.vehicle.LoadHandlingDevice
Returns a flag indicating whether this device is filled to its maximum capacity or not.
isHaltingPosition() - Method in class org.opentcs.data.model.Point
Checks whether halting on this point is allowed.
isIgnoringInterrupts() - Method in class org.opentcs.util.CyclicTask
Indicates whether this task is ignoring interrupts while it's sleeping.
isInitialized() - Method in interface org.opentcs.components.Lifecycle
Checks whether this component is initialized.
isInitialized() - Method in class org.opentcs.drivers.peripherals.BasicPeripheralCommAdapter
 
isInitialized() - Method in class org.opentcs.drivers.vehicle.BasicVehicleCommAdapter
 
isLocked() - Method in class org.opentcs.access.to.model.LocationCreationTO
Returns the lock status of this location (i.e.
isLocked() - Method in class org.opentcs.access.to.model.PathCreationTO
Returns the lock status of this path (i.e.
isLocked() - Method in class org.opentcs.data.model.Location
Returns the lock status of this location (i.e.
isLocked() - Method in class org.opentcs.data.model.Path
Return the lock status of this path (i.e.
isNavigableForward() - Method in class org.opentcs.data.model.Path
Checks whether this path is navigable in forward direction.
isNavigableReverse() - Method in class org.opentcs.data.model.Path
Checks whether this path is navigable in backward/reverse direction.
isNavigableTo(TCSObjectReference<Point>) - Method in class org.opentcs.data.model.Path
Checks whether this path is navigable towards the given point.
isParkingPosition() - Method in class org.opentcs.data.model.Point
Checks whether parking a vehicle on this point is allowed.
isProcessingOrder() - Method in class org.opentcs.data.model.Vehicle
Checks if this vehicle is currently processing any transport order.
isSimVehicleCommAdapter() - Method in class org.opentcs.drivers.vehicle.DefaultVehicleCommAdapterDescription
 
isSimVehicleCommAdapter() - Method in class org.opentcs.drivers.vehicle.VehicleCommAdapterDescription
Whether the comm adapter is a simulating one.
isTerminated() - Method in class org.opentcs.util.CyclicTask
Indicates whether this task has been terminated.
isTransitionFinished() - Method in class org.opentcs.access.KernelStateTransitionEvent
Returns true if, and only if, the transition to the new kernel state is finished.
isTransitionFinished() - Method in class org.opentcs.access.ModelTransitionEvent
Returns true if, and only if, the transition to the new kernel state is finished.
isTravellingReverse() - Method in class org.opentcs.components.kernel.routing.Edge
Indicates whether the path is travelled in reverse direction.
isVehicleConnected() - Method in class org.opentcs.drivers.vehicle.BasicVehicleCommAdapter
Checks whether the communication channel to the vehicle is open.
isVisible() - Method in class org.opentcs.data.model.visualization.Layer
Returns whether this layer is visible or not.
isVisible() - Method in class org.opentcs.data.model.visualization.LayerGroup
Returns whether this layer group is visible or not.
isWithoutOperation() - Method in interface org.opentcs.drivers.vehicle.MovementCommand
Checks whether an operation is to be executed in addition to moving or not.

J

JOB_CREATED - Static variable in interface org.opentcs.data.peripherals.PeripheralJobHistoryCodes
An event code indicating a peripheral job has been created.
JOB_REACHED_FINAL_STATE - Static variable in interface org.opentcs.data.peripherals.PeripheralJobHistoryCodes
An event code indicating a peripheral job was marked as being in a final state.

K

Kernel - Interface in org.opentcs.access
Declares the methods an openTCS kernel implements.
Kernel.State - Enum in org.opentcs.access
The various states a kernel instance may be running in.
KernelException - Exception in org.opentcs.access
An exception thrown by the openTCS kernel.
KernelException() - Constructor for exception org.opentcs.access.KernelException
Constructs a new instance with no detail message.
KernelException(String) - Constructor for exception org.opentcs.access.KernelException
Constructs a new instance with the specified detail message.
KernelException(String, Throwable) - Constructor for exception org.opentcs.access.KernelException
Constructs a new instance with the specified detail message and cause.
KernelException(Throwable) - Constructor for exception org.opentcs.access.KernelException
Constructs a new instance with the specified cause and a detail message of (cause == null ? null : cause.toString()) (which typically contains the class and detail message of cause).
KernelExecutor - Annotation Type in org.opentcs.customizations.kernel
Annotation type to mark a central injectable ScheduledExecutorService.
KernelExtension - Interface in org.opentcs.components.kernel
Declares the methods that a generic kernel extension must implement.
KernelRuntimeException - Exception in org.opentcs.access
A runtime exception thrown by the openTCS kernel.
KernelRuntimeException() - Constructor for exception org.opentcs.access.KernelRuntimeException
Constructs a new instance with no detail message.
KernelRuntimeException(String) - Constructor for exception org.opentcs.access.KernelRuntimeException
Constructs a new instance with the specified detail message.
KernelRuntimeException(String, Throwable) - Constructor for exception org.opentcs.access.KernelRuntimeException
Constructs a new instance with the specified detail message and cause.
KernelRuntimeException(Throwable) - Constructor for exception org.opentcs.access.KernelRuntimeException
Constructs a new instance with the specified cause and a detail message of (cause == null ? null : cause.toString()) (which typically contains the class and detail message of cause).
KernelServicePortal - Interface in org.opentcs.access
Provides clients access to kernel services.
KernelServicePortalBuilder - Class in org.opentcs.access.rmi
Builds KernelServicePortal instances for connections to remote portals.
KernelServicePortalBuilder(String, String) - Constructor for class org.opentcs.access.rmi.KernelServicePortalBuilder
Creates a new instance.
KernelStateTransitionEvent - Class in org.opentcs.access
Emitted by/for kernel state changes.
KernelStateTransitionEvent(Kernel.State, Kernel.State, boolean) - Constructor for class org.opentcs.access.KernelStateTransitionEvent
Creates a new TCSKernelStateEvent.

L

label(Vehicle) - Method in interface org.opentcs.components.plantoverview.VehicleTheme
Provides a label that describes this vehicle.
labelColor() - Method in interface org.opentcs.components.plantoverview.VehicleTheme
Provides the color to be used for drawing the label.
labelFont() - Method in interface org.opentcs.components.plantoverview.VehicleTheme
Provides the font to be used for drawing the label.
labelOffsetX() - Method in interface org.opentcs.components.plantoverview.VehicleTheme
Provides the vertical offset of the label relative to the center of the vehicle figure.
labelOffsetY() - Method in interface org.opentcs.components.plantoverview.VehicleTheme
Provides the vertical offset of the label relative to the center of the vehicle figure.
Layer - Class in org.opentcs.data.model.visualization
Describes a layer in a plant model which is used to group model elements.
Layer(int, int, boolean, String, int) - Constructor for class org.opentcs.data.model.visualization.Layer
Creates a new instance.
LayerGroup - Class in org.opentcs.data.model.visualization
Describes a layer group in a plant model.
LayerGroup(int, String, boolean) - Constructor for class org.opentcs.data.model.visualization.LayerGroup
Creates a new instance.
Layout() - Constructor for class org.opentcs.access.to.model.BlockCreationTO.Layout
Creates a new instance.
Layout() - Constructor for class org.opentcs.access.to.model.LocationCreationTO.Layout
Creates a new instance.
Layout() - Constructor for class org.opentcs.access.to.model.LocationTypeCreationTO.Layout
Creates a new instance.
Layout() - Constructor for class org.opentcs.access.to.model.PathCreationTO.Layout
Creates a new instance.
Layout() - Constructor for class org.opentcs.access.to.model.PointCreationTO.Layout
Creates a new instance.
Layout() - Constructor for class org.opentcs.access.to.model.VehicleCreationTO.Layout
Creates a new instance.
Layout() - Constructor for class org.opentcs.data.model.Block.Layout
Creates a new instance.
Layout() - Constructor for class org.opentcs.data.model.Location.Layout
Creates a new instance.
Layout() - Constructor for class org.opentcs.data.model.LocationType.Layout
Creates a new instance.
Layout() - Constructor for class org.opentcs.data.model.Path.Layout
Creates a new instance.
Layout() - Constructor for class org.opentcs.data.model.Point.Layout
Creates a new instance.
Layout() - Constructor for class org.opentcs.data.model.Vehicle.Layout
Creates a new instance.
Layout(Color) - Constructor for class org.opentcs.access.to.model.BlockCreationTO.Layout
Creates a new instance.
Layout(Color) - Constructor for class org.opentcs.access.to.model.VehicleCreationTO.Layout
Creates a new instance.
Layout(Color) - Constructor for class org.opentcs.data.model.Block.Layout
Creates a new instance.
Layout(Color) - Constructor for class org.opentcs.data.model.Vehicle.Layout
Creates a new instance.
Layout(Couple, Couple, int) - Constructor for class org.opentcs.access.to.model.PointCreationTO.Layout
Creates a new instance.
Layout(Couple, Couple, int) - Constructor for class org.opentcs.data.model.Point.Layout
Creates a new instance.
Layout(Couple, Couple, LocationRepresentation, int) - Constructor for class org.opentcs.access.to.model.LocationCreationTO.Layout
Creates a new instance.
Layout(Couple, Couple, LocationRepresentation, int) - Constructor for class org.opentcs.data.model.Location.Layout
Creates a new instance.
Layout(Path.Layout.ConnectionType, List<Couple>, int) - Constructor for class org.opentcs.access.to.model.PathCreationTO.Layout
Creates a new instance.
Layout(Path.Layout.ConnectionType, List<Couple>, int) - Constructor for class org.opentcs.data.model.Path.Layout
Creates a new instance.
Layout(LocationRepresentation) - Constructor for class org.opentcs.access.to.model.LocationTypeCreationTO.Layout
Creates a new instance.
Layout(LocationRepresentation) - Constructor for class org.opentcs.data.model.LocationType.Layout
Creates a new instance.
LayoutElement - Class in org.opentcs.data.model.visualization
Deprecated.
Will be removed.
LayoutElement() - Constructor for class org.opentcs.data.model.visualization.LayoutElement
Deprecated.
Creates a new LayoutElement.
Lifecycle - Interface in org.opentcs.components
Defines methods for controlling a generic component's lifecycle.
Link(TCSResourceReference<Location>, TCSResourceReference<Point>) - Constructor for class org.opentcs.data.model.Location.Link
Creates a new Link.
listWithAppendix(List<T>, T) - Static method in class org.opentcs.access.to.CreationTO
Returns a new list, with the elements of the given list and the given element added to it.
listWithoutNullValues(List<V>) - Static method in class org.opentcs.data.TCSObject
Returns a new list with the values from the given list but all null values removed.
LOAD_HANDLING_DEVICES - org.opentcs.drivers.vehicle.VehicleProcessModel.Attribute
Indicates a change of the vehicle's load handling devices.
LOAD_TRANSFER_ALT_1 - org.opentcs.data.model.visualization.LocationRepresentation
A location for vehicle load transfers, alternative variant 1.
LOAD_TRANSFER_ALT_2 - org.opentcs.data.model.visualization.LocationRepresentation
A location for vehicle load transfers, alternative variant 2.
LOAD_TRANSFER_ALT_3 - org.opentcs.data.model.visualization.LocationRepresentation
A location for vehicle load transfers, alternative variant 3.
LOAD_TRANSFER_ALT_4 - org.opentcs.data.model.visualization.LocationRepresentation
A location for vehicle load transfers, alternative variant 4.
LOAD_TRANSFER_ALT_5 - org.opentcs.data.model.visualization.LocationRepresentation
A location for vehicle load transfers, alternative variant 5.
LOAD_TRANSFER_GENERIC - org.opentcs.data.model.visualization.LocationRepresentation
A location for vehicle load transfer, generic variant.
LoadHandlingDevice - Class in org.opentcs.drivers.vehicle
Describes a single load handling device on a vehicle.
LoadHandlingDevice(String, boolean) - Constructor for class org.opentcs.drivers.vehicle.LoadHandlingDevice
Creates a new LoadHandlingDevice.
LoadHandlingDevice(LoadHandlingDevice) - Constructor for class org.opentcs.drivers.vehicle.LoadHandlingDevice
Creates a new LoadHandlingDevice as a copy of the given one.
loadPlantModel() - Method in interface org.opentcs.components.kernel.services.InternalPlantModelService
Loads the saved model into the kernel.
LOC_DEFAULT_REPRESENTATION - Static variable in interface org.opentcs.data.ObjectPropConstants
A property key for Location instances used to provide a hint for the visualization how the locations should be visualized.
LOC_LABEL_OFFSET_X - Static variable in interface org.opentcs.data.model.visualization.ElementPropKeys
X offset of the label's position to the object's position (in lu).
LOC_LABEL_OFFSET_Y - Static variable in interface org.opentcs.data.model.visualization.ElementPropKeys
Y offset of the label's position to the object's position (in lu).
LOC_LABEL_ORIENTATION_ANGLE - Static variable in interface org.opentcs.data.model.visualization.ElementPropKeys
Orientation angle of the label (in degrees).
LOC_POS_X - Static variable in interface org.opentcs.data.model.visualization.ElementPropKeys
X coordinate at which the location is to be drawn (in mm).
LOC_POS_Y - Static variable in interface org.opentcs.data.model.visualization.ElementPropKeys
Y coordinate at which the location is to be drawn (in mm).
LocalKernel - Interface in org.opentcs.access
Declares the methods the openTCS kernel must provide which are not accessible to remote peers.
Location - Class in org.opentcs.data.model
A location at which a Vehicle may perform an action.
Location(String, TCSObjectReference<LocationType>) - Constructor for class org.opentcs.data.model.Location
Creates a new Location.
LOCATION - org.opentcs.drivers.peripherals.PeripheralProcessModel.Attribute
Indicates a change of the location property.
Location.Layout - Class in org.opentcs.data.model
Contains information regarding the grahical representation of a location.
Location.Link - Class in org.opentcs.data.model
A link connecting a point and a location, expressing that the location is reachable from the point.
LocationCreationTO - Class in org.opentcs.access.to.model
A transfer object describing a location in a plant model.
LocationCreationTO(String, String, Triple) - Constructor for class org.opentcs.access.to.model.LocationCreationTO
Creates a new instance
LocationCreationTO.Layout - Class in org.opentcs.access.to.model
Contains information regarding the grahical representation of a location.
LocationRepresentation - Enum in org.opentcs.data.model.visualization
Common location representations.
LocationTheme - Interface in org.opentcs.components.plantoverview
Provides a location theme.
LocationType - Class in org.opentcs.data.model
Describes the type of a Location.
LocationType(String) - Constructor for class org.opentcs.data.model.LocationType
Creates a new LocationType.
LocationType.Layout - Class in org.opentcs.data.model
Contains information regarding the grahical representation of a location type.
LocationTypeCreationTO - Class in org.opentcs.access.to.model
A transfer object describing a location type in the plant model.
LocationTypeCreationTO(String) - Constructor for class org.opentcs.access.to.model.LocationTypeCreationTO
Creates a new instance.
LocationTypeCreationTO.Layout - Class in org.opentcs.access.to.model
Contains information regarding the grahical representation of a location type.
LOCTYPE_DEFAULT_REPRESENTATION - Static variable in interface org.opentcs.data.ObjectPropConstants
A property key for LocationType instances used to provide a hint for the visualization how locations of the type should be visualized.
login(String, int) - Method in interface org.opentcs.access.KernelServicePortal
Logs in with/establishes a connection to the remote kernel service portal.
login(String, int) - Method in class org.opentcs.access.rmi.services.RemoteKernelServicePortalProxy
 
login(String, String, Predicate<Object>) - Method in interface org.opentcs.access.rmi.services.RemoteKernelServicePortal
Introduce the calling client to the server and authenticate for operations.
logout() - Method in interface org.opentcs.access.KernelServicePortal
Logs out from/clears the connection to the remote kernel service portal.
logout() - Method in class org.opentcs.access.rmi.services.RemoteKernelServicePortalProxy
 
logout(ClientID) - Method in interface org.opentcs.access.rmi.services.RemoteKernelServicePortal
 
LowLevelCommunicationEvent - Interface in org.opentcs.drivers
Marks low-level communication events.

M

mapWithMapping(Map<K, V>, K, V) - Static method in class org.opentcs.access.to.CreationTO
Returns a new map, with the mappings of the given map and the given mapping added to it.
mapWithoutNullValues(Map<K, V>) - Static method in class org.opentcs.data.TCSObject
Returns a new map with the entries from the given map but all entries with null values removed.
markOrderSequenceComplete(ClientID, TCSObjectReference<OrderSequence>) - Method in interface org.opentcs.access.rmi.services.RemoteTransportOrderService
 
markOrderSequenceComplete(TCSObjectReference<OrderSequence>) - Method in interface org.opentcs.components.kernel.services.TransportOrderService
Marks an order sequence as complete by setting its complete flag.
markOrderSequenceFinished(TCSObjectReference<OrderSequence>) - Method in interface org.opentcs.components.kernel.services.InternalTransportOrderService
Sets an order sequence's finished flag.
mayAllocate(Scheduler.Client, Set<TCSResource<?>>) - Method in interface org.opentcs.components.kernel.Scheduler.Module
Checks if the resulting system state is safe if the given set of resources would be allocated by the given resource user.
MODEL_FILE_LAST_MODIFIED - Static variable in interface org.opentcs.data.ObjectPropConstants
A property key for models used to store the last-modified time stamp.
ModelConstants - Interface in org.opentcs.data.model
Defines some constants used for plant models.
ModelLayoutElement - Class in org.opentcs.data.model.visualization
Deprecated.
Will be removed in favor of dedicated layout classes in corresponding TCS data objects.
ModelLayoutElement(TCSObjectReference<?>) - Constructor for class org.opentcs.data.model.visualization.ModelLayoutElement
Deprecated.
Creates a new ModelLayoutElement for the given model element.
ModelLayoutElementCreationTO - Class in org.opentcs.access.to.model
Deprecated.
Will be removed in favor of dedicated layout classes in corresponding TCS data objects.
ModelLayoutElementCreationTO(String) - Constructor for class org.opentcs.access.to.model.ModelLayoutElementCreationTO
Deprecated.
Creates a new instance.
MODELLING - org.opentcs.access.Kernel.State
The state in which the model/topology is created and parameters are set.
ModelTransitionEvent - Class in org.opentcs.access
Emitted when the kernel loads a model.
ModelTransitionEvent(String, String, boolean, boolean) - Constructor for class org.opentcs.access.ModelTransitionEvent
Creates a new TCSModelTransitionEvent.
MOVE_OPERATION - Static variable in interface org.opentcs.drivers.vehicle.MovementCommand
A constant indicating the vehicle should basically just move to a point without a location associated to it.
MovementCommand - Interface in org.opentcs.drivers.vehicle
A command for moving a step.

N

negate() - Method in class org.opentcs.util.ClassMatcher
 
NO_OPERATION - Static variable in interface org.opentcs.drivers.vehicle.MovementCommand
A constant indicating there is no operation to be executed after moving.
NO_PERIPHERAL - org.opentcs.data.model.PeripheralInformation.State
Indicates that the location the PeripheralInformation belongs to doesn't represent a peripheral device.
NONE - org.opentcs.data.model.visualization.LocationRepresentation
A (empty) location without any representation.
NOTEWORTHY - org.opentcs.data.notification.UserNotification.Level
Marks unusual content a user would probably be interested in.
NotificationPublicationEvent - Class in org.opentcs.access
Instances of this class represent events emitted by/for notifications being published.
NotificationPublicationEvent(UserNotification) - Constructor for class org.opentcs.access.NotificationPublicationEvent
Creates a new instance.
NotificationService - Interface in org.opentcs.components.kernel.services
Provides methods concerning UserNotifications.
NullSocketFactoryProvider - Class in org.opentcs.access.rmi.factories
Provides null for both client and server socket factories.
NullSocketFactoryProvider() - Constructor for class org.opentcs.access.rmi.factories.NullSocketFactoryProvider
 

O

OBJECT_CREATED - org.opentcs.data.TCSObjectEvent.Type
Indicates that the referenced object has been newly created.
OBJECT_MODIFIED - org.opentcs.data.TCSObjectEvent.Type
Indicates that the referenced object has been modified.
OBJECT_REMOVED - org.opentcs.data.TCSObjectEvent.Type
Indicates that the referenced object is no longer a valid kernel object.
ObjectExistsException - Exception in org.opentcs.data
Thrown when an object was supposed to be created or renamed, but another object with the same ID/name/attributes already exists.
ObjectExistsException(String) - Constructor for exception org.opentcs.data.ObjectExistsException
Creates a new ObjectExistsException with the given detail message.
ObjectExistsException(String, Throwable) - Constructor for exception org.opentcs.data.ObjectExistsException
Creates a new ObjectExistsException with the given detail message and cause.
ObjectHistory - Class in org.opentcs.data
A history of events related to an object.
ObjectHistory() - Constructor for class org.opentcs.data.ObjectHistory
Creates a new instance.
ObjectHistory.Entry - Class in org.opentcs.data
An entry/event in a history.
ObjectHistoryEntryFormatter - Interface in org.opentcs.components.plantoverview
A formatter for ObjectHistory entries, mapping an entry to a user-presentable string, if possible.
ObjectNameProvider - Interface in org.opentcs.components.kernel
 
ObjectPropConstants - Interface in org.opentcs.data
Defines some reserved/commonly used property keys and values.
ObjectUnknownException - Exception in org.opentcs.data
Thrown when an object was supposed to be returned/removed/modified, but could not be found.
ObjectUnknownException(String) - Constructor for exception org.opentcs.data.ObjectUnknownException
Creates a new ObjectExistsException with the given detail message.
ObjectUnknownException(String, Throwable) - Constructor for exception org.opentcs.data.ObjectUnknownException
Creates a new ObjectExistsException with the given detail message and cause.
ObjectUnknownException(TCSObjectReference<?>) - Constructor for exception org.opentcs.data.ObjectUnknownException
Creates a new ObjectExistsException for the given object reference.
onEvent(Object) - Method in interface org.opentcs.util.event.EventHandler
Processes the event object.
onEvent(Object) - Method in class org.opentcs.util.event.SimpleEventBus
 
onServiceUnavailable() - Method in class org.opentcs.access.rmi.services.RemoteKernelServicePortalProxy
 
onServiceUnavailable() - Method in interface org.opentcs.access.rmi.services.ServiceListener
Notifies a listener that the service is unavailable, i.e.
OP_MOVE - Static variable in class org.opentcs.data.order.DriveOrder.Destination
An operation constant for sending the vehicle to a point without a location associated to it.
OP_NOP - Static variable in class org.opentcs.data.order.DriveOrder.Destination
An operation constant for doing nothing.
OP_PARK - Static variable in class org.opentcs.data.order.DriveOrder.Destination
An operation constant for parking the vehicle.
OPERATING - org.opentcs.access.Kernel.State
The normal mode of operation in which transport orders may be accepted and dispatched to vehicles.
OPERATING - org.opentcs.data.order.DriveOrder.State
Indicates the vehicle processing the order is currently executing an operation.
ORDER_ASSIGNED_TO_VEHICLE - Static variable in interface org.opentcs.data.order.TransportOrderHistoryCodes
An event code indicating a transport order was assigned to a vehicle.
ORDER_CREATED - Static variable in interface org.opentcs.data.order.TransportOrderHistoryCodes
An event code indicating a transport order has been created.
ORDER_DISPATCHING_DEFERRED - Static variable in interface org.opentcs.data.order.TransportOrderHistoryCodes
An event code indicating dispatching of a transport order to a vehicle has been deferred.
ORDER_DISPATCHING_RESUMED - Static variable in interface org.opentcs.data.order.TransportOrderHistoryCodes
An event code indicating dispatching of a transport order to a vehicle has been resumed.
ORDER_DRIVE_ORDER_FINISHED - Static variable in interface org.opentcs.data.order.TransportOrderHistoryCodes
An event code indicating one of a transport order's drive orders has been finished.
ORDER_PROCESSING_VEHICLE_CHANGED - Static variable in interface org.opentcs.data.order.TransportOrderHistoryCodes
An event code indicating a transport order's processing vehicle changed.
ORDER_REACHED_FINAL_STATE - Static variable in interface org.opentcs.data.order.TransportOrderHistoryCodes
An event code indicating a transport order was marked as being in a final state.
ORDER_RESERVED_FOR_VEHICLE - Static variable in interface org.opentcs.data.order.TransportOrderHistoryCodes
An event code indicating a transport order was reserved for a vehicle.
OrderCategorySuggestions - Interface in org.opentcs.components.plantoverview
Deprecated.
OrderConstants - Interface in org.opentcs.data.order
Defines some constants for TransportOrders and OrderSequences.
orderKey() - Method in annotation type org.opentcs.configuration.ConfigurationEntry
Returns the optional ordering key that this entry belongs to (for grouping/sorting of entries).
OrderSequence - Class in org.opentcs.data.order
Describes a process spanning multiple TransportOrders which are to be executed subsequently by the same Vehicle.
OrderSequence(String) - Constructor for class org.opentcs.data.order.OrderSequence
Creates a new OrderSequence.
OrderSequenceCleanupApproval - Interface in org.opentcs.components.kernel
Implementations of this interface check whether an order sequence may be removed.
OrderSequenceCreationTO - Class in org.opentcs.access.to.order
A transfer object describing a transport order.
OrderSequenceCreationTO(String) - Constructor for class org.opentcs.access.to.order.OrderSequenceCreationTO
Creates a new instance.
OrderTypeSuggestions - Interface in org.opentcs.components.plantoverview
Implementations of this class provide suggestions for transport order types.
org.opentcs.access - package org.opentcs.access
Interfaces and classes for accessing the kernel from outside, for instance from a remote client or a communication adapter.
org.opentcs.access.rmi - package org.opentcs.access.rmi
Interfaces and classes for transparently providing an openTCS kernel's functionality via RMI.
org.opentcs.access.rmi.factories - package org.opentcs.access.rmi.factories
Interfaces and classes for configuration of the RMI runtime used by openTCS kernel and clients.
org.opentcs.access.rmi.services - package org.opentcs.access.rmi.services
Interfaces and classes for transparently providing an openTCS kernel's service functionality via RMI.
org.opentcs.access.to - package org.opentcs.access.to
Transfer object classes for domain objects.
org.opentcs.access.to.model - package org.opentcs.access.to.model
Transfer object classes for plant model objects.
org.opentcs.access.to.order - package org.opentcs.access.to.order
Transfer object classes for transport order objects.
org.opentcs.access.to.peripherals - package org.opentcs.access.to.peripherals
 
org.opentcs.components - package org.opentcs.components
Interfaces and base classes for exchangeable components of openTCS applications.
org.opentcs.components.kernel - package org.opentcs.components.kernel
Interfaces for pluggable strategies and other components for a kernel application.
org.opentcs.components.kernel.routing - package org.opentcs.components.kernel.routing
 
org.opentcs.components.kernel.services - package org.opentcs.components.kernel.services
Interfaces and classes defining internal and external interfaces for the openTCS kernel.
org.opentcs.components.kernelcontrolcenter - package org.opentcs.components.kernelcontrolcenter
 
org.opentcs.components.plantoverview - package org.opentcs.components.plantoverview
Interfaces for pluggable panels, themes and other components for a plant overview application.
org.opentcs.configuration - package org.opentcs.configuration
Configuration-related interfaces and annotations.
org.opentcs.customizations - package org.opentcs.customizations
Classes utilized for extending and customizing openTCS applications.
org.opentcs.customizations.controlcenter - package org.opentcs.customizations.controlcenter
Components supporting extension and customization of the openTCS kernel control center application.
org.opentcs.customizations.kernel - package org.opentcs.customizations.kernel
Components supporting extension and customization of the openTCS kernel application.
org.opentcs.customizations.plantoverview - package org.opentcs.customizations.plantoverview
 
org.opentcs.data - package org.opentcs.data
Basic openTCS data structures.
org.opentcs.data.model - package org.opentcs.data.model
Classes for maintaining the (mainly static) structure and content of openTCS course layouts and the attributes and state of vehicles.
org.opentcs.data.model.visualization - package org.opentcs.data.model.visualization
Classes describing the visual attributes of a model.
org.opentcs.data.notification - package org.opentcs.data.notification
Classes for storing user-targeted notifications.
org.opentcs.data.order - package org.opentcs.data.order
Classes describing transport orders to be processed by vehicles.
org.opentcs.data.peripherals - package org.opentcs.data.peripherals
Classes describing peripheral jobs to be processed by peripheral devices.
org.opentcs.drivers - package org.opentcs.drivers
 
org.opentcs.drivers.peripherals - package org.opentcs.drivers.peripherals
Components needed for controlling peripheral devices and processing information sent by them.
org.opentcs.drivers.peripherals.management - package org.opentcs.drivers.peripherals.management
Components needed for processing information related to peripheral comm adapters.
org.opentcs.drivers.vehicle - package org.opentcs.drivers.vehicle
Components needed for controlling physical vehicles and processing information sent by them.
org.opentcs.drivers.vehicle.commands - package org.opentcs.drivers.vehicle.commands
Commands a comm adapter may execute.
org.opentcs.drivers.vehicle.management - package org.opentcs.drivers.vehicle.management
Components needed for processing information related to comm adapters.
org.opentcs.drivers.vehicle.messages - package org.opentcs.drivers.vehicle.messages
Reference implementations of commonly used messages to be processed by vehicle drivers.
org.opentcs.util - package org.opentcs.util
A collection of classes providing miscellaneous functions that are used throughout openTCS.
org.opentcs.util.annotations - package org.opentcs.util.annotations
Useful annotations.
org.opentcs.util.event - package org.opentcs.util.event
Interfaces and classes for event handling.
ORIENTATION_ANGLE - org.opentcs.drivers.vehicle.VehicleProcessModel.Attribute
Indicates a change of the vehicle's orientation angle.

P

PARK_OPERATION - Static variable in interface org.opentcs.drivers.vehicle.MovementCommand
A constant for parking the vehicle.
PARK_POSITION - org.opentcs.data.model.Point.Type
Indicates a position at which a vehicle may halt for longer periods of time when it is not processing orders.
Path - Class in org.opentcs.data.model
Describes a connection between two Points which a Vehicle may traverse.
Path(String, TCSObjectReference<Point>, TCSObjectReference<Point>) - Constructor for class org.opentcs.data.model.Path
Creates a new Path.
PATH_CONN_TYPE - Static variable in interface org.opentcs.data.model.visualization.ElementPropKeys
The drawing type of the path.
PATH_CONTROL_POINTS - Static variable in interface org.opentcs.data.model.visualization.ElementPropKeys
Control points describing the way the connection is being drawn (if the connection type is not Direct).
Path.Layout - Class in org.opentcs.data.model
Contains information regarding the grahical representation of a path.
Path.Layout.ConnectionType - Enum in org.opentcs.data.model
The connection type a path is represented as.
PathCreationTO - Class in org.opentcs.access.to.model
A transfer object describing a path in the plant model.
PathCreationTO(String, String, String) - Constructor for class org.opentcs.access.to.model.PathCreationTO
Creates a new instance.
PathCreationTO.Layout - Class in org.opentcs.access.to.model
Contains information regarding the grahical representation of a path.
PeripheralAdapterCommand - Interface in org.opentcs.drivers.peripherals
A command a peripheral communication adapter may execute.
PeripheralAttachmentEvent - Class in org.opentcs.drivers.peripherals.management
Instances of this class represent events emitted by/for attaching comm adapters.
PeripheralAttachmentEvent(TCSResourceReference<Location>, PeripheralAttachmentInformation) - Constructor for class org.opentcs.drivers.peripherals.management.PeripheralAttachmentEvent
Creates a new instance.
PeripheralAttachmentInformation - Class in org.opentcs.drivers.peripherals.management
Describes which communication adapter a location is currently associated with.
PeripheralAttachmentInformation(TCSResourceReference<Location>, PeripheralCommAdapterDescription) - Constructor for class org.opentcs.drivers.peripherals.management.PeripheralAttachmentInformation
Creates a new instance.
PeripheralCommAdapter - Interface in org.opentcs.drivers.peripherals
This interface declares the methods that a driver communicating with and controlling a peripheral device must implement.
PeripheralCommAdapterDescription - Class in org.opentcs.drivers.peripherals
Provides the description for a peripheral communication adapter.
PeripheralCommAdapterDescription() - Constructor for class org.opentcs.drivers.peripherals.PeripheralCommAdapterDescription
 
PeripheralCommAdapterEvent - Class in org.opentcs.drivers.peripherals.management
Instances of this class represent events emitted by/for peripheral comm adapter changes.
PeripheralCommAdapterEvent() - Constructor for class org.opentcs.drivers.peripherals.management.PeripheralCommAdapterEvent
Creates an empty event.
PeripheralCommAdapterFactory - Interface in org.opentcs.drivers.peripherals
Provides communication adapter instances for peripheral devices to be controlled.
PeripheralCommAdapterPanel - Class in org.opentcs.drivers.peripherals.management
A base class for panels associated with peripheral comm adapters.
PeripheralCommAdapterPanel() - Constructor for class org.opentcs.drivers.peripherals.management.PeripheralCommAdapterPanel
 
PeripheralCommAdapterPanelFactory - Interface in org.opentcs.drivers.peripherals.management
Provides peripheral comm adapter specific panels used for interaction and displaying information.
PeripheralController - Interface in org.opentcs.drivers.peripherals
Provides high-level methods for the system to control a peripheral device.
PeripheralControllerPool - Interface in org.opentcs.drivers.peripherals
Maintains associations between locations and peripheral controllers.
PeripheralDispatcherService - Interface in org.opentcs.components.kernel.services
Provides methods concerning the PeripheralJobDispatcher.
PeripheralInformation - Class in org.opentcs.data.model
Contains details about a peripheral device a location may represent.
PeripheralInformation() - Constructor for class org.opentcs.data.model.PeripheralInformation
 
PeripheralInformation.ProcState - Enum in org.opentcs.data.model
A peripheral device's processing state as seen by the peripheral job dispatcher.
PeripheralInformation.State - Enum in org.opentcs.data.model
The elements of this enumeration describe the various possible states of a peripheral device.
PeripheralJob - Class in org.opentcs.data.peripherals
Represents a job that is to be processed by a peripheral device.
PeripheralJob(String, String, PeripheralOperation) - Constructor for class org.opentcs.data.peripherals.PeripheralJob
Creates a new instance.
PeripheralJob.State - Enum in org.opentcs.data.peripherals
Defines the various states a peripheral job may be in.
PeripheralJobCallback - Interface in org.opentcs.drivers.peripherals
A callback used to inform about the successful or failed completion of jobs.
PeripheralJobCreationTO - Class in org.opentcs.access.to.peripherals
A transfer object describing a peripheral job.
PeripheralJobCreationTO(String, String, PeripheralOperationCreationTO) - Constructor for class org.opentcs.access.to.peripherals.PeripheralJobCreationTO
Creates a new instance.
PeripheralJobDispatcher - Interface in org.opentcs.components.kernel
This interface declares the methods a peripheral job dispatcher module for the openTCS kernel must implement.
peripheralJobFailed(PeripheralJob) - Method in interface org.opentcs.drivers.peripherals.PeripheralJobCallback
Called on failed completion of a job.
peripheralJobFinished(PeripheralJob) - Method in interface org.opentcs.drivers.peripherals.PeripheralJobCallback
Called on successful completion of a job.
PeripheralJobHistoryCodes - Interface in org.opentcs.data.peripherals
Defines constants for basic history event codes related to peripheral jobs and documents how the respective supplementary information is to be interpreted.
PeripheralJobService - Interface in org.opentcs.components.kernel.services
Provides methods concerning PeripheralJobs.
PeripheralOperation - Class in org.opentcs.data.peripherals
Describes an operation that is to be executed by a peripheral device.
PeripheralOperation(TCSResourceReference<Location>, String, PeripheralOperation.ExecutionTrigger, boolean) - Constructor for class org.opentcs.data.peripherals.PeripheralOperation
Creates a new instance.
PeripheralOperation.ExecutionTrigger - Enum in org.opentcs.data.peripherals
Defines the various moments at which an operation may be executed.
PeripheralOperationCreationTO - Class in org.opentcs.access.to.peripherals
A transfer object describing an operation to be performed by a peripheral device.
PeripheralOperationCreationTO(String, String) - Constructor for class org.opentcs.access.to.peripherals.PeripheralOperationCreationTO
Creates a new instance with executionTrigger set to PeripheralOperation.ExecutionTrigger.BEFORE_MOVEMENT and completionRequired set to false.
PeripheralProcessModel - Class in org.opentcs.drivers.peripherals
A model of a peripheral device's and its communication adapter's attributes.
PeripheralProcessModel(TCSResourceReference<Location>) - Constructor for class org.opentcs.drivers.peripherals.PeripheralProcessModel
Creates a new instance.
PeripheralProcessModel(TCSResourceReference<Location>, boolean, boolean, PeripheralInformation.State) - Constructor for class org.opentcs.drivers.peripherals.PeripheralProcessModel
 
PeripheralProcessModel.Attribute - Enum in org.opentcs.drivers.peripherals
Used to describe what has changed in a process model.
PeripheralProcessModelEvent - Class in org.opentcs.drivers.peripherals.management
Instances of this class represent events emitted by/for changes on PeripheralProcessModels.
PeripheralProcessModelEvent(TCSResourceReference<Location>, String, PeripheralProcessModel) - Constructor for class org.opentcs.drivers.peripherals.management.PeripheralProcessModelEvent
Creates a new instance.
PeripheralService - Interface in org.opentcs.components.kernel.services
Provides methods concerning peripheral devices represented by Locations.
PlantModelCreationTO - Class in org.opentcs.access.to.model
A transfer object describing a plant model.
PlantModelCreationTO(String) - Constructor for class org.opentcs.access.to.model.PlantModelCreationTO
Creates a new instance.
PlantModelExporter - Interface in org.opentcs.components.plantoverview
Implementations provide a way to export plant model data, for instance to write it to a file in a third-party format or to a database.
PlantModelImporter - Interface in org.opentcs.components.plantoverview
Implementations provide a way to import plant model data that is read from some external source or generated.
PlantModelService - Interface in org.opentcs.components.kernel.services
Provides methods concerning the plant model.
PluggablePanel - Class in org.opentcs.components.plantoverview
Declares methods that a pluggable panel should provide for the enclosing application.
PluggablePanel() - Constructor for class org.opentcs.components.plantoverview.PluggablePanel
 
PluggablePanelFactory - Interface in org.opentcs.components.plantoverview
Produces plugin panels to extend an openTCS user interface.
Point - Class in org.opentcs.data.model
Describes a position in the driving course at which a Vehicle may be located.
Point(String) - Constructor for class org.opentcs.data.model.Point
Creates a new point with the given name.
POINT_LABEL_OFFSET_X - Static variable in interface org.opentcs.data.model.visualization.ElementPropKeys
X offset of the label's position to the object's position (in lu).
POINT_LABEL_OFFSET_Y - Static variable in interface org.opentcs.data.model.visualization.ElementPropKeys
Y offset of the label's position to the object's position (in lu).
POINT_LABEL_ORIENTATION_ANGLE - Static variable in interface org.opentcs.data.model.visualization.ElementPropKeys
Orientation angle of the label (in degrees).
POINT_POS_X - Static variable in interface org.opentcs.data.model.visualization.ElementPropKeys
X coordinate at which the point is to be drawn (in mm).
POINT_POS_Y - Static variable in interface org.opentcs.data.model.visualization.ElementPropKeys
Y coordinate at which the point is to be drawn (in mm).
Point.Layout - Class in org.opentcs.data.model
Contains information regarding the grahical representation of a point.
Point.Type - Enum in org.opentcs.data.model
Describes the types of positions in a driving course.
PointCreationTO - Class in org.opentcs.access.to.model
A transfer object describing a point in the plant model.
PointCreationTO(String) - Constructor for class org.opentcs.access.to.model.PointCreationTO
Creates a new instance.
PointCreationTO.Layout - Class in org.opentcs.access.to.model
Contains information regarding the grahical representation of a point.
POLYPATH - org.opentcs.data.model.Path.Layout.ConnectionType
A polygon path with any number of vertecies.
portalShared() - Method in interface org.opentcs.access.SharedKernelServicePortalProvider
Checks whether a kernel reference is currently being shared.
POSITION - org.opentcs.drivers.vehicle.VehicleProcessModel.Attribute
Indicates a change of the vehicle's position.
PRECISE_POSITION - org.opentcs.drivers.vehicle.VehicleProcessModel.Attribute
Indicates a change of the vehicle's precise position.
PREFERRED_ADAPTER - Static variable in class org.opentcs.data.model.Vehicle
The key for a property to store the class name of the preferred communication adapter (factory) for this vehicle.
preparationSuccessful(Scheduler.Module, Scheduler.Client, Set<TCSResource<?>>) - Method in interface org.opentcs.components.kernel.Scheduler
Informs the scheduler that a set of resources was successfully prepared in order of allocating them to a client.
prepareAllocation(Scheduler.Client, Set<TCSResource<?>>) - Method in interface org.opentcs.components.kernel.Scheduler.Module
Lets this module prepare the given resources so they can be allocated to a client.
PRISTINE - org.opentcs.data.order.DriveOrder.State
A drive order's initial state, indicating it being still untouched/not being processed.
process(PeripheralJob, PeripheralJobCallback) - Method in interface org.opentcs.drivers.peripherals.PeripheralCommAdapter
Processes the given job by sending it or a representation that the peripheral device understands to the peripheral device itself.
process(PeripheralJob, PeripheralJobCallback) - Method in interface org.opentcs.drivers.peripherals.PeripheralController
Lets the peripheral device associated with this controller process the given job.
PROCESSING_JOB - org.opentcs.data.model.PeripheralInformation.ProcState
The peripheral device is currently processing a job.
PROCESSING_ORDER - org.opentcs.data.model.Vehicle.ProcState
The vehicle is currently processing a drive order.
processMessage(Object) - Method in interface org.opentcs.drivers.vehicle.VehicleCommAdapter
Processes a generic message to the communication adapter.
processModelChange(String, VehicleProcessModelTO) - Method in class org.opentcs.drivers.vehicle.management.VehicleCommAdapterPanel
Notifies a comm adapter panel that the corresponding process model changed.
processModelChanged(PeripheralProcessModel) - Method in class org.opentcs.drivers.peripherals.management.PeripheralCommAdapterPanel
Notifies a comm adapter panel that the corresponding process model changed.
ProcessModelEvent - Class in org.opentcs.drivers.vehicle.management
Instances of this class represent events emitted by/for changes on VehicleProcessModels.
ProcessModelEvent(String, VehicleProcessModelTO) - Constructor for class org.opentcs.drivers.vehicle.management.ProcessModelEvent
Creates a new instance.
propertiesWith(String, String) - Method in class org.opentcs.access.to.CreationTO
 
propertiesWith(String, String) - Method in class org.opentcs.data.TCSObject
Returns a new map of this object's properties, with the given property integrated.
propertyChange(PropertyChangeEvent) - Method in class org.opentcs.drivers.vehicle.BasicVehicleCommAdapter
Processes updates of the VehicleProcessModel.
PropertySuggestions - Interface in org.opentcs.components.plantoverview
Objects implementing this interface provide a set for suggested property keys and values each.
PropertyUpdate(String, String) - Constructor for class org.opentcs.drivers.vehicle.VehicleProcessModel.PropertyUpdate
Creates a new instance.
PROPKEY_ASSIGNED_PARKING_POSITION - Static variable in interface org.opentcs.components.kernel.Dispatcher
The key of a vehicle property defining the name of the vehicle's assigned parking position.
PROPKEY_ASSIGNED_RECHARGE_LOCATION - Static variable in interface org.opentcs.components.kernel.Dispatcher
The key of a vehicle property defining the name of the vehicle's assigned recharge location.
PROPKEY_BLOCK_ENTRY_DIRECTION - Static variable in interface org.opentcs.components.kernel.Scheduler
The key of a path property defining the direction in which a vehicle is entering a block when it's taking the path.
PROPKEY_PARKING_POSITION_PRIORITY - Static variable in interface org.opentcs.components.kernel.Dispatcher
The key of a parking position property defining its priority.
PROPKEY_PREFERRED_PARKING_POSITION - Static variable in interface org.opentcs.components.kernel.Dispatcher
The key of a vehicle property defining the name of the vehicle's preferred parking position.
PROPKEY_PREFERRED_RECHARGE_LOCATION - Static variable in interface org.opentcs.components.kernel.Dispatcher
The key of a vehicle property defining the name of the vehicle's preferred recharge location.
PROPKEY_ROUTING_COST_FORWARD - Static variable in interface org.opentcs.components.kernel.Router
The key (prefix) of a path property defining the routing cost when its travelled in forward direction.
PROPKEY_ROUTING_COST_REVERSE - Static variable in interface org.opentcs.components.kernel.Router
The key (prefix) of a path property defining the routing cost when its travelled in reverse direction.
PROPKEY_ROUTING_GROUP - Static variable in interface org.opentcs.components.kernel.Router
The key of a vehicle property defining the group of vehicles that may share the same routing.
providesAdapterFor(Location) - Method in interface org.opentcs.drivers.peripherals.PeripheralCommAdapterFactory
Checks whether this factory can provide a communication adapter for the given location/peripheral device.
providesAdapterFor(Vehicle) - Method in interface org.opentcs.drivers.vehicle.VehicleCommAdapterFactory
Checks whether this factory can provide a communication adapter for the given vehicle.
providesPanel(Kernel.State) - Method in interface org.opentcs.components.plantoverview.PluggablePanelFactory
Checks whether this factory produces panels that are available in the passed Kernel.State.
publishEvent(Object) - Method in interface org.opentcs.access.KernelServicePortal
Publishes an event.
publishEvent(Object) - Method in class org.opentcs.access.rmi.services.RemoteKernelServicePortalProxy
 
publishEvent(ClientID, Object) - Method in interface org.opentcs.access.rmi.services.RemoteKernelServicePortal
 
publishEvent(VehicleCommAdapterEvent) - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Publishes an event via the kernel's event mechanism.
publishUserNotification(ClientID, UserNotification) - Method in interface org.opentcs.access.rmi.services.RemoteNotificationService
 
publishUserNotification(UserNotification) - Method in interface org.opentcs.components.kernel.services.NotificationService
Publishes a user notification.
publishUserNotification(UserNotification) - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Publishes an user notification.

Q

query(ClientID, Query<T>) - Method in interface org.opentcs.access.rmi.services.RemoteQueryService
 
query(Query<T>) - Method in class org.opentcs.access.rmi.services.RemoteQueryServiceProxy
 
query(Query<T>) - Method in interface org.opentcs.components.kernel.QueryResponder
Executes the specified query.
query(Query<T>) - Method in interface org.opentcs.components.kernel.services.QueryService
Executes a query with the kernel and delivers the result.
Query<T> - Interface in org.opentcs.components.kernel
Marks a query (parameter) object.
Query.Void - Class in org.opentcs.components.kernel
A convenience class to be used as the result type for queries that do not return any result.
QueryResponder - Interface in org.opentcs.components.kernel
A responder for generic queries.
QueryService - Interface in org.opentcs.components.kernel.services
Provides generic/pluggable query functionality.

R

RAW - org.opentcs.data.order.TransportOrder.State
A transport order's initial state.
RECHARGE_ALT_1 - org.opentcs.data.model.visualization.LocationRepresentation
A location for recharging a vehicle, alternative variant 1.
RECHARGE_ALT_2 - org.opentcs.data.model.visualization.LocationRepresentation
A location for recharging a vehicle, alternative variant 2.
RECHARGE_GENERIC - org.opentcs.data.model.visualization.LocationRepresentation
A location for recharging a vehicle, generic variant.
reference - Variable in class org.opentcs.data.TCSObject
A transient reference to this business object.
register() - Method in interface org.opentcs.access.SharedKernelServicePortalProvider
Creates and registers a new client with this access pool.
registerResponder(Class<? extends Query<?>>, QueryResponder) - Method in interface org.opentcs.components.kernel.services.InternalQueryService
Registers the given responder for handling queries of the given type.
RegistrationName - Interface in org.opentcs.access.rmi.services
Defines the names used for binding the remote services in the RMI registry.
REMOTE_DISPATCHER_SERVICE - Static variable in interface org.opentcs.access.rmi.services.RegistrationName
The name the RemoteDispatcherService registers itself with a RMI registry.
REMOTE_KERNEL_CLIENT_PORTAL - Static variable in interface org.opentcs.access.rmi.services.RegistrationName
The name the RemoteKernelServicePortal registers itself with a RMI registry.
REMOTE_NOTIFICATION_SERVICE - Static variable in interface org.opentcs.access.rmi.services.RegistrationName
The name the RemoteNotificationService registers itself with a RMI registry.
REMOTE_PERIPHERAL_DISPATCHER_SERVICE - Static variable in interface org.opentcs.access.rmi.services.RegistrationName
The name the RemotePeripheralDispatcherService registers itself with a RMI registry.
REMOTE_PERIPHERAL_JOB_SERVICE - Static variable in interface org.opentcs.access.rmi.services.RegistrationName
The name the RemotePeripheralJobService registers itself with a RMI registry.
REMOTE_PERIPHERAL_SERVICE - Static variable in interface org.opentcs.access.rmi.services.RegistrationName
The name the RemotePeripheralService registers itself with a RMI registry.
REMOTE_PLANT_MODEL_SERVICE - Static variable in interface org.opentcs.access.rmi.services.RegistrationName
The name the RemotePlantModelService registers itself with a RMI registry.
REMOTE_QUERY_SERVICE - Static variable in interface org.opentcs.access.rmi.services.RegistrationName
The name the RemoteQueryService registers itself with a RMI registry.
REMOTE_ROUTER_SERVICE - Static variable in interface org.opentcs.access.rmi.services.RegistrationName
The name the RemoteRouterService registers itself with a RMI registry.
REMOTE_SCHEDULER_SERVICE - Static variable in interface org.opentcs.access.rmi.services.RegistrationName
The name the RemoteSchedulerService registers itself with a RMI registry.
REMOTE_TRANSPORT_ORDER_SERVICE - Static variable in interface org.opentcs.access.rmi.services.RegistrationName
The name the RemoteTransportOrderService registers itself with a RMI registry.
REMOTE_VEHICLE_SERVICE - Static variable in interface org.opentcs.access.rmi.services.RegistrationName
The name the RemoteVehicleService registers itself with a RMI registry.
RemoteDispatcherService - Interface in org.opentcs.access.rmi.services
Declares the methods provided by the DispatcherService via RMI.
RemoteKernelServicePortal - Interface in org.opentcs.access.rmi.services
Declares the methods provided by the KernelServicePortal via RMI.
RemoteKernelServicePortalProxy - Class in org.opentcs.access.rmi.services
The default implementation for the KernelServicePortal.
RemoteKernelServicePortalProxy(String, String, SocketFactoryProvider, Predicate<Object>) - Constructor for class org.opentcs.access.rmi.services.RemoteKernelServicePortalProxy
Creates a new instance.
RemoteNotificationService - Interface in org.opentcs.access.rmi.services
Declares the methods provided by the NotificationService via RMI.
RemotePeripheralDispatcherService - Interface in org.opentcs.access.rmi.services
Declares the methods provided by the PeripheralDispatcherService via RMI.
RemotePeripheralJobService - Interface in org.opentcs.access.rmi.services
Declares the methods provided by the PeripheralJobService via RMI.
RemotePeripheralService - Interface in org.opentcs.access.rmi.services
Declares the methods provided by the PeripheralService via RMI.
RemotePlantModelService - Interface in org.opentcs.access.rmi.services
Declares the methods provided by the PlantModelService via RMI.
RemoteQueryService - Interface in org.opentcs.access.rmi.services
Declares the methods provided by the QueryService via RMI.
RemoteQueryServiceProxy - Class in org.opentcs.access.rmi.services
The default implementation of the query service.
RemoteQueryServiceProxy() - Constructor for class org.opentcs.access.rmi.services.RemoteQueryServiceProxy
 
RemoteRouterService - Interface in org.opentcs.access.rmi.services
Declares the methods provided by the RouterService via RMI.
RemoteSchedulerService - Interface in org.opentcs.access.rmi.services
Declares the methods provided by the SchedulerService via RMI.
RemoteTCSObjectService - Interface in org.opentcs.access.rmi.services
Declares the methods provided by the TCSObjectService via RMI.
RemoteTransportOrderService - Interface in org.opentcs.access.rmi.services
Declares the methods provided by the TransportOrderService via RMI.
RemoteVehicleService - Interface in org.opentcs.access.rmi.services
Declares the methods provided by the VehicleService via RMI.
removeKernelExtension(KernelExtension) - Method in interface org.opentcs.access.LocalKernel
Removes a KernelExtension from this kernel.
removePropertyChangeListener(PropertyChangeListener) - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Unregisters a property change listener from this model.
REPORT_POSITION - org.opentcs.data.model.Point.Type
Indicates a position at which a vehicle is expected to report in.
reschedule() - Method in interface org.opentcs.components.kernel.Scheduler
Explicitly triggers a rescheduling run during which the scheduler tries to allocate resources for all waiting clients.
ResourceAllocationException - Exception in org.opentcs.components.kernel
Thrown when allocating resources for a Scheduler.Client is impossible.
ResourceAllocationException(String) - Constructor for exception org.opentcs.components.kernel.ResourceAllocationException
Creates a new ResourceAllocationException with the given detail message.
ResourceAllocationException(String, Throwable) - Constructor for exception org.opentcs.components.kernel.ResourceAllocationException
Creates a new ResourceAllocationException with the given detail message and cause.
Route - Class in org.opentcs.data.order
A route for a Vehicle, consisting of a sequence of steps (pairs of Paths and Points) that need to be processed in their given order.
Route(List<Route.Step>, long) - Constructor for class org.opentcs.data.order.Route
Creates a new Route.
ROUTE_INDEX_DEFAULT - Static variable in class org.opentcs.data.model.Vehicle
A value indicating that no route steps have been travelled for the current drive order, yet.
Route.Step - Class in org.opentcs.data.order
A single step in a route.
Router - Interface in org.opentcs.components.kernel
This interface declares the methods a router module for the openTCS kernel must implement.
RouterService - Interface in org.opentcs.components.kernel.services
Provides methods concerning the Router.
run() - Method in class org.opentcs.util.CyclicTask
 
runActualTask() - Method in class org.opentcs.util.CyclicTask
Defines the actual work this task should do in every cycle.

S

SAME_DIRECTION_ONLY - org.opentcs.data.model.Block.Type
The resources aggregated in this block can be used by multiple vehicles, but only if they enter the block in the same direction.
savePlantModel() - Method in interface org.opentcs.components.kernel.services.InternalPlantModelService
Saves the current model under the given name.
ScheduledApiChange - Annotation Type in org.opentcs.util.annotations
Marks an API detail (class, method, field) that is scheduled for an incompatible change.
ScheduledApiChanges - Annotation Type in org.opentcs.util.annotations
A container annotation for ScheduledApiChange.
Scheduler - Interface in org.opentcs.components.kernel
A Scheduler manages resources used by vehicles, preventing both collisions and deadlocks.
Scheduler.Client - Interface in org.opentcs.components.kernel
Defines callback methods for clients of the resource scheduler.
Scheduler.Module - Interface in org.opentcs.components.kernel
A scheduler module.
SchedulerAllocationState - Class in org.opentcs.access
Represents the current state of resource allocations.
SchedulerAllocationState(Map<String, Set<TCSResource<?>>>) - Constructor for class org.opentcs.access.SchedulerAllocationState
Creates a new instance.
SchedulerService - Interface in org.opentcs.components.kernel.services
Provides methods concerning the Scheduler.
SecureSocketFactoryProvider - Class in org.opentcs.access.rmi.factories
Provides instances of RMIClientSocketFactory and RMIServerSocketFactory that are implemented over the SSL or TLS protocols.
SecureSocketFactoryProvider(SslParameterSet) - Constructor for class org.opentcs.access.rmi.factories.SecureSocketFactoryProvider
Creates a new instance.
selectRoute(Vehicle, List<DriveOrder>) - Method in interface org.opentcs.components.kernel.Router
Notifies the router of a route being selected for a vehicle.
sendCommAdapterCommand(ClientID, TCSResourceReference<Location>, PeripheralAdapterCommand) - Method in interface org.opentcs.access.rmi.services.RemotePeripheralService
 
sendCommAdapterCommand(ClientID, TCSObjectReference<Vehicle>, AdapterCommand) - Method in interface org.opentcs.access.rmi.services.RemoteVehicleService
 
sendCommAdapterCommand(TCSResourceReference<Location>, PeripheralAdapterCommand) - Method in interface org.opentcs.components.kernel.services.PeripheralService
Sends a PeripheralAdapterCommand to the comm adapter attached to the referenced location.
sendCommAdapterCommand(TCSObjectReference<Vehicle>, AdapterCommand) - Method in interface org.opentcs.components.kernel.services.VehicleService
Sends an AdapterCommand to the comm adapter attached to the referenced vehicle.
sendCommAdapterCommand(PeripheralAdapterCommand) - Method in interface org.opentcs.drivers.peripherals.PeripheralController
Sends a PeripheralAdapterCommand to the communication adapter.
sendCommAdapterCommand(AdapterCommand) - Method in interface org.opentcs.drivers.vehicle.VehicleController
Sends a AdapterCommand to the communication adapter.
sendCommAdapterMessage(Object) - Method in interface org.opentcs.drivers.vehicle.VehicleController
Delivers a generic message to the communication adapter.
sendCommAdapterMessage(ClientID, TCSObjectReference<Vehicle>, Object) - Method in interface org.opentcs.access.rmi.services.RemoteVehicleService
 
sendCommAdapterMessage(TCSObjectReference<Vehicle>, Object) - Method in interface org.opentcs.components.kernel.services.VehicleService
Sends a message to the communication adapter associated with the referenced vehicle.
sendCommand(MovementCommand) - Method in class org.opentcs.drivers.vehicle.BasicVehicleCommAdapter
Converts the given command to something the vehicle can understand and sends the resulting data to the vehicle.
sendProcessModelChangedEvent(PeripheralProcessModel.Attribute) - Method in class org.opentcs.drivers.peripherals.BasicPeripheralCommAdapter
 
ServiceCallWrapper - Annotation Type in org.opentcs.customizations
Annotation type to mark an injectable CallWrapper that wraps method calls on kernel services.
ServiceListener - Interface in org.opentcs.access.rmi.services
Provides callback methods for instances interested in service updates.
ServiceUnavailableException - Exception in org.opentcs.components.kernel.services
Thrown when a (remote) service is not available for processing a request.
ServiceUnavailableException(String) - Constructor for exception org.opentcs.components.kernel.services.ServiceUnavailableException
Creates a new ServiceUnavailableException with the given detail message.
ServiceUnavailableException(String, Throwable) - Constructor for exception org.opentcs.components.kernel.services.ServiceUnavailableException
Creates a new ServiceUnavailableException with the given detail message and cause.
setAllocationState(Scheduler.Client, Set<TCSResource<?>>, List<Set<TCSResource<?>>>) - Method in interface org.opentcs.components.kernel.Scheduler.Module
Informs this module about a client's current allocation state.
setCommAdapterConnected(boolean) - Method in class org.opentcs.drivers.vehicle.management.VehicleProcessModelTO
 
setCommAdapterConnected(boolean) - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Sets the comm adapter's connected flag.
setCommAdapterEnabled(boolean) - Method in class org.opentcs.drivers.vehicle.management.VehicleProcessModelTO
 
setCommAdapterEnabled(boolean) - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Sets the comm adapter's enabled flag.
setContent(byte[]) - Method in class org.opentcs.data.model.visualization.ImageData
Deprecated.
Sets the binary data describing the actual image.
setContentFormat(String) - Method in class org.opentcs.data.model.visualization.ImageData
Deprecated.
Sets this image's content type/format.
setDriveOrder(DriveOrder, Map<String, String>) - Method in interface org.opentcs.drivers.vehicle.VehicleController
Sets the current drive order for the vehicle associated with this controller.
setEnergyLevel(int) - Method in class org.opentcs.drivers.vehicle.management.VehicleProcessModelTO
 
setEventFilter(Predicate<Object>) - Method in class org.opentcs.access.rmi.KernelServicePortalBuilder
Sets the event filter to be applied for the built portal.
setIgnoringInterrupts(boolean) - Method in class org.opentcs.util.CyclicTask
Sets/unsets this task's flag for ignoring interrupts during sleep phases.
setImageData(ImageData) - Method in class org.opentcs.data.model.visualization.ImageLayoutElement
Deprecated.
Sets this layout element's image data.
setLabel(String) - Method in class org.opentcs.data.model.visualization.ImageData
Deprecated.
Sets a label/name for this image.
setLayer(int) - Method in class org.opentcs.data.model.visualization.LayoutElement
Deprecated.
Sets the layer on which this layout element is to be displayed.
setLoadHandlingDevices(List<LoadHandlingDevice>) - Method in class org.opentcs.drivers.vehicle.management.VehicleProcessModelTO
 
setNotifications(Queue<UserNotification>) - Method in class org.opentcs.drivers.vehicle.management.VehicleProcessModelTO
 
setOrientationAngle(double) - Method in class org.opentcs.drivers.vehicle.management.VehicleProcessModelTO
 
setPrecisePosition(Triple) - Method in class org.opentcs.drivers.vehicle.management.VehicleProcessModelTO
 
setProcessModel(PeripheralProcessModel) - Method in class org.opentcs.drivers.peripherals.BasicPeripheralCommAdapter
 
setProperties(Map<String, String>) - Method in class org.opentcs.data.model.visualization.LayoutElement
Deprecated.
Sets this layout element's properties.
setSocketFactoryProvider(SocketFactoryProvider) - Method in class org.opentcs.access.rmi.KernelServicePortalBuilder
Sets the socket factory provider used for RMI.
SetSpeedMultiplier - Class in org.opentcs.drivers.vehicle.messages
A message that informs a communication adapter about a speed multiplier it/the vehicle should apply.
SetSpeedMultiplier(int) - Constructor for class org.opentcs.drivers.vehicle.messages.SetSpeedMultiplier
Creates a new instance.
setState(Kernel.State) - Method in interface org.opentcs.access.Kernel
Sets the current state of the kernel.
setTransportOrderProperty(String, String) - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Sets a property of the transport order the vehicle is currently processing.
setVehicleEnergyLevel(int) - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Sets the vehicle's current energy level.
setVehicleLoadHandlingDevices(List<LoadHandlingDevice>) - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Sets the vehicle's load handling devices.
setVehicleName(String) - Method in class org.opentcs.drivers.vehicle.management.VehicleProcessModelTO
 
setVehicleOrientationAngle(double) - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Sets the vehicle's current orientation angle.
setVehiclePosition(String) - Method in class org.opentcs.drivers.vehicle.management.VehicleProcessModelTO
 
setVehiclePosition(String) - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Updates the vehicle's current position.
setVehiclePrecisePosition(Triple) - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Sets the vehicle's precise position.
setVehicleProperty(String, String) - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Sets a property of the vehicle.
setVehicleState(Vehicle.State) - Method in class org.opentcs.drivers.vehicle.management.VehicleProcessModelTO
 
setVehicleState(Vehicle.State) - Method in class org.opentcs.drivers.vehicle.VehicleProcessModel
Sets the vehicle's current state.
setWithoutNullValues(Set<V>) - Static method in class org.opentcs.data.TCSObject
Returns a new set with the values from the given set but all null values removed.
ShapeLayoutElement - Class in org.opentcs.data.model.visualization
Deprecated.
Will be removed.
ShapeLayoutElement() - Constructor for class org.opentcs.data.model.visualization.ShapeLayoutElement
Deprecated.
Creates a new ShapeLayoutElement.
ShapeLayoutElementCreationTO - Class in org.opentcs.access.to.model
Deprecated.
ShapeLayoutElementCreationTO(String) - Constructor for class org.opentcs.access.to.model.ShapeLayoutElementCreationTO
Deprecated.
Creates a new instance.
SharedKernelServicePortal - Interface in org.opentcs.access
Provides access to a shared KernelServicePortal instance.
SharedKernelServicePortalProvider - Interface in org.opentcs.access
Pools access to a KernelServicePortal instance for multiple clients.
SHUTDOWN - org.opentcs.access.Kernel.State
A transitional state the kernel is in while shutting down.
SimpleEventBus - Class in org.opentcs.util.event
A plain implementation of EventBus.
SimpleEventBus() - Constructor for class org.opentcs.util.event.SimpleEventBus
 
SimVehicleCommAdapter - Interface in org.opentcs.drivers.vehicle
This interface declares methods that a vehicle driver intended for simulation must implement.
SINGLE_VEHICLE_ONLY - org.opentcs.data.model.Block.Type
The resources aggregated in this block can only be used by one vehicle at the same time.
SLANTED - org.opentcs.data.model.Path.Layout.ConnectionType
A slanted connection.
SocketFactoryProvider - Interface in org.opentcs.access.rmi.factories
A provider for instances of RMIClientSocketFactory and RMIServerSocketFactory.
SslParameterSet - Class in org.opentcs.access
A set of parameters to be used for SSL-encrypted socket connections.
SslParameterSet(String, File, String, File, String) - Constructor for class org.opentcs.access.SslParameterSet
Creates a new instance.
STATE - org.opentcs.drivers.peripherals.PeripheralProcessModel.Attribute
Indicates a change of the state property.
STATE - org.opentcs.drivers.vehicle.VehicleProcessModel.Attribute
Indicates a change of the vehicle's state.
statefulImage(Vehicle) - Method in interface org.opentcs.components.plantoverview.VehicleTheme
Returns an image for the given vehicle, representing its current state.
statelessImage(Vehicle) - Method in interface org.opentcs.components.plantoverview.VehicleTheme
Returns an image for the given vehicle, disregarding its current state.
Step(Path, Point, Point, Vehicle.Orientation, int) - Constructor for class org.opentcs.data.order.Route.Step
Creates a new instance.
Step(Path, Point, Point, Vehicle.Orientation, int, boolean) - Constructor for class org.opentcs.data.order.Route.Step
Creates a new instance.
subscribe(EventHandler) - Method in interface org.opentcs.util.event.EventSource
Subscribes the given listener to events emitted by this source.
subscribe(EventHandler) - Method in class org.opentcs.util.event.SimpleEventBus
 

T

TCSObject<E extends TCSObject<E>> - Class in org.opentcs.data
Describes the base behaviour of TCS data objects.
TCSObject(String) - Constructor for class org.opentcs.data.TCSObject
Creates a new TCSObject.
TCSObject(String, Map<String, String>, ObjectHistory) - Constructor for class org.opentcs.data.TCSObject
Creates a new TCSObject.
TCSObjectEvent - Class in org.opentcs.data
Instances of this class represent events emitted by/for business objects.
TCSObjectEvent(TCSObject<?>, TCSObject<?>, TCSObjectEvent.Type) - Constructor for class org.opentcs.data.TCSObjectEvent
Creates a new TCSObjectEvent.
TCSObjectEvent.Type - Enum in org.opentcs.data
Indicates the type of an event, which can be helpful with filtering events.
TCSObjectReference<E extends TCSObject<E>> - Class in org.opentcs.data
A transient reference to a TCSObject.
TCSObjectReference(TCSObject<E>) - Constructor for class org.opentcs.data.TCSObjectReference
Creates a new TCSObjectReference.
TCSObjectService - Interface in org.opentcs.components.kernel.services
Provides methods concerning TCSObjects.
TCSResource<E extends TCSResource<E>> - Class in org.opentcs.data.model
Describes a resource that Vehicles may claim for exclusive usage.
TCSResource(String) - Constructor for class org.opentcs.data.model.TCSResource
Creates a new TCSResource.
TCSResource(String, Map<String, String>, ObjectHistory) - Constructor for class org.opentcs.data.model.TCSResource
Creates a new TCSResource.
TCSResourceReference<E extends TCSResource<E>> - Class in org.opentcs.data.model
A transient reference to a TCSResource.
TCSResourceReference(TCSResource<E>) - Constructor for class org.opentcs.data.model.TCSResourceReference
Creates a new TCSResourceReference.
terminate() - Method in interface org.opentcs.components.Lifecycle
Terminates the instance and frees resources.
terminate() - Method in class org.opentcs.drivers.peripherals.BasicPeripheralCommAdapter
Terminates the instance and frees resources.
terminate() - Method in class org.opentcs.drivers.vehicle.BasicVehicleCommAdapter
Terminates the instance and frees resources.
terminate() - Method in class org.opentcs.util.CyclicTask
Terminates this task before its next execution cycle.
terminateAndWait() - Method in class org.opentcs.util.CyclicTask
Terminates this task before its next execution cycle and waits for it to finish before returning.
test(Object) - Method in class org.opentcs.util.ClassMatcher
 
TO_BE_IGNORED - org.opentcs.data.model.Vehicle.IntegrationLevel
The vehicle's reported position is ignored.
TO_BE_NOTICED - org.opentcs.data.model.Vehicle.IntegrationLevel
The vehicle's reported position is noticed, meaning that resources will not be reserved for it.
TO_BE_PROCESSED - org.opentcs.data.peripherals.PeripheralJob.State
 
TO_BE_RESPECTED - org.opentcs.data.model.Vehicle.IntegrationLevel
The vehicle's reported position is respected, meaning that resources will be reserved for it.
TO_BE_UTILIZED - org.opentcs.data.model.Vehicle.IntegrationLevel
The vehicle is fully integrated and may be assigned to transport orders.
topologyChanged() - Method in interface org.opentcs.components.kernel.Dispatcher
Notifies the dispatcher of changes in the topology.
topologyChanged() - Method in interface org.opentcs.components.kernel.Router
Notifies the router of changes in the topology.
toString() - Method in class org.opentcs.access.KernelStateTransitionEvent
 
toString() - Method in class org.opentcs.access.ModelTransitionEvent
 
toString() - Method in class org.opentcs.access.NotificationPublicationEvent
 
toString() - Method in class org.opentcs.access.rmi.ClientID
 
toString() - Method in class org.opentcs.access.to.model.BlockCreationTO.Layout
 
toString() - Method in class org.opentcs.access.to.model.BlockCreationTO
 
toString() - Method in class org.opentcs.access.to.model.LocationCreationTO.Layout
 
toString() - Method in class org.opentcs.access.to.model.LocationCreationTO
 
toString() - Method in class org.opentcs.access.to.model.LocationTypeCreationTO.Layout
 
toString() - Method in class org.opentcs.access.to.model.LocationTypeCreationTO
 
toString() - Method in class org.opentcs.access.to.model.PathCreationTO.Layout
 
toString() - Method in class org.opentcs.access.to.model.PathCreationTO
 
toString() - Method in class org.opentcs.access.to.model.PlantModelCreationTO
 
toString() - Method in class org.opentcs.access.to.model.PointCreationTO.Layout
 
toString() - Method in class org.opentcs.access.to.model.PointCreationTO
 
toString() - Method in class org.opentcs.access.to.model.VehicleCreationTO.Layout
 
toString() - Method in class org.opentcs.access.to.model.VehicleCreationTO
 
toString() - Method in class org.opentcs.access.to.model.VisualLayoutCreationTO
 
toString() - Method in class org.opentcs.components.kernel.routing.Edge
 
toString() - Method in class org.opentcs.data.model.Couple
 
toString() - Method in class org.opentcs.data.model.Triple
 
toString() - Method in class org.opentcs.data.model.Vehicle
 
toString() - Method in class org.opentcs.data.model.visualization.Layer
 
toString() - Method in class org.opentcs.data.model.visualization.LayerGroup
 
toString() - Method in class org.opentcs.data.notification.UserNotification
 
toString() - Method in class org.opentcs.data.ObjectHistory.Entry
 
toString() - Method in class org.opentcs.data.ObjectHistory
 
toString() - Method in class org.opentcs.data.order.DriveOrder.Destination
 
toString() - Method in class org.opentcs.data.order.DriveOrder
 
toString() - Method in class org.opentcs.data.order.Route.Step
 
toString() - Method in class org.opentcs.data.order.Route
 
toString() - Method in class org.opentcs.data.order.TransportOrder
 
toString() - Method in class org.opentcs.data.peripherals.PeripheralOperation
 
toString() - Method in class org.opentcs.data.TCSObject
 
toString() - Method in class org.opentcs.data.TCSObjectEvent
 
toString() - Method in class org.opentcs.data.TCSObjectReference
 
toString() - Method in class org.opentcs.drivers.vehicle.LoadHandlingDevice
 
toString() - Method in class org.opentcs.drivers.vehicle.VehicleCommAdapterEvent
 
TRANSPORT_ORDER_PROPERTY - org.opentcs.drivers.vehicle.VehicleProcessModel.Attribute
Indicates a change of a transport order property.
TransportOrder - Class in org.opentcs.data.order
Represents a sequence of movements and operations that are to be executed by a Vehicle.
TransportOrder(String, List<DriveOrder>) - Constructor for class org.opentcs.data.order.TransportOrder
Creates a new TransportOrder.
TransportOrder.State - Enum in org.opentcs.data.order
This enumeration defines the various states a transport order may be in.
TransportOrderCleanupApproval - Interface in org.opentcs.components.kernel
Implementations of this interface check whether a transport order may be removed.
TransportOrderCreationTO - Class in org.opentcs.access.to.order
A transfer object describing a transport order.
TransportOrderCreationTO(String, List<DestinationCreationTO>) - Constructor for class org.opentcs.access.to.order.TransportOrderCreationTO
Creates a new instance.
TransportOrderHistoryCodes - Interface in org.opentcs.data.order
Defines constants for basic history event codes related to transport orders and documents how the respective supplementary information is to be interpreted.
TransportOrderPropertyUpdate(String, String) - Constructor for class org.opentcs.drivers.vehicle.VehicleProcessModel.TransportOrderPropertyUpdate
Creates a new instance.
TransportOrderService - Interface in org.opentcs.components.kernel.services
Provides methods concerning TransportOrders and OrderSequences.
TRAVELLING - org.opentcs.data.order.DriveOrder.State
Indicates the vehicle processing the order is currently moving to its destination.
Triple - Class in org.opentcs.data.model
A generic 3-tuple of long integer values, usable for 3D coordinates and vectors, for instance.
Triple(long, long, long) - Constructor for class org.opentcs.data.model.Triple
Creates a new Triple with the given values.
type() - Method in annotation type org.opentcs.configuration.ConfigurationEntry
Returns a description for the data type of this configuration key's values.
TYPE_ANY - Static variable in interface org.opentcs.data.order.OrderConstants
The string representing the any type.
TYPE_CHARGE - Static variable in interface org.opentcs.data.order.OrderConstants
A type for charge orders.
TYPE_NONE - Static variable in interface org.opentcs.data.order.OrderConstants
The default type of orders.
TYPE_PARK - Static variable in interface org.opentcs.data.order.OrderConstants
A type for park orders.
TYPE_TRANSPORT - Static variable in interface org.opentcs.data.order.OrderConstants
A type for transport orders.

U

UNAVAILABLE - org.opentcs.data.model.PeripheralInformation.State
The peripheral device's state is known and it's not in an error state, but it is not available for receiving jobs.
UNAVAILABLE - org.opentcs.data.model.Vehicle.State
The vehicle's state is known and it's not in an error state, but it is not available for receiving orders.
unclaim(Scheduler.Client) - Method in interface org.opentcs.components.kernel.Scheduler.Module
Resets a client's total claim.
unclaim(Scheduler.Client) - Method in interface org.opentcs.components.kernel.Scheduler
Unclaims a set of resources claimed by a vehicle.
UNDEFINED - org.opentcs.data.model.Vehicle.Orientation
Indicates that the vehicle's orientation is undefined/unknown.
UNKNOWN - org.opentcs.data.model.PeripheralInformation.State
The peripheral device's current state is unknown, e.g.
UNKNOWN - org.opentcs.data.model.Vehicle.State
The vehicle's current state is unknown, e.g.
unregisterResponder(Class<? extends Query<?>>) - Method in interface org.opentcs.components.kernel.services.InternalQueryService
Unregisters the responder for the given type.
UNROUTABLE - org.opentcs.data.order.TransportOrder.State
Failure state that marks a transport order as unroutable, i.e.
unsubscribe(EventHandler) - Method in interface org.opentcs.util.event.EventSource
Unsubscribes the given listener.
unsubscribe(EventHandler) - Method in class org.opentcs.util.event.SimpleEventBus
 
updateDriveOrder(DriveOrder, Map<String, String>) - Method in interface org.opentcs.drivers.vehicle.VehicleController
Updates the current drive order for the vehicle associated with this controller.
updateLocationLock(ClientID, TCSObjectReference<Location>, boolean) - Method in interface org.opentcs.access.rmi.services.RemotePlantModelService
 
updateLocationLock(TCSObjectReference<Location>, boolean) - Method in interface org.opentcs.components.kernel.services.PlantModelService
Updates a location's lock state.
updateLocationReservationToken(TCSObjectReference<Location>, String) - Method in interface org.opentcs.components.kernel.services.InternalPlantModelService
Updates a location's reservation token.
updateObjectProperty(ClientID, TCSObjectReference<?>, String, String) - Method in interface org.opentcs.access.rmi.services.RemoteTCSObjectService
 
updateObjectProperty(TCSObjectReference<?>, String, String) - Method in interface org.opentcs.components.kernel.services.TCSObjectService
Updates a TCSObject's property.
updateOrderSequenceFinishedIndex(TCSObjectReference<OrderSequence>, int) - Method in interface org.opentcs.components.kernel.services.InternalTransportOrderService
Updates an order sequence's finished index.
updateOrderSequenceProcessingVehicle(TCSObjectReference<OrderSequence>, TCSObjectReference<Vehicle>) - Method in interface org.opentcs.components.kernel.services.InternalTransportOrderService
Updates an order sequence's processing vehicle.
updatePathLock(ClientID, TCSObjectReference<Path>, boolean) - Method in interface org.opentcs.access.rmi.services.RemoteRouterService
 
updatePathLock(TCSObjectReference<Path>, boolean) - Method in interface org.opentcs.components.kernel.services.RouterService
Updates a path's lock state.
updatePeripheralJob(TCSResourceReference<Location>, TCSObjectReference<PeripheralJob>) - Method in interface org.opentcs.components.kernel.services.InternalPeripheralService
Updates a peripheral's current peripheral job.
updatePeripheralJobState(TCSObjectReference<PeripheralJob>, PeripheralJob.State) - Method in interface org.opentcs.components.kernel.services.InternalPeripheralJobService
Updates a peripheral job's state.
updatePeripheralProcState(TCSResourceReference<Location>, PeripheralInformation.ProcState) - Method in interface org.opentcs.components.kernel.services.InternalPeripheralService
Updates a peripheral's processing state.
updatePeripheralReservationToken(TCSResourceReference<Location>, String) - Method in interface org.opentcs.components.kernel.services.InternalPeripheralService
Updates a peripheral's reservation token.
updatePeripheralState(TCSResourceReference<Location>, PeripheralInformation.State) - Method in interface org.opentcs.components.kernel.services.InternalPeripheralService
Updates a peripheral's state.
updateProgressIndex(Scheduler.Client, int) - Method in interface org.opentcs.components.kernel.Scheduler
Notifies the scheduler that the given client has now reached the given index in its claimed resource sequence, and that the client does not need the resources preceding the index in the sequence, any more.
updateRoutingTopology() - Method in interface org.opentcs.components.kernel.services.RouterService
Notifies the router that the topology has changed in a significant way and needs to be re-evaluated.
updateRoutingTopology(ClientID) - Method in interface org.opentcs.access.rmi.services.RemoteRouterService
 
updateTransportOrderDriveOrders(TCSObjectReference<TransportOrder>, List<DriveOrder>) - Method in interface org.opentcs.components.kernel.services.InternalTransportOrderService
Updates a transport order's list of drive orders.
updateTransportOrderNextDriveOrder(TCSObjectReference<TransportOrder>) - Method in interface org.opentcs.components.kernel.services.InternalTransportOrderService
Updates a transport order's current drive order.
updateTransportOrderProcessingVehicle(TCSObjectReference<TransportOrder>, TCSObjectReference<Vehicle>, List<DriveOrder>) - Method in interface org.opentcs.components.kernel.services.InternalTransportOrderService
Updates a transport order's processing vehicle.
updateTransportOrderState(TCSObjectReference<TransportOrder>, TransportOrder.State) - Method in interface org.opentcs.components.kernel.services.InternalTransportOrderService
Updates a transport order's state.
updateVehicleAllowedOrderTypes(ClientID, TCSObjectReference<Vehicle>, Set<String>) - Method in interface org.opentcs.access.rmi.services.RemoteVehicleService
 
updateVehicleAllowedOrderTypes(TCSObjectReference<Vehicle>, Set<String>) - Method in interface org.opentcs.components.kernel.services.VehicleService
Updates the types of transport orders a vehicle is allowed to process.
updateVehicleEnergyLevel(TCSObjectReference<Vehicle>, int) - Method in interface org.opentcs.components.kernel.services.InternalVehicleService
Updates a vehicle's energy level.
updateVehicleIntegrationLevel(ClientID, TCSObjectReference<Vehicle>, Vehicle.IntegrationLevel) - Method in interface org.opentcs.access.rmi.services.RemoteVehicleService
 
updateVehicleIntegrationLevel(TCSObjectReference<Vehicle>, Vehicle.IntegrationLevel) - Method in interface org.opentcs.components.kernel.services.VehicleService
Updates the vehicle's integration level.
updateVehicleLoadHandlingDevices(TCSObjectReference<Vehicle>, List<LoadHandlingDevice>) - Method in interface org.opentcs.components.kernel.services.InternalVehicleService
Updates a vehicle's load handling devices.
updateVehicleNextPosition(TCSObjectReference<Vehicle>, TCSObjectReference<Point>) - Method in interface org.opentcs.components.kernel.services.InternalVehicleService
Updates the point which a vehicle is expected to occupy next.
updateVehicleOrderSequence(TCSObjectReference<Vehicle>, TCSObjectReference<OrderSequence>) - Method in interface org.opentcs.components.kernel.services.InternalVehicleService
Updates a vehicle's order sequence.
updateVehicleOrientationAngle(TCSObjectReference<Vehicle>, double) - Method in interface org.opentcs.components.kernel.services.InternalVehicleService
Updates the vehicle's current orientation angle (-360..360 degrees, or Double.NaN, if the vehicle doesn't provide an angle).
updateVehiclePosition(TCSObjectReference<Vehicle>, TCSObjectReference<Point>) - Method in interface org.opentcs.components.kernel.services.InternalVehicleService
Places a vehicle on a point.
updateVehiclePrecisePosition(TCSObjectReference<Vehicle>, Triple) - Method in interface org.opentcs.components.kernel.services.InternalVehicleService
Updates the vehicle's current precise position in mm.
updateVehicleProcState(TCSObjectReference<Vehicle>, Vehicle.ProcState) - Method in interface org.opentcs.components.kernel.services.InternalVehicleService
Updates a vehicle's processing state.
updateVehicleRechargeOperation(TCSObjectReference<Vehicle>, String) - Method in interface org.opentcs.components.kernel.services.InternalVehicleService
Updates a vehicle's recharge operation.
updateVehicleRouteProgressIndex(TCSObjectReference<Vehicle>, int) - Method in interface org.opentcs.components.kernel.services.InternalVehicleService
Updates a vehicle's index of the last route step travelled for the current drive order of its current transport order.
updateVehicleState(TCSObjectReference<Vehicle>, Vehicle.State) - Method in interface org.opentcs.components.kernel.services.InternalVehicleService
Updates a vehicle's state.
updateVehicleTransportOrder(TCSObjectReference<Vehicle>, TCSObjectReference<TransportOrder>) - Method in interface org.opentcs.components.kernel.services.InternalVehicleService
Updates a vehicle's transport order.
USER_NOTIFICATION - org.opentcs.drivers.vehicle.VehicleProcessModel.Attribute
Indicates a new user notification was published.
UserNotification - Class in org.opentcs.data.notification
A notification to be read by a user.
UserNotification(String, String, UserNotification.Level) - Constructor for class org.opentcs.data.notification.UserNotification
Creates a new Message.
UserNotification(String, UserNotification.Level) - Constructor for class org.opentcs.data.notification.UserNotification
Creates a new Message.
UserNotification.Level - Enum in org.opentcs.data.notification
Defines the possible message types.

V

value() - Method in annotation type org.opentcs.configuration.ConfigurationPrefix
Returns the name of the class the interface configures.
value() - Method in annotation type org.opentcs.util.annotations.ScheduledApiChanges
Returns the contained schedules.
valueOf(String) - Static method in enum org.opentcs.access.Kernel.State
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.opentcs.data.model.Block.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.opentcs.data.model.Path.Layout.ConnectionType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.opentcs.data.model.PeripheralInformation.ProcState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.opentcs.data.model.PeripheralInformation.State
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.opentcs.data.model.Point.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.opentcs.data.model.Vehicle.IntegrationLevel
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.opentcs.data.model.Vehicle.Orientation
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.opentcs.data.model.Vehicle.ProcState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.opentcs.data.model.Vehicle.State
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.opentcs.data.model.visualization.LocationRepresentation
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.opentcs.data.notification.UserNotification.Level
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.opentcs.data.order.DriveOrder.State
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.opentcs.data.order.TransportOrder.State
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.opentcs.data.peripherals.PeripheralJob.State
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.opentcs.data.peripherals.PeripheralOperation.ExecutionTrigger
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.opentcs.data.TCSObjectEvent.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.opentcs.drivers.peripherals.PeripheralProcessModel.Attribute
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.opentcs.drivers.vehicle.VehicleProcessModel.Attribute
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.opentcs.access.Kernel.State
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.opentcs.data.model.Block.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.opentcs.data.model.Path.Layout.ConnectionType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.opentcs.data.model.PeripheralInformation.ProcState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.opentcs.data.model.PeripheralInformation.State
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.opentcs.data.model.Point.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.opentcs.data.model.Vehicle.IntegrationLevel
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.opentcs.data.model.Vehicle.Orientation
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.opentcs.data.model.Vehicle.ProcState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.opentcs.data.model.Vehicle.State
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.opentcs.data.model.visualization.LocationRepresentation
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.opentcs.data.notification.UserNotification.Level
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.opentcs.data.order.DriveOrder.State
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.opentcs.data.order.TransportOrder.State
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.opentcs.data.peripherals.PeripheralJob.State
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.opentcs.data.peripherals.PeripheralOperation.ExecutionTrigger
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.opentcs.data.TCSObjectEvent.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.opentcs.drivers.peripherals.PeripheralProcessModel.Attribute
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.opentcs.drivers.vehicle.VehicleProcessModel.Attribute
Returns an array containing the constants of this enum type, in the order they are declared.
Vehicle - Class in org.opentcs.data.model
Describes a vehicle's current state.
Vehicle(String) - Constructor for class org.opentcs.data.model.Vehicle
Creates a new vehicle.
VEHICLE_PROPERTY - org.opentcs.drivers.vehicle.VehicleProcessModel.Attribute
Indicates a change of a vehicle property.
VEHICLE_ROUTE_COLOR - Static variable in interface org.opentcs.data.model.visualization.ElementPropKeys
Color in which vehicle routes are to be emphasized.
Vehicle.IntegrationLevel - Enum in org.opentcs.data.model
A vehicle's state of integration into the system.
Vehicle.Layout - Class in org.opentcs.data.model
Contains information regarding the grahical representation of a vehicle.
Vehicle.Orientation - Enum in org.opentcs.data.model
The elements of this enumeration represent the possible orientations of a vehicle.
Vehicle.ProcState - Enum in org.opentcs.data.model
A vehicle's processing state as seen by the dispatcher.
Vehicle.State - Enum in org.opentcs.data.model
The elements of this enumeration describe the various possible states of a vehicle.
VehicleCommAdapter - Interface in org.opentcs.drivers.vehicle
This interface declares the methods that a driver communicating with and controlling a physical vehicle must implement.
VehicleCommAdapterDescription - Class in org.opentcs.drivers.vehicle
Provides the description for a vehicle comm adapter.
VehicleCommAdapterDescription() - Constructor for class org.opentcs.drivers.vehicle.VehicleCommAdapterDescription
 
VehicleCommAdapterEvent - Class in org.opentcs.drivers.vehicle
An event emitted by a communication adapter.
VehicleCommAdapterEvent(String) - Constructor for class org.opentcs.drivers.vehicle.VehicleCommAdapterEvent
Creates a new instance without an appendix.
VehicleCommAdapterEvent(String, Serializable) - Constructor for class org.opentcs.drivers.vehicle.VehicleCommAdapterEvent
Creates a new instance.
VehicleCommAdapterFactory - Interface in org.opentcs.drivers.vehicle
Provides communication adapter instances for vehicles to be controlled.
VehicleCommAdapterPanel - Class in org.opentcs.drivers.vehicle.management
A base class for panels associated with comm adapters.
VehicleCommAdapterPanel() - Constructor for class org.opentcs.drivers.vehicle.management.VehicleCommAdapterPanel
 
VehicleCommAdapterPanelFactory - Interface in org.opentcs.drivers.vehicle.management
Provides comm adapter specific panels used for interaction and displaying information.
VehicleController - Interface in org.opentcs.drivers.vehicle
Provides high-level methods for the system to control a vehicle.
VehicleControllerPool - Interface in org.opentcs.drivers.vehicle
Maintains associations between vehicles and vehicle controllers.
VehicleCreationTO - Class in org.opentcs.access.to.model
A transfer object describing a block in the plant model.
VehicleCreationTO(String) - Constructor for class org.opentcs.access.to.model.VehicleCreationTO
Creates a new instance.
VehicleCreationTO.Layout - Class in org.opentcs.access.to.model
Contains information regarding the grahical representation of a vehicle.
VehicleProcessModel - Class in org.opentcs.drivers.vehicle
An observable model of a vehicle's and its comm adapter's attributes.
VehicleProcessModel(Vehicle) - Constructor for class org.opentcs.drivers.vehicle.VehicleProcessModel
Creates a new instance.
VehicleProcessModel.Attribute - Enum in org.opentcs.drivers.vehicle
Notification arguments to indicate some change.
VehicleProcessModel.PropertyUpdate - Class in org.opentcs.drivers.vehicle
A notification object sent to observers to indicate a change of a property.
VehicleProcessModel.TransportOrderPropertyUpdate - Class in org.opentcs.drivers.vehicle
A notification object sent to observers to indicate a change of a transport order's property.
VehicleProcessModel.VehiclePropertyUpdate - Class in org.opentcs.drivers.vehicle
A notification object sent to observers to indicate a change of a vehicle's property.
VehicleProcessModelTO - Class in org.opentcs.drivers.vehicle.management
A serializable representation of a VehicleProcessModel.
VehicleProcessModelTO() - Constructor for class org.opentcs.drivers.vehicle.management.VehicleProcessModelTO
 
VehiclePropertyUpdate(String, String) - Constructor for class org.opentcs.drivers.vehicle.VehicleProcessModel.VehiclePropertyUpdate
Creates a new instance.
VehicleService - Interface in org.opentcs.components.kernel.services
Provides methods concerning Vehicles.
VehicleTheme - Interface in org.opentcs.components.plantoverview
Provides a vehicle theme.
VisualLayout - Class in org.opentcs.data.model.visualization
Describes the visual attributes of a model.
VisualLayout(String) - Constructor for class org.opentcs.data.model.visualization.VisualLayout
Creates a new VisualLayout.
VisualLayoutCreationTO - Class in org.opentcs.access.to.model
A transfer object describing a visual layout in the plant model.
VisualLayoutCreationTO(String) - Constructor for class org.opentcs.access.to.model.VisualLayoutCreationTO
Creates a new instance.
Void() - Constructor for class org.opentcs.components.kernel.Query.Void
 

W

when() - Method in annotation type org.opentcs.util.annotations.ScheduledApiChange
Returns the date or version at which the API is scheduled to be changed.
withAllowedOperations(List<String>) - Method in class org.opentcs.access.to.model.LocationTypeCreationTO
Creates a copy of this object with the given allowed operations.
withAllowedOperations(List<String>) - Method in class org.opentcs.data.model.LocationType
Creates a copy of this object, with the given allowed operations.
withAllowedOperations(Set<String>) - Method in class org.opentcs.data.model.Location.Link
Creates a copy of this object, with the given allowed operations.
withAllowedOrderTypes(Set<String>) - Method in class org.opentcs.data.model.Vehicle
Creates a copy of this object, with the given set of allowed order types.
withAllowedPeripheralOperations(List<String>) - Method in class org.opentcs.access.to.model.LocationTypeCreationTO
Creates a copy of this object with the given allowed peripheral operations.
withAllowedPeripheralOperations(List<String>) - Method in class org.opentcs.data.model.LocationType
Creates a copy of this object, with the given allowed peripheral operations.
withAttachedCommAdapter(PeripheralCommAdapterDescription) - Method in class org.opentcs.drivers.peripherals.management.PeripheralAttachmentInformation
Creates a copy of this object with the given attached comm adapter.
withAttachedCommAdapter(VehicleCommAdapterDescription) - Method in class org.opentcs.drivers.vehicle.management.AttachmentInformation
Creates a copy of this object with the given attached comm adapter.
withAttachedLinks(Set<Location.Link>) - Method in class org.opentcs.data.model.Location
Creates a copy of this object, with the given attached links.
withAttachedLinks(Set<Location.Link>) - Method in class org.opentcs.data.model.Point
Creates a copy of this object, with the given attached links.
withAvailableCommAdapters(List<VehicleCommAdapterDescription>) - Method in class org.opentcs.drivers.vehicle.management.AttachmentInformation
Creates a copy of this object with the given available comm adapters.
withBlock(BlockCreationTO) - Method in class org.opentcs.access.to.model.PlantModelCreationTO
Creates a copy of this object that includes the given block in the list of blocks.
withBlocks(List<BlockCreationTO>) - Method in class org.opentcs.access.to.model.PlantModelCreationTO
Creates a copy of this object with the given blocks.
withColor(Color) - Method in class org.opentcs.access.to.model.BlockCreationTO.Layout
Creates a copy of this object, with the given color.
withColor(Color) - Method in class org.opentcs.data.model.Block.Layout
Creates a copy of this object, with the given color.
withCommAdapterConnected(boolean) - Method in class org.opentcs.drivers.peripherals.PeripheralProcessModel
Creates a copy of the object, with the given connected state.
withCommAdapterEnabled(boolean) - Method in class org.opentcs.drivers.peripherals.PeripheralProcessModel
Creates a copy of the object, with the given enabled state.
withComplete(boolean) - Method in class org.opentcs.data.order.OrderSequence
Creates a copy of this object, with the given complete flag.
withCompletionRequired(boolean) - Method in class org.opentcs.access.to.peripherals.PeripheralOperationCreationTO
Creates a copy of this object, with the given completion required flag.
withConnectionType(Path.Layout.ConnectionType) - Method in class org.opentcs.access.to.model.PathCreationTO.Layout
Creates a copy of this object, with the given connection type.
withConnectionType(Path.Layout.ConnectionType) - Method in class org.opentcs.data.model.Path.Layout
Creates a copy of this object, with the given connection type.
withControlPoints(List<Couple>) - Method in class org.opentcs.access.to.model.PathCreationTO.Layout
Creates a copy of this object, with the given control points.
withControlPoints(List<Couple>) - Method in class org.opentcs.data.model.Path.Layout
Creates a copy of this object, with the given control points.
withCreationTime(Instant) - Method in class org.opentcs.data.order.TransportOrder
Creates a copy of this object, with the given creation time.
withCreationTime(Instant) - Method in class org.opentcs.data.peripherals.PeripheralJob
Creates a copy of this object, with the given creation time.
withCurrentDriveOrderIndex(int) - Method in class org.opentcs.data.order.TransportOrder
Creates a copy of this object, with the given drive order index.
withCurrentDriveOrderState(DriveOrder.State) - Method in class org.opentcs.data.order.TransportOrder
Creates a copy of this object, with the given current drive order state.
withCurrentPosition(TCSObjectReference<Point>) - Method in class org.opentcs.data.model.Vehicle
Creates a copy of this object, with the given current position.
withDeadline(Instant) - Method in class org.opentcs.access.to.order.TransportOrderCreationTO
Creates a copy of this object with the given point of time at which execution of the transport order is supposed to be finished.
withDeadline(Instant) - Method in class org.opentcs.data.order.TransportOrder
Creates a copy of this object, with the given deadline.
withDependencies(Set<TCSObjectReference<TransportOrder>>) - Method in class org.opentcs.data.order.TransportOrder
Creates a copy of this object, with the given dependencies.
withDependencyNames(Set<String>) - Method in class org.opentcs.access.to.order.TransportOrderCreationTO
Creates a copy of this object with the given (optional) names of transport orders the transport order depends on.
withDestinations(List<DestinationCreationTO>) - Method in class org.opentcs.access.to.order.TransportOrderCreationTO
Creates a copy of this object with the given destinations that need to be travelled to.
withDestLocationName(String) - Method in class org.opentcs.access.to.order.DestinationCreationTO
Creates a copy of this object with the given destination location (or point) name.
withDestOperation(String) - Method in class org.opentcs.access.to.order.DestinationCreationTO
Creates a copy of this object with the given operation to be performed at the destination.
withDestPointName(String) - Method in class org.opentcs.access.to.model.PathCreationTO
Creates a copy of this object with the given destination point.
withDispensable(boolean) - Method in class org.opentcs.access.to.order.TransportOrderCreationTO
Creates a copy of this object with the given indication whether the transport order is dispensable or not.
withDispensable(boolean) - Method in class org.opentcs.data.order.TransportOrder
Creates a copy of this object, with the given dispensable flag.
withdrawByLocation(ClientID, TCSResourceReference<Location>) - Method in interface org.opentcs.access.rmi.services.RemotePeripheralDispatcherService
 
withdrawByLocation(TCSResourceReference<Location>) - Method in interface org.opentcs.components.kernel.services.PeripheralDispatcherService
Withdraw any order that a peripheral device (represented by the given location) might be processing.
withdrawByTransportOrder(ClientID, TCSObjectReference<TransportOrder>, boolean) - Method in interface org.opentcs.access.rmi.services.RemoteDispatcherService
 
withdrawByTransportOrder(TCSObjectReference<TransportOrder>, boolean) - Method in interface org.opentcs.components.kernel.services.DispatcherService
Withdraw the referenced order.
withdrawByVehicle(ClientID, TCSObjectReference<Vehicle>, boolean) - Method in interface org.opentcs.access.rmi.services.RemoteDispatcherService
 
withdrawByVehicle(TCSObjectReference<Vehicle>, boolean) - Method in interface org.opentcs.components.kernel.services.DispatcherService
Withdraw any order that a vehicle might be processing.
withdrawJob(Location) - Method in interface org.opentcs.components.kernel.PeripheralJobDispatcher
Notifies the dispatcher that any job a peripheral device (represented by the given location) might be processing is to be withdrawn.
WITHDRAWN - org.opentcs.data.order.TransportOrder.State
Indicates the transport order is withdrawn from a processing vehicle but not yet in its final state (which will be FAILED), as the vehicle has not yet finished/cleaned up.
withdrawOrder(Vehicle, boolean) - Method in interface org.opentcs.components.kernel.Dispatcher
Notifies the dispatcher that any order a given vehicle might be processing is to be withdrawn.
withdrawOrder(TransportOrder, boolean) - Method in interface org.opentcs.components.kernel.Dispatcher
Notifies the dispatcher that the given transport order is to be withdrawn/aborted.
withDriveOrders(List<DriveOrder>) - Method in class org.opentcs.data.order.TransportOrder
Creates a copy of this object, with the given drive orders.
withEnergyLevel(int) - Method in class org.opentcs.data.model.Vehicle
Creates a copy of this object, with the given energy level.
withEnergyLevelCritical(int) - Method in class org.opentcs.access.to.model.VehicleCreationTO
Creates a copy of this object with the given critical energy level.
withEnergyLevelCritical(int) - Method in class org.opentcs.data.model.Vehicle
Creates a copy of this object, with the given critical energy level.
withEnergyLevelFullyRecharged(int) - Method in class org.opentcs.access.to.model.VehicleCreationTO
Creates a copy of this object with the vehicle's fully recharged energy level (in percent of the maximum).
withEnergyLevelFullyRecharged(int) - Method in class org.opentcs.data.model.Vehicle
Creates a copy of this object, with the given fully recharged energy level.
withEnergyLevelGood(int) - Method in class org.opentcs.access.to.model.VehicleCreationTO
Creates a copy of this object with the vehicle's good energy level (in percent of the maximum).
withEnergyLevelGood(int) - Method in class org.opentcs.data.model.Vehicle
Creates a copy of this object, with the given good energy level.
withEnergyLevelSufficientlyRecharged(int) - Method in class org.opentcs.access.to.model.VehicleCreationTO
Creates a copy of this object with the vehicle's sufficiently recharged energy level (in percent of the maximum).
withEnergyLevelSufficientlyRecharged(int) - Method in class org.opentcs.data.model.Vehicle
Creates a copy of this object, with the given sufficiently recharged energy level.
withEntries(List<ObjectHistory.Entry>) - Method in class org.opentcs.data.ObjectHistory
Returns a copy of this object, with the given entries.
withEntryAppended(ObjectHistory.Entry) - Method in class org.opentcs.data.ObjectHistory
Returns a copy of this object, with the given entry appended.
withExecutionTrigger(PeripheralOperation.ExecutionTrigger) - Method in class org.opentcs.access.to.peripherals.PeripheralOperationCreationTO
Creates a copy of this object, with the given execution trigger.
withFailureFatal(boolean) - Method in class org.opentcs.access.to.order.OrderSequenceCreationTO
 
withFailureFatal(boolean) - Method in class org.opentcs.data.order.OrderSequence
Creates a copy of this object, with the given failure-fatal flag.
withFinished(boolean) - Method in class org.opentcs.data.order.OrderSequence
Creates a copy of this object, with the given finished flag.
withFinishedIndex(int) - Method in class org.opentcs.data.order.OrderSequence
Creates a copy of this object, with the given finished index.
withFinishedTime(Instant) - Method in class org.opentcs.data.order.TransportOrder
Creates a copy of this object, with the given finished time.
withFinishedTime(Instant) - Method in class org.opentcs.data.peripherals.PeripheralJob
Creates a copy of this object, with the given finished time.
withGroup(GroupCreationTO) - Method in class org.opentcs.access.to.model.PlantModelCreationTO
Deprecated.
withGroupId(int) - Method in class org.opentcs.data.model.visualization.Layer
Creates a copy of this object, with the given group ID.
withGroups(List<GroupCreationTO>) - Method in class org.opentcs.access.to.model.PlantModelCreationTO
Deprecated.
withHistory(ObjectHistory) - Method in class org.opentcs.data.model.Block
 
withHistory(ObjectHistory) - Method in class org.opentcs.data.model.Group
Deprecated.
 
withHistory(ObjectHistory) - Method in class org.opentcs.data.model.Location
 
withHistory(ObjectHistory) - Method in class org.opentcs.data.model.LocationType
 
withHistory(ObjectHistory) - Method in class org.opentcs.data.model.Path
 
withHistory(ObjectHistory) - Method in class org.opentcs.data.model.Point
 
withHistory(ObjectHistory) - Method in class org.opentcs.data.model.Vehicle
 
withHistory(ObjectHistory) - Method in class org.opentcs.data.model.visualization.VisualLayout
 
withHistory(ObjectHistory) - Method in class org.opentcs.data.order.OrderSequence
 
withHistory(ObjectHistory) - Method in class org.opentcs.data.order.TransportOrder
 
withHistory(ObjectHistory) - Method in class org.opentcs.data.peripherals.PeripheralJob
 
withHistory(ObjectHistory) - Method in class org.opentcs.data.TCSObject
Creates a copy of this object, with the given history.
withHistoryEntry(ObjectHistory.Entry) - Method in class org.opentcs.data.model.Block
 
withHistoryEntry(ObjectHistory.Entry) - Method in class org.opentcs.data.model.Group
Deprecated.
 
withHistoryEntry(ObjectHistory.Entry) - Method in class org.opentcs.data.model.Location
 
withHistoryEntry(ObjectHistory.Entry) - Method in class org.opentcs.data.model.LocationType
 
withHistoryEntry(ObjectHistory.Entry) - Method in class org.opentcs.data.model.Path
 
withHistoryEntry(ObjectHistory.Entry) - Method in class org.opentcs.data.model.Point
 
withHistoryEntry(ObjectHistory.Entry) - Method in class org.opentcs.data.model.Vehicle
 
withHistoryEntry(ObjectHistory.Entry) - Method in class org.opentcs.data.model.visualization.VisualLayout
 
withHistoryEntry(ObjectHistory.Entry) - Method in class org.opentcs.data.order.OrderSequence
 
withHistoryEntry(ObjectHistory.Entry) - Method in class org.opentcs.data.order.TransportOrder
 
withHistoryEntry(ObjectHistory.Entry) - Method in class org.opentcs.data.peripherals.PeripheralJob
 
withHistoryEntry(ObjectHistory.Entry) - Method in class org.opentcs.data.TCSObject
Creates a copy of this object, with the given history entry integrated.
withIncomingPaths(Set<TCSObjectReference<Path>>) - Method in class org.opentcs.data.model.Point
Creates a copy of this object, with the given incoming paths.
withIncompleteName(boolean) - Method in class org.opentcs.access.to.order.OrderSequenceCreationTO
Creates a copy of this object with the given nameIncomplete flag.
withIncompleteName(boolean) - Method in class org.opentcs.access.to.order.TransportOrderCreationTO
Creates a copy of this object with the given nameIncomplete flag.
withIncompleteName(boolean) - Method in class org.opentcs.access.to.peripherals.PeripheralJobCreationTO
Creates a copy of this object, with the given incomplete name flag.
withIntegrationLevel(Vehicle.IntegrationLevel) - Method in class org.opentcs.data.model.Vehicle
Creates a copy of this object, with the given integration level.
withIntendedVehicle(TCSObjectReference<Vehicle>) - Method in class org.opentcs.data.order.OrderSequence
Creates a copy of this object, with the given intended vehicle.
withIntendedVehicle(TCSObjectReference<Vehicle>) - Method in class org.opentcs.data.order.TransportOrder
Creates a copy of this object, with the given intended vehicle.
withIntendedVehicleName(String) - Method in class org.opentcs.access.to.order.OrderSequenceCreationTO
Creates a copy of this object with the given (optional) name of the vehicle that is supposed to execute the transport order.
withIntendedVehicleName(String) - Method in class org.opentcs.access.to.order.TransportOrderCreationTO
Creates a copy of this object with the given (optional) name of the vehicle that is supposed to execute the transport order.
withLabelOffset(Couple) - Method in class org.opentcs.access.to.model.LocationCreationTO.Layout
Creates a copy of this object, with the given X label offset.
withLabelOffset(Couple) - Method in class org.opentcs.access.to.model.PointCreationTO.Layout
Creates a copy of this object, with the given X label offset.
withLabelOffset(Couple) - Method in class org.opentcs.data.model.Location.Layout
Creates a copy of this object, with the given X label offset.
withLabelOffset(Couple) - Method in class org.opentcs.data.model.Point.Layout
Creates a copy of this object, with the given X label offset.
withLayer(int) - Method in class org.opentcs.access.to.model.ModelLayoutElementCreationTO
Deprecated.
Creates a copy of this object with the given layer on which this model layout element is to be displayed.
withLayer(int) - Method in class org.opentcs.access.to.model.PathCreationTO.Layout
Creates a copy of this object, with the given layer ID.
withLayer(int) - Method in class org.opentcs.access.to.model.ShapeLayoutElementCreationTO
Deprecated.
Creates a copy of this object with the given layer on which this shape layout element is to be displayed.
withLayer(int) - Method in class org.opentcs.data.model.Path.Layout
Creates a copy of this object, with the given layer ID.
withLayer(Layer) - Method in class org.opentcs.access.to.model.VisualLayoutCreationTO
Creates a copy of this object, with the given layer.
withLayerGroup(LayerGroup) - Method in class org.opentcs.access.to.model.VisualLayoutCreationTO
Creates a copy of this object, with the given layer group.
withLayerGroups(List<LayerGroup>) - Method in class org.opentcs.access.to.model.VisualLayoutCreationTO
Creates a copy of this object, with the given layer groups.
withLayerGroups(List<LayerGroup>) - Method in class org.opentcs.data.model.visualization.VisualLayout
Creates a copy of this object, with the given layer groups.
withLayerId(int) - Method in class org.opentcs.access.to.model.LocationCreationTO.Layout
Creates a copy of this object, with the given layer ID.
withLayerId(int) - Method in class org.opentcs.access.to.model.PointCreationTO.Layout
Creates a copy of this object, with the given layer ID.
withLayerId(int) - Method in class org.opentcs.data.model.Location.Layout
Creates a copy of this object, with the given layer ID.
withLayerId(int) - Method in class org.opentcs.data.model.Point.Layout
Creates a copy of this object, with the given layer ID.
withLayers(List<Layer>) - Method in class org.opentcs.access.to.model.VisualLayoutCreationTO
Creates a copy of this object, with the given layers.
withLayers(List<Layer>) - Method in class org.opentcs.data.model.visualization.VisualLayout
Creates a copy of this object, with the given layers.
withLayout(BlockCreationTO.Layout) - Method in class org.opentcs.access.to.model.BlockCreationTO
Creates a copy of this object, with the given layout.
withLayout(LocationCreationTO.Layout) - Method in class org.opentcs.access.to.model.LocationCreationTO
Creates a copy of this object, with the given layout.
withLayout(LocationTypeCreationTO.Layout) - Method in class org.opentcs.access.to.model.LocationTypeCreationTO
Creates a copy of this object, with the given layout.
withLayout(PathCreationTO.Layout) - Method in class org.opentcs.access.to.model.PathCreationTO
Creates a copy of this object, with the given layout.
withLayout(PointCreationTO.Layout) - Method in class org.opentcs.access.to.model.PointCreationTO
Creates a copy of this object, with the given layout.
withLayout(VehicleCreationTO.Layout) - Method in class org.opentcs.access.to.model.VehicleCreationTO
Creates a copy of this object, with the given layout.
withLayout(Block.Layout) - Method in class org.opentcs.data.model.Block
Creates a copy of this object, with the given layout.
withLayout(Location.Layout) - Method in class org.opentcs.data.model.Location
Creates a copy of this object, with the given layout.
withLayout(LocationType.Layout) - Method in class org.opentcs.data.model.LocationType
Creates a copy of this object, with the given layout.
withLayout(Path.Layout) - Method in class org.opentcs.data.model.Path
Creates a copy of this object, with the given layout.
withLayout(Point.Layout) - Method in class org.opentcs.data.model.Point
Creates a copy of this object, with the given layout.
withLayout(Vehicle.Layout) - Method in class org.opentcs.data.model.Vehicle
Creates a copy of this object, with the given layout.
withLayoutElements(Set<LayoutElement>) - Method in class org.opentcs.data.model.visualization.VisualLayout
Deprecated.
withLength(int) - Method in class org.opentcs.access.to.model.VehicleCreationTO
Creates a copy of this object with the vehicle's given length (in mm).
withLength(int) - Method in class org.opentcs.data.model.Vehicle
Creates a copy of this object, with the given length.
withLength(long) - Method in class org.opentcs.access.to.model.PathCreationTO
Creates a copy of this object with the given path length (in mm).
withLength(long) - Method in class org.opentcs.data.model.Path
Creates a copy of this object, with the given length.
withLink(String, Set<String>) - Method in class org.opentcs.access.to.model.LocationCreationTO
Creates a copy of this object with the given links that attach points to this location.
withLinks(Map<String, Set<String>>) - Method in class org.opentcs.access.to.model.LocationCreationTO
Creates a copy of this object with the given links that attach points to this location.
withLoadHandlingDevices(List<LoadHandlingDevice>) - Method in class org.opentcs.data.model.Vehicle
Creates a copy of this object, with the given load handling devices.
withLocation(LocationCreationTO) - Method in class org.opentcs.access.to.model.PlantModelCreationTO
Creates a copy of this object that includes the given block in the list of locations.
withLocation(TCSResourceReference<Location>) - Method in class org.opentcs.drivers.peripherals.PeripheralProcessModel
Creates a copy of the object, with the given location reference.
withLocationName(String) - Method in class org.opentcs.access.to.peripherals.PeripheralOperationCreationTO
Creates a copy of this object, with the given location name.
withLocationReference(TCSResourceReference<Location>) - Method in class org.opentcs.drivers.peripherals.management.PeripheralAttachmentInformation
Creates a copy of this object with the given location reference.
withLocationRepresentation(LocationRepresentation) - Method in class org.opentcs.access.to.model.LocationCreationTO.Layout
Creates a copy of this object, with the given location representation.
withLocationRepresentation(LocationRepresentation) - Method in class org.opentcs.access.to.model.LocationTypeCreationTO.Layout
Creates a copy of this object, with the given location representation.
withLocationRepresentation(LocationRepresentation) - Method in class org.opentcs.data.model.Location.Layout
Creates a copy of this object, with the given location representation.
withLocationRepresentation(LocationRepresentation) - Method in class org.opentcs.data.model.LocationType.Layout
Creates a copy of this object, with the given location representation.
withLocations(List<LocationCreationTO>) - Method in class org.opentcs.access.to.model.PlantModelCreationTO
Creates a copy of this object with the given locations.
withLocationType(LocationTypeCreationTO) - Method in class org.opentcs.access.to.model.PlantModelCreationTO
Creates a copy of this object that includes the given path in the list of location types.
withLocationTypes(List<LocationTypeCreationTO>) - Method in class org.opentcs.access.to.model.PlantModelCreationTO
Creates a copy of this object with the given location type.
withLocked(boolean) - Method in class org.opentcs.access.to.model.LocationCreationTO
Creates a copy of this object with the given locked flag.
withLocked(boolean) - Method in class org.opentcs.access.to.model.PathCreationTO
Creates a copy of this object that is locked if locked==true and unlocked otherwise.
withLocked(boolean) - Method in class org.opentcs.data.model.Location
Creates a copy of this object, with the given locked flag.
withLocked(boolean) - Method in class org.opentcs.data.model.Path
Creates a copy of this object, with the given locked flag.
withMaxReverseVelocity(int) - Method in class org.opentcs.access.to.model.PathCreationTO
Creates a copy of this object with the allowed maximum reverse velocity (in mm/s).
withMaxReverseVelocity(int) - Method in class org.opentcs.access.to.model.VehicleCreationTO
Creates a copy of this object with the given maximum reverse velocity (in mm/s).
withMaxReverseVelocity(int) - Method in class org.opentcs.data.model.Path
Creates a copy of this object, with the given maximum reverse velocity.
withMaxReverseVelocity(int) - Method in class org.opentcs.data.model.Vehicle
Creates a copy of this object, with the given maximum reverse velocity.
withMaxVelocity(int) - Method in class org.opentcs.access.to.model.PathCreationTO
Creates a copy of this object with the maximum allowed forward velocity (in mm/s) for this path.
withMaxVelocity(int) - Method in class org.opentcs.access.to.model.VehicleCreationTO
Creates a copy of this object with the given maximum velocity (in mm/s).
withMaxVelocity(int) - Method in class org.opentcs.data.model.Path
Creates a copy of this object, with the given maximum velocity.
withMaxVelocity(int) - Method in class org.opentcs.data.model.Vehicle
Creates a copy of this object, with the given maximum velocity.
withMemberNames(Set<String>) - Method in class org.opentcs.access.to.model.BlockCreationTO
Creates a copy of this object with the given members.
withMemberNames(Set<String>) - Method in class org.opentcs.access.to.model.GroupCreationTO
Deprecated.
Creates a copy of this object with group's members.
withMembers(Set<TCSResourceReference<?>>) - Method in class org.opentcs.data.model.Block
Creates a copy of this object, with the given members.
withMembers(Set<TCSObjectReference<?>>) - Method in class org.opentcs.data.model.Group
Deprecated.
Creates a copy of this object, with the given members.
withModelElement(ModelLayoutElementCreationTO) - Method in class org.opentcs.access.to.model.VisualLayoutCreationTO
Deprecated.
withModelElements(List<ModelLayoutElementCreationTO>) - Method in class org.opentcs.access.to.model.VisualLayoutCreationTO
Deprecated.
withName(String) - Method in class org.opentcs.access.to.CreationTO
Creates a copy of this object with the given name.
withName(String) - Method in class org.opentcs.access.to.model.BlockCreationTO
Creates a copy of this object with the given name.
withName(String) - Method in class org.opentcs.access.to.model.GroupCreationTO
Deprecated.
Creates a copy of this object with the given name.
withName(String) - Method in class org.opentcs.access.to.model.LocationCreationTO
Creates a copy of this object with the given name.
withName(String) - Method in class org.opentcs.access.to.model.LocationTypeCreationTO
Creates a copy of this object with the given name.
withName(String) - Method in class org.opentcs.access.to.model.ModelLayoutElementCreationTO
Deprecated.
Creates a copy of this object with the given name.
withName(String) - Method in class org.opentcs.access.to.model.PathCreationTO
Creates a copy of this object with the given name.
withName(String) - Method in class org.opentcs.access.to.model.PointCreationTO
Creates a copy of this object with the given name.
withName(String) - Method in class org.opentcs.access.to.model.ShapeLayoutElementCreationTO
Deprecated.
Creates a copy of this object with the given name.
withName(String) - Method in class org.opentcs.access.to.model.VehicleCreationTO
Creates a copy of this object with the given name.
withName(String) - Method in class org.opentcs.access.to.model.VisualLayoutCreationTO
Creates a copy of this object with the given name.
withName(String) - Method in class org.opentcs.access.to.order.DestinationCreationTO
Creates a copy of this object with the given name.
withName(String) - Method in class org.opentcs.access.to.order.OrderSequenceCreationTO
Creates a copy of this object with the given name.
withName(String) - Method in class org.opentcs.access.to.order.TransportOrderCreationTO
Creates a copy of this object with the given name.
withName(String) - Method in class org.opentcs.access.to.peripherals.PeripheralJobCreationTO
 
withName(String) - Method in class org.opentcs.access.to.peripherals.PeripheralOperationCreationTO
 
withName(String) - Method in class org.opentcs.data.model.visualization.Layer
Creates a copy of this object, with the given name.
withName(String) - Method in class org.opentcs.data.model.visualization.LayerGroup
Creates a copy of this object, with the given name.
withNextPosition(TCSObjectReference<Point>) - Method in class org.opentcs.data.model.Vehicle
Creates a copy of this object, with the given next position.
withOccupyingVehicle(TCSObjectReference<Vehicle>) - Method in class org.opentcs.data.model.Point
Creates a copy of this object, with the given occupying vehicle.
withOperation(String) - Method in class org.opentcs.access.to.peripherals.PeripheralOperationCreationTO
Creates a copy of this object, with the given operation.
withOperation(String) - Method in class org.opentcs.data.order.DriveOrder.Destination
Creates a copy of this object, with the given operation.
withOrder(TCSObjectReference<TransportOrder>) - Method in class org.opentcs.data.order.OrderSequence
Creates a copy of this object, with the given order.
withOrderSequence(TCSObjectReference<OrderSequence>) - Method in class org.opentcs.data.model.Vehicle
Creates a copy of this object, with the given order sequence.
withOrdinal(int) - Method in class org.opentcs.data.model.visualization.Layer
Creates a copy of this object, with the given ordinal.
withOrientationAngle(double) - Method in class org.opentcs.data.model.Vehicle
Creates a copy of this object, with the given orientation angle.
withOutgoingPaths(Set<TCSObjectReference<Path>>) - Method in class org.opentcs.data.model.Point
Creates a copy of this object, with the given outgoing paths.
withPath(PathCreationTO) - Method in class org.opentcs.access.to.model.PlantModelCreationTO
Creates a copy of this object that includes the given path in the list of paths.
withPaths(List<PathCreationTO>) - Method in class org.opentcs.access.to.model.PlantModelCreationTO
Creates a copy of this object with the given paths.
withPeripheralInformation(PeripheralInformation) - Method in class org.opentcs.data.model.Location
Creates a copy of this object, with the given peripheral information.
withPeripheralJob(TCSObjectReference<PeripheralJob>) - Method in class org.opentcs.data.model.PeripheralInformation
Creates a copy of this object, with the given peripheral job.
withPeripheralOperation(PeripheralOperationCreationTO) - Method in class org.opentcs.access.to.peripherals.PeripheralJobCreationTO
Creates a copy of this object, with the given peripheral operation.
withPeripheralOperation(PeripheralOperation) - Method in class org.opentcs.data.peripherals.PeripheralJob
Creates a copy of this object, with the given peripheral operation.
withPeripheralOperations(List<PeripheralOperationCreationTO>) - Method in class org.opentcs.access.to.model.PathCreationTO
Creates a copy of this object with the given peripheral operations.
withPeripheralOperations(List<PeripheralOperation>) - Method in class org.opentcs.data.model.Path
Creates a copy of this object, with the given peripheral operations.
withPeripheralReservationToken(String) - Method in class org.opentcs.access.to.order.TransportOrderCreationTO
Creates a copy of this object with the given (optional) peripheral reservation token.
withPeripheralReservationToken(String) - Method in class org.opentcs.data.order.TransportOrder
Creates a copy of this object, with the given reservation token.
withPoint(PointCreationTO) - Method in class org.opentcs.access.to.model.PlantModelCreationTO
Creates a copy of this object that includes the given point in the list of points.
withPoints(List<PointCreationTO>) - Method in class org.opentcs.access.to.model.PlantModelCreationTO
Creates a copy of this object with the given points.
withPosition(Couple) - Method in class org.opentcs.access.to.model.LocationCreationTO.Layout
Creates a copy of this object, with the given position.
withPosition(Couple) - Method in class org.opentcs.access.to.model.PointCreationTO.Layout
Creates a copy of this object, with the given position.
withPosition(Couple) - Method in class org.opentcs.data.model.Location.Layout
Creates a copy of this object, with the given position.
withPosition(Couple) - Method in class org.opentcs.data.model.Point.Layout
Creates a copy of this object, with the given position.
withPosition(Triple) - Method in class org.opentcs.access.to.model.LocationCreationTO
Creates a copy of this object with the given position (in mm).
withPosition(Triple) - Method in class org.opentcs.access.to.model.PointCreationTO
Creates a copy of this object with the given position (in mm).
withPosition(Triple) - Method in class org.opentcs.data.model.Location
Creates a copy of this object, with the given position.
withPosition(Triple) - Method in class org.opentcs.data.model.Point
Creates a copy of this object, with the given position.
withPrecisePosition(Triple) - Method in class org.opentcs.data.model.Vehicle
Creates a copy of this object, with the given precise position.
withProcessingVehicle(TCSObjectReference<Vehicle>) - Method in class org.opentcs.data.order.OrderSequence
Creates a copy of this object, with the given processing vehicle.
withProcessingVehicle(TCSObjectReference<Vehicle>) - Method in class org.opentcs.data.order.TransportOrder
Creates a copy of this object, with the given processing vehicle.
withProcState(PeripheralInformation.ProcState) - Method in class org.opentcs.data.model.PeripheralInformation
Creates a copy of this object, with the given processing state.
withProcState(Vehicle.ProcState) - Method in class org.opentcs.data.model.Vehicle
Creates a copy of this object, with the given processing state.
withProperties(Map<String, String>) - Method in class org.opentcs.access.to.CreationTO
 
withProperties(Map<String, String>) - Method in class org.opentcs.access.to.model.BlockCreationTO
Creates a copy of this object with the given properties.
withProperties(Map<String, String>) - Method in class org.opentcs.access.to.model.GroupCreationTO
Deprecated.
Creates a copy of this object with the given properties.
withProperties(Map<String, String>) - Method in class org.opentcs.access.to.model.LocationCreationTO
Creates a copy of this object with the given properties.
withProperties(Map<String, String>) - Method in class org.opentcs.access.to.model.LocationTypeCreationTO
Creates a copy of this object with the given properties.
withProperties(Map<String, String>) - Method in class org.opentcs.access.to.model.ModelLayoutElementCreationTO
Deprecated.
Creates a copy of this object with the given properties.
withProperties(Map<String, String>) - Method in class org.opentcs.access.to.model.PathCreationTO
Creates a copy of this object with the given properties.
withProperties(Map<String, String>) - Method in class org.opentcs.access.to.model.PlantModelCreationTO
Creates a copy of this object with the given properties.
withProperties(Map<String, String>) - Method in class org.opentcs.access.to.model.PointCreationTO
Creates a copy of this object with the given properties.
withProperties(Map<String, String>) - Method in class org.opentcs.access.to.model.ShapeLayoutElementCreationTO
Deprecated.
Creates a copy of this object with the given properties.
withProperties(Map<String, String>) - Method in class org.opentcs.access.to.model.VehicleCreationTO
Creates a copy of this object with the given properties.
withProperties(Map<String, String>) - Method in class org.opentcs.access.to.model.VisualLayoutCreationTO
Creates a copy of this object with the given properties.
withProperties(Map<String, String>) - Method in class org.opentcs.access.to.order.DestinationCreationTO
Creates a copy of this object with the given properties.
withProperties(Map<String, String>) - Method in class org.opentcs.access.to.order.OrderSequenceCreationTO
Creates a copy of this object with the given properties.
withProperties(Map<String, String>) - Method in class org.opentcs.access.to.order.TransportOrderCreationTO
Creates a copy of this object with the given properties.
withProperties(Map<String, String>) - Method in class org.opentcs.access.to.peripherals.PeripheralJobCreationTO
 
withProperties(Map<String, String>) - Method in class org.opentcs.access.to.peripherals.PeripheralOperationCreationTO
 
withProperties(Map<String, String>) - Method in class org.opentcs.data.model.Block
 
withProperties(Map<String, String>) - Method in class org.opentcs.data.model.Group
Deprecated.
 
withProperties(Map<String, String>) - Method in class org.opentcs.data.model.Location
 
withProperties(Map<String, String>) - Method in class org.opentcs.data.model.LocationType
 
withProperties(Map<String, String>) - Method in class org.opentcs.data.model.Path
 
withProperties(Map<String, String>) - Method in class org.opentcs.data.model.Point
 
withProperties(Map<String, String>) - Method in class org.opentcs.data.model.Vehicle
 
withProperties(Map<String, String>) - Method in class org.opentcs.data.model.visualization.VisualLayout
 
withProperties(Map<String, String>) - Method in class org.opentcs.data.order.DriveOrder.Destination
Creates a copy of this object, with the given properties.
withProperties(Map<String, String>) - Method in class org.opentcs.data.order.OrderSequence
 
withProperties(Map<String, String>) - Method in class org.opentcs.data.order.TransportOrder
 
withProperties(Map<String, String>) - Method in class org.opentcs.data.peripherals.PeripheralJob
 
withProperties(Map<String, String>) - Method in class org.opentcs.data.TCSObject
Creates a copy of this object, with the given properties.
withProperty(String, String) - Method in class org.opentcs.access.to.CreationTO
Creates a copy of this object with the given property.
withProperty(String, String) - Method in class org.opentcs.access.to.model.BlockCreationTO
Creates a copy of this object and adds the given property.
withProperty(String, String) - Method in class org.opentcs.access.to.model.GroupCreationTO
Deprecated.
Creates a copy of this object and adds the given property.
withProperty(String, String) - Method in class org.opentcs.access.to.model.LocationCreationTO
Creates a copy of this object and adds the given property.
withProperty(String, String) - Method in class org.opentcs.access.to.model.LocationTypeCreationTO
Creates a copy of this object and adds the given property.
withProperty(String, String) - Method in class org.opentcs.access.to.model.ModelLayoutElementCreationTO
Deprecated.
Creates a copy of this object and adds the given property.
withProperty(String, String) - Method in class org.opentcs.access.to.model.PathCreationTO
Creates a copy of this object and adds the given property.
withProperty(String, String) - Method in class org.opentcs.access.to.model.PlantModelCreationTO
Creates a copy of this object and adds the given property.
withProperty(String, String) - Method in class org.opentcs.access.to.model.PointCreationTO
Creates a copy of this object and adds the given property.
withProperty(String, String) - Method in class org.opentcs.access.to.model.VehicleCreationTO
Creates a copy of this object and adds the given property.
withProperty(String, String) - Method in class org.opentcs.access.to.model.VisualLayoutCreationTO
Creates a copy of this object and adds the given property.
withProperty(String, String) - Method in class org.opentcs.access.to.order.DestinationCreationTO
Creates a copy of this object and adds the given property.
withProperty(String, String) - Method in class org.opentcs.access.to.order.OrderSequenceCreationTO
Creates a copy of this object and adds the given property.
withProperty(String, String) - Method in class org.opentcs.access.to.order.TransportOrderCreationTO
Creates a copy of this object and adds the given property.
withProperty(String, String) - Method in class org.opentcs.access.to.peripherals.PeripheralJobCreationTO
 
withProperty(String, String) - Method in class org.opentcs.access.to.peripherals.PeripheralOperationCreationTO
 
withProperty(String, String) - Method in class org.opentcs.data.model.Block
 
withProperty(String, String) - Method in class org.opentcs.data.model.Group
Deprecated.
 
withProperty(String, String) - Method in class org.opentcs.data.model.Location
 
withProperty(String, String) - Method in class org.opentcs.data.model.LocationType
 
withProperty(String, String) - Method in class org.opentcs.data.model.Path
 
withProperty(String, String) - Method in class org.opentcs.data.model.Point
 
withProperty(String, String) - Method in class org.opentcs.data.model.Vehicle
 
withProperty(String, String) - Method in class org.opentcs.data.model.visualization.VisualLayout
 
withProperty(String, String) - Method in class org.opentcs.data.order.OrderSequence
 
withProperty(String, String) - Method in class org.opentcs.data.order.TransportOrder
 
withProperty(String, String) - Method in class org.opentcs.data.peripherals.PeripheralJob
 
withProperty(String, String) - Method in class org.opentcs.data.TCSObject
Creates a copy of this object, with the given property integrated.
withPropery(String, String) - Method in class org.opentcs.access.to.model.ShapeLayoutElementCreationTO
Deprecated.
Creates a copy of this object and adds the given property.
withRechargeOperation(String) - Method in class org.opentcs.data.model.Vehicle
Creates a copy of this object, with the given recharge operation.
withRelatedTransportOrder(TCSObjectReference<TransportOrder>) - Method in class org.opentcs.data.peripherals.PeripheralJob
Creates a copy of this object, with the given related transport order.
withRelatedTransportOrderName(String) - Method in class org.opentcs.access.to.peripherals.PeripheralJobCreationTO
Creates a copy of this object, with the given related transport order name.
withRelatedVehicle(TCSObjectReference<Vehicle>) - Method in class org.opentcs.data.peripherals.PeripheralJob
Creates a copy of this object, with the given related vehicle.
withRelatedVehicleName(String) - Method in class org.opentcs.access.to.peripherals.PeripheralJobCreationTO
Creates a copy of this object, with the given related vehicle name.
withReservationToken(String) - Method in class org.opentcs.access.to.peripherals.PeripheralJobCreationTO
Creates a copy of this object, with the given reservation token.
withReservationToken(String) - Method in class org.opentcs.data.model.PeripheralInformation
Creates a copy of this object, with the given reservation token.
withReservationToken(String) - Method in class org.opentcs.data.peripherals.PeripheralJob
Creates a copy of this object, with the given reservation token.
withRoute(Route) - Method in class org.opentcs.data.order.DriveOrder
Creates a copy of this object, with the given route.
withRouteColor(Color) - Method in class org.opentcs.access.to.model.VehicleCreationTO.Layout
Creates a copy of this object, with the given color.
withRouteColor(Color) - Method in class org.opentcs.data.model.Vehicle.Layout
Creates a copy of this object, with the given color.
withRouteProgressIndex(int) - Method in class org.opentcs.data.model.Vehicle
Creates a copy of this object, with the given route progress index.
withScaleX(double) - Method in class org.opentcs.access.to.model.VisualLayoutCreationTO
Creates a copy of this object with the layout's scale on the X axis (in mm/pixel).
withScaleX(double) - Method in class org.opentcs.data.model.visualization.VisualLayout
Creates a copy of this object, with the given scaleX.
withScaleY(double) - Method in class org.opentcs.access.to.model.VisualLayoutCreationTO
Creates a copy of this object with the given layout's scale on the Y axis (in mm/pixel)
withScaleY(double) - Method in class org.opentcs.data.model.visualization.VisualLayout
Creates a copy of this object, with the given scaleY.
withShapeElement(ShapeLayoutElementCreationTO) - Method in class org.opentcs.access.to.model.VisualLayoutCreationTO
Deprecated.
withShapeElements(List<ShapeLayoutElementCreationTO>) - Method in class org.opentcs.access.to.model.VisualLayoutCreationTO
Deprecated.
withSrcPointName(String) - Method in class org.opentcs.access.to.model.PathCreationTO
Creates a copy of this object with the given point name this path originates in.
withState(PeripheralInformation.State) - Method in class org.opentcs.data.model.PeripheralInformation
Creates a copy of this object, with the given state.
withState(PeripheralInformation.State) - Method in class org.opentcs.drivers.peripherals.PeripheralProcessModel
Creates a copy of the object, with the given state.
withState(Vehicle.State) - Method in class org.opentcs.data.model.Vehicle
Creates a copy of this object, with the given state.
withState(DriveOrder.State) - Method in class org.opentcs.data.order.DriveOrder
Creates a copy of this object, with the given state.
withState(TransportOrder.State) - Method in class org.opentcs.data.order.TransportOrder
Creates a copy of this object, with the given state.
withState(PeripheralJob.State) - Method in class org.opentcs.data.peripherals.PeripheralJob
Creates a copy of this object, with the given state.
withTransportOrder(TCSObjectReference<TransportOrder>) - Method in class org.opentcs.data.model.Vehicle
Creates a copy of this object, with the given transport order.
withTransportOrder(TCSObjectReference<TransportOrder>) - Method in class org.opentcs.data.order.DriveOrder
Creates a copy of this object, with the given transport order.
withType(String) - Method in class org.opentcs.access.to.order.OrderSequenceCreationTO
Creates a copy of this object with the given type.
withType(String) - Method in class org.opentcs.access.to.order.TransportOrderCreationTO
Creates a copy of this object with the given (optional) type of the transport order.
withType(String) - Method in class org.opentcs.data.order.OrderSequence
Creates a copy of this object, with the given type.
withType(String) - Method in class org.opentcs.data.order.TransportOrder
Creates a copy of this obejct, with the given type.
withType(Block.Type) - Method in class org.opentcs.access.to.model.BlockCreationTO
Creates a copy of this object with the given type.
withType(Block.Type) - Method in class org.opentcs.data.model.Block
Creates a copy of this object, with the given type.
withType(Point.Type) - Method in class org.opentcs.access.to.model.PointCreationTO
Creates a copy of this object with the given type.
withType(Point.Type) - Method in class org.opentcs.data.model.Point
Creates a copy of this object, with the given type.
withTypeName(String) - Method in class org.opentcs.access.to.model.LocationCreationTO
Creates a copy of this object with the location's type.
withVehicle(VehicleCreationTO) - Method in class org.opentcs.access.to.model.PlantModelCreationTO
Creates a copy of this object that includes the given vehicle in the list of vehicles.
withVehicleOrientationAngle(double) - Method in class org.opentcs.access.to.model.PointCreationTO
Creates a copy of this object with the vehicle's (assumed) orientation angle when it's at this position.
withVehicleOrientationAngle(double) - Method in class org.opentcs.data.model.Point
Creates a copy of this object, with the given vehicle orientation angle.
withVehicleReference(TCSObjectReference<Vehicle>) - Method in class org.opentcs.drivers.vehicle.management.AttachmentInformation
Creates a copy of this object with the given vehicle reference.
withVehicles(List<VehicleCreationTO>) - Method in class org.opentcs.access.to.model.PlantModelCreationTO
Creates a copy of this object with the given vehicles.
withVisible(boolean) - Method in class org.opentcs.data.model.visualization.Layer
Creates a copy of this object, with the given visible state.
withVisible(boolean) - Method in class org.opentcs.data.model.visualization.LayerGroup
Creates a copy of this object, with the given visible state.
withVisualLayout(VisualLayoutCreationTO) - Method in class org.opentcs.access.to.model.PlantModelCreationTO
Creates a copy of this object that includes the given visual layout in the list of visual layout elements.
withVisualLayouts(List<VisualLayoutCreationTO>) - Method in class org.opentcs.access.to.model.PlantModelCreationTO
withWrappingSequence(String) - Method in class org.opentcs.access.to.order.TransportOrderCreationTO
Creates a copy of this object with the given (optional) name of the order sequence the transport order belongs to.
withWrappingSequence(TCSObjectReference<OrderSequence>) - Method in class org.opentcs.data.order.TransportOrder
Creates a copy of this object, with the given wrapping sequence.
WORKING_ALT_1 - org.opentcs.data.model.visualization.LocationRepresentation
A location for some generic processing, alternative variant 1.
WORKING_ALT_2 - org.opentcs.data.model.visualization.LocationRepresentation
A location for some generic processing, alternative variant 2.
WORKING_GENERIC - org.opentcs.data.model.visualization.LocationRepresentation
A location for some generic processing, generic variant.
A B C D E F G H I J K L M N O P Q R S T U V W 
All Classes All Packages