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.
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.Type	Describes the types of blocks in a driving course.
BlockCreationTO	A transfer object describing a block in the plant model.
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.
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.
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	An aggregation of model elements.
GroupCreationTO	A transfer object describing a group in the plant model.
ImageData	Generic image data that can be stored along with a layout.
ImageLayoutElement	A layout element describing an image to be displayed.
InitPositionCommand	A command for initializing the comm adapter's position.
InternalPlantModelService	Declares the methods the plant model service must provide which are 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.
LayoutElement	A generic layout element that is to be displayed.
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.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.
LocationRepresentation	Common location representations.
LocationTheme	Provides a location theme.
LocationType	Describes the type of a Location.
LocationTypeCreationTO	A transfer object describing a location type in the plant model.
ModelLayoutElement	A layout element describing the way in which a model element is to be displayed.
ModelLayoutElementCreationTO	A transfer object describing a model layout element in the visual layout.
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	Describes a connection between two Points which a Vehicle may traverse.
PathCreationTO	A transfer object describing a path in the plant model.
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.Type	Describes the types of positions in a driving course.
PointCreationTO	A transfer object describing a point in the plant model.
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.
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.
RemotePlantModelService	Declares the methods provided by the PlantModelService via RMI.
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	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.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	A Scheduler manages resources used by vehicles, preventing 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	A layout element describing a geometrical shape to be displayed.
ShapeLayoutElementCreationTO	A transfer object describing a shape layout element in the visual layout.
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.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 system to control a vehicle.
VehicleControllerPool	Maintains associations between vehicles and vehicle controllers.
VehicleCreationTO	A transfer object describing a block in the plant model.
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.