openTCS 5.17.1 API documentation: openTCS-API-Base
This is the description of the openTCS base API.
Tutorials/code examples can be found in the developer's guide that is also part of the openTCS distribution.
| Package | Description |
|---|---|
| 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 |
Interfaces and classes for transparently providing an openTCS kernel's
functionality via RMI.
|
| 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 |
Interfaces and classes for transparently providing an openTCS kernel's service functionality via
RMI.
|
| org.opentcs.access.to |
Transfer object classes for domain objects.
|
| org.opentcs.access.to.model |
Transfer object classes for plant model objects.
|
| org.opentcs.access.to.order |
Transfer object classes for transport order objects.
|
| org.opentcs.access.to.peripherals | |
| org.opentcs.components |
Interfaces and base classes for exchangeable components of openTCS applications.
|
| org.opentcs.components.kernel |
Interfaces for pluggable strategies and other components for a kernel application.
|
| org.opentcs.components.kernel.dipatching | |
| org.opentcs.components.kernel.routing | |
| org.opentcs.components.kernel.services |
Interfaces and classes defining internal and external interfaces for the openTCS kernel.
|
| org.opentcs.components.kernelcontrolcenter | |
| org.opentcs.components.plantoverview |
Interfaces for pluggable panels, themes and other components for a plant overview application.
|
| org.opentcs.configuration |
Configuration-related interfaces and annotations.
|
| org.opentcs.customizations |
Classes utilized for extending and customizing openTCS applications.
|
| org.opentcs.customizations.controlcenter |
Components supporting extension and customization of the openTCS kernel control center
application.
|
| org.opentcs.customizations.kernel |
Components supporting extension and customization of the openTCS kernel application.
|
| org.opentcs.customizations.plantoverview | |
| org.opentcs.data |
Basic openTCS data structures.
|
| 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 |
Classes describing the visual attributes of a model.
|
| org.opentcs.data.notification |
Classes for storing user-targeted notifications.
|
| org.opentcs.data.order |
Classes describing transport orders to be processed by vehicles.
|
| org.opentcs.data.peripherals |
Classes describing peripheral jobs to be processed by peripheral devices.
|
| org.opentcs.drivers | |
| org.opentcs.drivers.peripherals |
Components needed for controlling peripheral devices and processing information sent by them.
|
| org.opentcs.drivers.peripherals.management |
Components needed for processing information related to peripheral comm adapters.
|
| org.opentcs.drivers.vehicle |
Components needed for controlling physical vehicles and processing information sent by them.
|
| org.opentcs.drivers.vehicle.commands |
Commands a comm adapter may execute.
|
| org.opentcs.drivers.vehicle.management |
Components needed for processing information related to comm adapters.
|
| org.opentcs.drivers.vehicle.messages |
Reference implementations of commonly used messages to be processed by vehicle drivers.
|
| org.opentcs.util |
A collection of classes providing miscellaneous functions that are used
throughout openTCS.
|
| org.opentcs.util.annotations |
Useful annotations.
|
| org.opentcs.util.event |
Interfaces and classes for event handling.
|