All Classes
| Class | Description |
|---|---|
| ActiveInAllModes |
Annotation type for binding injectable components meant to be used in all kernel modes.
|
| ActiveInModellingMode |
Annotation type for binding injectable components meant to be used in modelling mode.
|
| ActiveInModellingMode |
Annotation type for binding injectable components meant to be used in modelling mode.
|
| ActiveInOperatingMode |
Annotation type for binding injectable components meant to be used in operating mode.
|
| ActiveInOperatingMode |
Annotation type for binding injectable components meant to be used in operating mode.
|
| AdapterCommand |
A command a comm adapter may execute.
|
| ApplicationEventBus |
Annotation type to mark a single application-wide injectable
EventBus. |
| ApplicationFrame |
Annotation type to mark the application's main frame.
|
| ApplicationHome |
A binding annotation that can be used to have the application's home directory injected.
|
| Assertions |
Utility methods for checking preconditions, postconditions etc..
|
| AttachmentEvent |
Instances of this class represent events emitted by/for attaching comm adapters.
|
| AttachmentInformation |
Describes which communication adapter a vehicle is currently associated with and which adapters
are available.
|
| BasicPeripheralCommAdapter |
A base class for peripheral communication adapters mainly providing command queue processing.
|
| BasicVehicleCommAdapter |
A base class for communication adapters mainly providing command queue processing.
|
| Block |
An aggregation of resources with distinct usage rules depending on the block's type.
|
| Block.Layout |
Contains information regarding the grahical representation of a block.
|
| Block.Type |
Describes the types of blocks in a driving course.
|
| BlockCreationTO |
A transfer object describing a block in the plant model.
|
| BlockCreationTO.Layout |
Contains information regarding the grahical representation of a block.
|
| CallWrapper |
Provides methods for wrapping other method calls.
|
| ClassMatcher |
Checks whether the input argument is assignable to any of a given set of classes.
|
| ClearError |
A message that informs a communication adapter that it/the vehicle should
reset currently active errors if possible.
|
| ClientID |
Identifies a remote client unambiguously.
|
| CommAdapterEvent |
Instances of this class represent events emitted by/for comm adapter changes.
|
| ConfigurationBindingProvider |
A provider to get bindings (implementations) for configuration interfaces.
|
| ConfigurationEntry |
Marks an interface's method that provides a configuration value.
|
| ConfigurationPrefix |
Marks an interface that provides some configuration for a specific class.
|
| ControlCenterPanel |
A panel that can be plugged into the kernel control center.
|
| Couple |
A generic 2-tuple of long integer values, usable for 2D coordinates and vectors, for instance.
|
| CreationTO |
The base class for all creation transfer objects.
|
| CredentialsException |
Thrown when there are insufficient user permissions to perform an operation.
|
| CyclicTask |
A template for cyclic tasks.
|
| DefaultVehicleCommAdapterDescription |
The default implementation of
VehicleCommAdapterDescription. |
| DestinationCreationTO |
A transfer object describing a destination of a drive order.
|
| Dispatcher |
This interface declares the methods a dispatcher module for the openTCS
kernel must implement.
|
| DispatcherService |
Provides methods concerning the
Dispatcher. |
| DriveOrder |
Describes a sequence of movements and an optional operation at the end that a
Vehicle is
supposed to execute. |
| DriveOrder.Destination |
Describes the destination of a drive order.
|
| DriveOrder.State |
Defines the various potential states of a drive order.
|
| Edge |
A wrapper for
Paths that can be used to build routing graphs. |
| EdgeEvaluator |
Computes the weight of edges in the routing graph.
|
| ElementPropKeys |
Defines some reserved/commonly used property keys of
LayoutElements. |
| Enums |
Provides helper methods for working with enums.
|
| EventBus |
A distributor of events.
|
| EventHandler |
A handler for events emitted by an
EventSource. |
| EventSource |
A source of events that can be subscribed to.
|
| ExplainedBoolean |
A boolean with an explanation/reason for its value.
|
| GlobalSyncObject |
Annotation type to mark an injectable synchronization object for the kernel.
|
| Group | Deprecated.
Will be removed.
|
| GroupCreationTO | Deprecated.
Will be removed.
|
| GroupMapper |
Determines the routing group for a
Vehicle instance. |
| ImageData | Deprecated.
Will be removed.
|
| ImageLayoutElement | Deprecated.
Will be removed.
|
| InitPositionCommand |
A command for initializing the comm adapter's position.
|
| InternalPeripheralJobService |
Declares the methods the peripheral job service must provide which are not accessible to remote
peers.
|
| InternalPeripheralService |
Declares the methods the peripheral service must provide which are not accessible to remote
peers.
|
| InternalPlantModelService |
Declares the methods the plant model service must provide which are not accessible to remote
peers.
|
| InternalQueryService |
Declares query-related methods not accessible to remote peers.
|
| InternalTransportOrderService |
Declares the methods the transport order service must provide which are not accessible to remote
peers.
|
| InternalVehicleService |
Declares the methods the vehicle service must provide which are not accessible to remote peers.
|
| Kernel |
Declares the methods an openTCS kernel implements.
|
| Kernel.State |
The various states a kernel instance may be running in.
|
| KernelException |
An exception thrown by the openTCS kernel.
|
| KernelExecutor |
Annotation type to mark a central injectable
ScheduledExecutorService. |
| KernelExtension |
Declares the methods that a generic kernel extension must implement.
|
| KernelRuntimeException |
A runtime exception thrown by the openTCS kernel.
|
| KernelServicePortal |
Provides clients access to kernel services.
|
| KernelServicePortalBuilder |
Builds
KernelServicePortal instances for connections to remote portals. |
| KernelStateTransitionEvent |
Emitted by/for kernel state changes.
|
| Layer |
Describes a layer in a plant model which is used to group model elements.
|
| LayerGroup |
Describes a layer group in a plant model.
|
| LayoutElement | Deprecated.
Will be removed.
|
| Lifecycle |
Defines methods for controlling a generic component's lifecycle.
|
| LoadHandlingDevice |
Describes a single load handling device on a vehicle.
|
| LocalKernel |
Declares the methods the openTCS kernel must provide which are not accessible
to remote peers.
|
| Location |
A location at which a
Vehicle may perform an action. |
| Location.Layout |
Contains information regarding the grahical representation of a location.
|
| Location.Link |
A link connecting a point and a location, expressing that the location is
reachable from the point.
|
| LocationCreationTO |
A transfer object describing a location in a plant model.
|
| LocationCreationTO.Layout |
Contains information regarding the grahical representation of a location.
|
| LocationRepresentation |
Common location representations.
|
| LocationTheme |
Provides a location theme.
|
| LocationType |
Describes the type of a
Location. |
| LocationType.Layout |
Contains information regarding the grahical representation of a location type.
|
| LocationTypeCreationTO |
A transfer object describing a location type in the plant model.
|
| LocationTypeCreationTO.Layout |
Contains information regarding the grahical representation of a location type.
|
| LowLevelCommunicationEvent |
Marks low-level communication events.
|
| ModelConstants |
Defines some constants used for plant models.
|
| ModelLayoutElement | Deprecated.
Will be removed in favor of dedicated layout classes in corresponding TCS data
objects.
|
| ModelLayoutElementCreationTO | Deprecated.
Will be removed in favor of dedicated layout classes in corresponding TCS data
objects.
|
| ModelTransitionEvent |
Emitted when the kernel loads a model.
|
| MovementCommand |
A command for moving a step.
|
| NotificationPublicationEvent |
Instances of this class represent events emitted by/for notifications being published.
|
| NotificationService |
Provides methods concerning
UserNotifications. |
| NullSocketFactoryProvider |
Provides
null for both client and server socket factories. |
| ObjectExistsException |
Thrown when an object was supposed to be created or renamed, but another
object with the same ID/name/attributes already exists.
|
| ObjectHistory |
A history of events related to an object.
|
| ObjectHistory.Entry |
An entry/event in a history.
|
| ObjectHistoryEntryFormatter |
A formatter for
ObjectHistory entries, mapping an entry to a user-presentable string, if
possible. |
| ObjectNameProvider | |
| ObjectPropConstants |
Defines some reserved/commonly used property keys and values.
|
| ObjectUnknownException |
Thrown when an object was supposed to be returned/removed/modified, but could
not be found.
|
| OrderCategorySuggestions | Deprecated.
Use
OrderTypeSuggestions instead. |
| OrderConstants |
Defines some constants for
TransportOrders and OrderSequences. |
| OrderSequence |
Describes a process spanning multiple
TransportOrders which are to be executed
subsequently by the same Vehicle. |
| OrderSequenceCleanupApproval |
Implementations of this interface check whether an order sequence may be removed.
|
| OrderSequenceCreationTO |
A transfer object describing a transport order.
|
| OrderTypeSuggestions |
Implementations of this class provide suggestions for transport order types.
|
| Path | |
| Path.Layout |
Contains information regarding the grahical representation of a path.
|
| Path.Layout.ConnectionType |
The connection type a path is represented as.
|
| PathCreationTO |
A transfer object describing a path in the plant model.
|
| PathCreationTO.Layout |
Contains information regarding the grahical representation of a path.
|
| PeripheralAdapterCommand |
A command a peripheral communication adapter may execute.
|
| PeripheralAttachmentEvent |
Instances of this class represent events emitted by/for attaching comm adapters.
|
| PeripheralAttachmentInformation |
Describes which communication adapter a location is currently associated with.
|
| PeripheralCommAdapter |
This interface declares the methods that a driver communicating with and controlling a
peripheral device must implement.
|
| PeripheralCommAdapterDescription |
Provides the description for a peripheral communication adapter.
|
| PeripheralCommAdapterEvent |
Instances of this class represent events emitted by/for peripheral comm adapter changes.
|
| PeripheralCommAdapterFactory |
Provides communication adapter instances for peripheral devices to be controlled.
|
| PeripheralCommAdapterPanel |
A base class for panels associated with peripheral comm adapters.
|
| PeripheralCommAdapterPanelFactory |
Provides peripheral comm adapter specific panels used for interaction and displaying information.
|
| PeripheralController |
Provides high-level methods for the system to control a peripheral device.
|
| PeripheralControllerPool |
Maintains associations between locations and peripheral controllers.
|
| PeripheralDispatcherService |
Provides methods concerning the
PeripheralJobDispatcher. |
| PeripheralInformation |
Contains details about a peripheral device a location may represent.
|
| PeripheralInformation.ProcState |
A peripheral device's processing state as seen by the peripheral job dispatcher.
|
| PeripheralInformation.State |
The elements of this enumeration describe the various possible states of a peripheral device.
|
| PeripheralJob |
Represents a job that is to be processed by a peripheral device.
|
| PeripheralJob.State |
Defines the various states a peripheral job may be in.
|
| PeripheralJobCallback |
A callback used to inform about the successful or failed completion of jobs.
|
| PeripheralJobCreationTO |
A transfer object describing a peripheral job.
|
| PeripheralJobDispatcher |
This interface declares the methods a peripheral job dispatcher module for the openTCS kernel
must implement.
|
| PeripheralJobHistoryCodes |
Defines constants for basic history event codes related to peripheral jobs and documents how the
respective supplementary information is to be interpreted.
|
| PeripheralJobService |
Provides methods concerning
PeripheralJobs. |
| PeripheralOperation |
Describes an operation that is to be executed by a peripheral device.
|
| PeripheralOperation.ExecutionTrigger |
Defines the various moments at which an operation may be executed.
|
| PeripheralOperationCreationTO |
A transfer object describing an operation to be performed by a peripheral device.
|
| PeripheralProcessModel |
A model of a peripheral device's and its communication adapter's attributes.
|
| PeripheralProcessModel.Attribute |
Used to describe what has changed in a process model.
|
| PeripheralProcessModelEvent |
Instances of this class represent events emitted by/for changes on
PeripheralProcessModels. |
| PeripheralService |
Provides methods concerning peripheral devices represented by
Locations. |
| PlantModelCreationTO |
A transfer object describing a plant model.
|
| PlantModelExporter |
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 |
Implementations provide a way to import plant model data that is read from some external source
or generated.
|
| PlantModelService |
Provides methods concerning the plant model.
|
| PluggablePanel |
Declares methods that a pluggable panel should provide for the enclosing
application.
|
| PluggablePanelFactory |
Produces plugin panels to extend an openTCS user interface.
|
| Point |
Describes a position in the driving course at which a
Vehicle may be located. |
| Point.Layout |
Contains information regarding the grahical representation of a point.
|
| Point.Type |
Describes the types of positions in a driving course.
|
| PointCreationTO |
A transfer object describing a point in the plant model.
|
| PointCreationTO.Layout |
Contains information regarding the grahical representation of a point.
|
| ProcessModelEvent |
Instances of this class represent events emitted by/for changes on
VehicleProcessModels. |
| PropertySuggestions |
Objects implementing this interface provide a set for suggested property keys and values each.
|
| Query<T> |
Marks a query (parameter) object.
|
| Query.Void |
A convenience class to be used as the result type for queries that do not return any result.
|
| QueryResponder |
A responder for generic queries.
|
| QueryService |
Provides generic/pluggable query functionality.
|
| RegistrationName |
Defines the names used for binding the remote services in the RMI registry.
|
| RemoteDispatcherService |
Declares the methods provided by the
DispatcherService via RMI. |
| RemoteKernelServicePortal |
Declares the methods provided by the
KernelServicePortal via RMI. |
| RemoteKernelServicePortalProxy |
The default implementation for the
KernelServicePortal. |
| RemoteNotificationService |
Declares the methods provided by the
NotificationService via RMI. |
| RemotePeripheralDispatcherService |
Declares the methods provided by the
PeripheralDispatcherService via RMI. |
| RemotePeripheralJobService |
Declares the methods provided by the
PeripheralJobService via RMI. |
| RemotePeripheralService |
Declares the methods provided by the
PeripheralService via RMI. |
| RemotePlantModelService |
Declares the methods provided by the
PlantModelService via RMI. |
| RemoteQueryService |
Declares the methods provided by the
QueryService via RMI. |
| RemoteQueryServiceProxy |
The default implementation of the query service.
|
| RemoteRouterService |
Declares the methods provided by the
RouterService via RMI. |
| RemoteSchedulerService |
Declares the methods provided by the
SchedulerService via RMI. |
| RemoteTCSObjectService |
Declares the methods provided by the
TCSObjectService via RMI. |
| RemoteTransportOrderService |
Declares the methods provided by the
TransportOrderService via RMI. |
| RemoteVehicleService |
Declares the methods provided by the
VehicleService via RMI. |
| ResourceAllocationException |
Thrown when allocating resources for a
Scheduler.Client is impossible. |
| Route | |
| Route.Step |
A single step in a route.
|
| Router |
This interface declares the methods a router module for the openTCS
kernel must implement.
|
| RouterService |
Provides methods concerning the
Router. |
| ScheduledApiChange |
Marks an API detail (class, method, field) that is scheduled for an incompatible change.
|
| ScheduledApiChanges |
A container annotation for
ScheduledApiChange. |
| Scheduler |
Manages resources used by clients (vehicles) to help prevent both collisions and deadlocks.
|
| Scheduler.Client |
Defines callback methods for clients of the resource scheduler.
|
| Scheduler.Module |
A scheduler module.
|
| SchedulerAllocationState |
Represents the current state of resource allocations.
|
| SchedulerService |
Provides methods concerning the
Scheduler. |
| SecureSocketFactoryProvider |
Provides instances of
RMIClientSocketFactory and RMIServerSocketFactory that are
implemented over the SSL or TLS protocols. |
| ServiceCallWrapper |
Annotation type to mark an injectable
CallWrapper that wraps method calls on kernel
services. |
| ServiceListener |
Provides callback methods for instances interested in service updates.
|
| ServiceUnavailableException |
Thrown when a (remote) service is not available for processing a request.
|
| SetSpeedMultiplier |
A message that informs a communication adapter about a speed multiplier it/the vehicle should
apply.
|
| ShapeLayoutElement | Deprecated.
Will be removed.
|
| ShapeLayoutElementCreationTO | Deprecated. |
| SharedKernelServicePortal |
Provides access to a shared
KernelServicePortal instance. |
| SharedKernelServicePortalProvider |
Pools access to a
KernelServicePortal instance for multiple clients. |
| SimpleEventBus |
A plain implementation of
EventBus. |
| SimVehicleCommAdapter |
This interface declares methods that a vehicle driver intended for simulation
must implement.
|
| SocketFactoryProvider |
A provider for instances of
RMIClientSocketFactory and RMIServerSocketFactory. |
| SslParameterSet |
A set of parameters to be used for SSL-encrypted socket connections.
|
| TCSObject<E extends TCSObject<E>> |
Describes the base behaviour of TCS data objects.
|
| TCSObjectEvent |
Instances of this class represent events emitted by/for business objects.
|
| TCSObjectEvent.Type |
Indicates the type of an event, which can be helpful with filtering events.
|
| TCSObjectReference<E extends TCSObject<E>> |
A transient reference to a
TCSObject. |
| TCSObjectService |
Provides methods concerning
TCSObjects. |
| TCSResource<E extends TCSResource<E>> |
Describes a resource that
Vehicles may claim for exclusive usage. |
| TCSResourceReference<E extends TCSResource<E>> |
A transient reference to a
TCSResource. |
| TransportOrder |
Represents a sequence of movements and operations that are to be executed by a
Vehicle. |
| TransportOrder.State |
This enumeration defines the various states a transport order may be in.
|
| TransportOrderCleanupApproval |
Implementations of this interface check whether a transport order may be removed.
|
| TransportOrderCreationTO |
A transfer object describing a transport order.
|
| TransportOrderHistoryCodes |
Defines constants for basic history event codes related to transport orders and documents how the
respective supplementary information is to be interpreted.
|
| TransportOrderService |
Provides methods concerning
TransportOrders and OrderSequences. |
| Triple |
A generic 3-tuple of long integer values, usable for 3D coordinates and vectors, for instance.
|
| UserNotification |
A notification to be read by a user.
|
| UserNotification.Level |
Defines the possible message types.
|
| Vehicle |
Describes a vehicle's current state.
|
| Vehicle.IntegrationLevel |
A vehicle's state of integration into the system.
|
| Vehicle.Layout |
Contains information regarding the grahical representation of a vehicle.
|
| Vehicle.Orientation |
The elements of this enumeration represent the possible orientations of a
vehicle.
|
| Vehicle.ProcState |
A vehicle's processing state as seen by the dispatcher.
|
| Vehicle.State |
The elements of this enumeration describe the various possible states of a
vehicle.
|
| VehicleCommAdapter |
This interface declares the methods that a driver communicating with and
controlling a physical vehicle must implement.
|
| VehicleCommAdapterDescription |
Provides the description for a vehicle comm adapter.
|
| VehicleCommAdapterEvent |
An event emitted by a communication adapter.
|
| VehicleCommAdapterFactory |
Provides communication adapter instances for vehicles to be controlled.
|
| VehicleCommAdapterPanel |
A base class for panels associated with comm adapters.
|
| VehicleCommAdapterPanelFactory |
Provides comm adapter specific panels used for interaction and displaying information.
|
| VehicleController |
Provides high-level methods for the kernel to control a vehicle.
|
| VehicleControllerPool |
Maintains associations between vehicles and vehicle controllers.
|
| VehicleCreationTO |
A transfer object describing a block in the plant model.
|
| VehicleCreationTO.Layout |
Contains information regarding the grahical representation of a vehicle.
|
| VehicleProcessModel |
An observable model of a vehicle's and its comm adapter's attributes.
|
| VehicleProcessModel.Attribute |
Notification arguments to indicate some change.
|
| VehicleProcessModel.PropertyUpdate |
A notification object sent to observers to indicate a change of a property.
|
| VehicleProcessModel.TransportOrderPropertyUpdate |
A notification object sent to observers to indicate a change of a transport order's property.
|
| VehicleProcessModel.VehiclePropertyUpdate |
A notification object sent to observers to indicate a change of a vehicle's property.
|
| VehicleProcessModelTO |
A serializable representation of a
VehicleProcessModel. |
| VehicleService |
Provides methods concerning
Vehicles. |
| VehicleTheme |
Provides a vehicle theme.
|
| VisualLayout |
Describes the visual attributes of a model.
|
| VisualLayoutCreationTO |
A transfer object describing a visual layout in the plant model.
|