Serialized Form

Package org.opentcs.access

Class org.opentcs.access.CredentialsException extends KernelRuntimeException implements Serializable

Class org.opentcs.access.KernelException extends java.lang.Exception implements Serializable

Class org.opentcs.access.KernelRuntimeException extends java.lang.RuntimeException implements Serializable

Class org.opentcs.access.KernelStateTransitionEvent extends java.lang.Object implements Serializable

Serialized Fields

enteredState

Kernel.State enteredState

The new state the kernel is in transition to.

leftState

Kernel.State leftState

The old state the kernel is leaving.

transitionFinished

boolean transitionFinished

Whether the transition to the entered state is finished or not.

Class org.opentcs.access.ModelTransitionEvent extends java.lang.Object implements Serializable

Serialized Fields

modelContentChanged

boolean modelContentChanged

Whether the content of the model actually changed with the transition.

newModelName

java.lang.String newModelName

The new model the kernel is in transition to.

oldModelName

java.lang.String oldModelName

The old model the kernel is leaving.

transitionFinished

boolean transitionFinished

Whether the transition to the entered state is finished or not.

Class org.opentcs.access.NotificationPublicationEvent extends java.lang.Object implements Serializable

Serialized Fields

notification

UserNotification notification

The published message.

Class org.opentcs.access.SchedulerAllocationState extends java.lang.Object implements Serializable

Serialized Fields

allocationStates

java.util.Map<java.lang.String,java.util.Set<TCSResource<?>>> allocationStates

Deprecated.

The current state of allocations.

Class org.opentcs.access.SslParameterSet extends java.lang.Object implements Serializable

Serialized Fields

keystoreFile

java.io.File keystoreFile

The file path of the keystore.

keystorePassword

java.lang.String keystorePassword

The password for the keystore file.

keystoreType

java.lang.String keystoreType

The type used for keystore and truststore.

truststoreFile

java.io.File truststoreFile

The file path of the truststore.

truststorePassword

java.lang.String truststorePassword

The password for the truststore file.

Package org.opentcs.access.rmi

Class org.opentcs.access.rmi.ClientID extends java.lang.Object implements Serializable

Serialized Fields

clientName

java.lang.String clientName

The client's name.

uuid

java.util.UUID uuid

The client's UUID.

Package org.opentcs.access.to

Class org.opentcs.access.to.CreationTO extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name of this transfer object.

properties

java.util.Map<java.lang.String,java.lang.String> properties

The properties of this transfer object.

Package org.opentcs.access.to.model

Class org.opentcs.access.to.model.BlockCreationTO extends CreationTO implements Serializable

Serialized Fields

layout

BlockCreationTO.Layout layout

The information regarding the grahical representation of this block.

memberNames

java.util.Set<java.lang.String> memberNames

This block's member names.

type

Block.Type type

This block's type.

Class org.opentcs.access.to.model.BlockCreationTO.Layout extends java.lang.Object implements Serializable

Serialized Fields

color

java.awt.Color color

The color in which block elements are to be emphasized.

Class org.opentcs.access.to.model.GroupCreationTO extends CreationTO implements Serializable

Serialized Fields

memberNames

java.util.Set<java.lang.String> memberNames

Deprecated.

This group's member names.

Class org.opentcs.access.to.model.LocationCreationTO extends CreationTO implements Serializable

Serialized Fields

layout

LocationCreationTO.Layout layout

The information regarding the grahical representation of this location.

links

java.util.Map<java.lang.String,java.util.Set<java.lang.String>> links

The links attaching points to this location. This is a map of point names to allowed operations.

locked

boolean locked

A flag for marking this location as locked (i.e. to prevent vehicles from using it).

position

Triple position

This location's position (in mm).

typeName

java.lang.String typeName

The name of this location's type.

Class org.opentcs.access.to.model.LocationCreationTO.Layout extends java.lang.Object implements Serializable

Serialized Fields

labelOffset

Couple labelOffset

The offset of the label's position to the location's position (in lu).

layerId

int layerId

The ID of the layer on which the location is to be drawn.

locationRepresentation

LocationRepresentation locationRepresentation

The location representation to use.

position

Couple position

The coordinates at which the location is to be drawn (in mm).

Class org.opentcs.access.to.model.LocationTypeCreationTO extends CreationTO implements Serializable

Serialized Fields

allowedOperations

java.util.List<java.lang.String> allowedOperations

The allowed operations for this location type.

allowedPeripheralOperations

java.util.List<java.lang.String> allowedPeripheralOperations

The allowed peripheral operations for this location type.

layout

LocationTypeCreationTO.Layout layout

The information regarding the grahical representation of this location type.

Class org.opentcs.access.to.model.LocationTypeCreationTO.Layout extends java.lang.Object implements Serializable

Serialized Fields

locationRepresentation

LocationRepresentation locationRepresentation

The location representation to use for locations with this location type.

Class org.opentcs.access.to.model.ModelLayoutElementCreationTO extends CreationTO implements Serializable

Serialized Fields

layer

int layer

Deprecated.

The layer on which this model layout element is to be displayed.

Class org.opentcs.access.to.model.PathCreationTO extends CreationTO implements Serializable

Serialized Fields

destPointName

java.lang.String destPointName

The point name this path ends in.

layout

PathCreationTO.Layout layout

The information regarding the grahical representation of this path.

length

long length

This path's length (in mm).

locked

boolean locked

A flag for marking this path as locked (i.e. to prevent vehicles from using it).

maxReverseVelocity

int maxReverseVelocity

The absolute maximum allowed reverse velocity on this path (in mm/s). A value of 0 (default) means reverse movement is not allowed on this path.

maxVelocity

int maxVelocity

The absolute maximum allowed forward velocity on this path (in mm/s). A value of 0 (default) means forward movement is not allowed on this path.

peripheralOperations

java.util.List<PeripheralOperationCreationTO> peripheralOperations

The peripheral operations to be performed when a vehicle travels along this path.

srcPointName

java.lang.String srcPointName

The point name this path originates in.

vehicleEnvelopes

java.util.Map<java.lang.String,Envelope> vehicleEnvelopes

A map of envelope keys to envelopes that vehicles traversing this path may occupy.

Class org.opentcs.access.to.model.PathCreationTO.Layout extends java.lang.Object implements Serializable

Serialized Fields

connectionType

Path.Layout.ConnectionType connectionType

The connection type the path is represented as.

controlPoints

java.util.List<Couple> controlPoints

Control points describing the way the path is drawn (if the connection type is Path.Layout.ConnectionType.BEZIER, Path.Layout.ConnectionType.BEZIER_3 or Path.Layout.ConnectionType.POLYPATH).

layerId

int layerId

The ID of the layer on which the path is to be drawn.

Class org.opentcs.access.to.model.PlantModelCreationTO extends CreationTO implements Serializable

Serialized Fields

blocks

java.util.List<BlockCreationTO> blocks

The plant model's blocks.

groups

java.util.List<GroupCreationTO> groups

Deprecated.

The plant model's groups.

locations

java.util.List<LocationCreationTO> locations

The plant model's locations.

locationTypes

java.util.List<LocationTypeCreationTO> locationTypes

The plant model's location types.

paths

java.util.List<PathCreationTO> paths

The plant model's paths.

points

java.util.List<PointCreationTO> points

The plant model's points.

vehicles

java.util.List<VehicleCreationTO> vehicles

The plant model's vehicles.

visualLayouts

java.util.List<VisualLayoutCreationTO> visualLayouts

The plant model's visual layouts.

Class org.opentcs.access.to.model.PointCreationTO extends CreationTO implements Serializable

Serialized Fields

layout

PointCreationTO.Layout layout

The information regarding the grahical representation of this point.

pose

Pose pose

The pose of the vehicle at this point.

type

Point.Type type

This point's type.

vehicleEnvelopes

java.util.Map<java.lang.String,Envelope> vehicleEnvelopes

A map of envelope keys to envelopes that vehicles located at this point may occupy.

Class org.opentcs.access.to.model.PointCreationTO.Layout extends java.lang.Object implements Serializable

Serialized Fields

labelOffset

Couple labelOffset

The offset of the label's position to the point's position (in lu).

layerId

int layerId

The ID of the layer on which the point is to be drawn.

position

Couple position

The coordinates at which the point is to be drawn (in mm).

Class org.opentcs.access.to.model.ShapeLayoutElementCreationTO extends CreationTO implements Serializable

Serialized Fields

layer

int layer

Deprecated.

The layer on which this shape layout element is to be displayed.

Class org.opentcs.access.to.model.VehicleCreationTO extends CreationTO implements Serializable

Serialized Fields

energyLevelCritical

int energyLevelCritical

The energy level value at/below which the vehicle should be recharged.

energyLevelFullyRecharged

int energyLevelFullyRecharged

The energy level value at/above which the vehicle is considered fully recharged.

energyLevelGood

int energyLevelGood

The energy level value at/above which the vehicle can be dispatched again when charging.

energyLevelSufficientlyRecharged

int energyLevelSufficientlyRecharged

The energy level value at/above which the vehicle is considered sufficiently recharged.

envelopeKey

java.lang.String envelopeKey

The key for selecting the envelope to be used for resources the vehicle occupies.

layout

VehicleCreationTO.Layout layout

The information regarding the grahical representation of this vehicle.

length

int length

The vehicle's length (in mm).

maxReverseVelocity

int maxReverseVelocity

The vehicle's maximum reverse velocity (in mm/s).

maxVelocity

int maxVelocity

The vehicle's maximum velocity (in mm/s).

Class org.opentcs.access.to.model.VehicleCreationTO.Layout extends java.lang.Object implements Serializable

Serialized Fields

routeColor

java.awt.Color routeColor

The color in which vehicle routes are to be emphasized.

Class org.opentcs.access.to.model.VisualLayoutCreationTO extends CreationTO implements Serializable

Serialized Fields

layerGroups

java.util.List<LayerGroup> layerGroups

The layout's layer groups.

layers

java.util.List<Layer> layers

This layout's layers.

modelElements

java.util.List<ModelLayoutElementCreationTO> modelElements

Deprecated.

This layout's model layout elements.

scaleX

double scaleX

This layout's scale on the X axis (in mm/pixel).

scaleY

double scaleY

This layout's scale on the Y axis (in mm/pixel).

shapeElements

java.util.List<ShapeLayoutElementCreationTO> shapeElements

Deprecated.

This layout's shape layout elements.

Package org.opentcs.access.to.order

Class org.opentcs.access.to.order.DestinationCreationTO extends CreationTO implements Serializable

Serialized Fields

destLocationName

java.lang.String destLocationName

The name of the destination location (or point).

destOperation

java.lang.String destOperation

The operation to be performed at the destination.

Class org.opentcs.access.to.order.OrderSequenceCreationTO extends CreationTO implements Serializable

Serialized Fields

failureFatal

boolean failureFatal

Whether failure of one transport order in the sequence makes subsequent ones fail, too.

incompleteName

boolean incompleteName

Indicates whether the name is incomplete and requires to be completed when creating the actual order sequence. (How exactly this is done is decided by the kernel.)

intendedVehicleName

java.lang.String intendedVehicleName

The (optional) name of the vehicle that is supposed to execute the transport order.

type

java.lang.String type

The type of the order sequence.

Class org.opentcs.access.to.order.TransportOrderCreationTO extends CreationTO implements Serializable

Serialized Fields

deadline

java.time.Instant deadline

The point of time at which execution of the transport order is supposed to be finished.

dependencyNames

java.util.Set<java.lang.String> dependencyNames

The (optional) names of transport orders the transport order depends on.

destinations

java.util.List<DestinationCreationTO> destinations

The destinations that need to be travelled to.

dispensable

boolean dispensable

Whether the transport order is dispensable or not.

incompleteName

boolean incompleteName

Indicates whether the name is incomplete and requires to be completed when creating the actual transport order. (How exactly this is done is decided by the kernel.)

intendedVehicleName

java.lang.String intendedVehicleName

The (optional) name of the vehicle that is supposed to execute the transport order.

peripheralReservationToken

java.lang.String peripheralReservationToken

An optional token for reserving peripheral devices while processing this transport order.

type

java.lang.String type

The type of the transport order.

wrappingSequence

java.lang.String wrappingSequence

The (optional) name of the order sequence the transport order belongs to.

Package org.opentcs.access.to.peripherals

Class org.opentcs.access.to.peripherals.PeripheralJobCreationTO extends CreationTO implements Serializable

Serialized Fields

incompleteName

boolean incompleteName

Indicates whether the name is incomplete and requires to be completed when creating the actual peripheral job. (How exactly this is done is decided by the kernel.)

peripheralOperation

PeripheralOperationCreationTO peripheralOperation

The operation that is to be perfromed by the pripheral device.

relatedTransportOrderName

java.lang.String relatedTransportOrderName

The name of the transport order for which this peripheral job is to be created.

relatedVehicleName

java.lang.String relatedVehicleName

The name of the vehicle for which this peripheral job is to be created.

reservationToken

java.lang.String reservationToken

A token that may be used to reserve a peripheral device. A peripheral device that is reserved for a specific token can only process jobs which match that reservation token. This string may not be empty.

Class org.opentcs.access.to.peripherals.PeripheralOperationCreationTO extends CreationTO implements Serializable

Serialized Fields

completionRequired

boolean completionRequired

Whether the completion of this operation is required to allow a vehicle to continue driving.

executionTrigger

PeripheralOperation.ExecutionTrigger executionTrigger

The moment at which this operation is to be performed.

locationName

java.lang.String locationName

The name of the location the peripheral device is associated with.

operation

java.lang.String operation

The operation to be performed by the peripheral device.

Package org.opentcs.components.kernel

Class org.opentcs.components.kernel.Query.Void extends java.lang.Object implements Serializable

Class org.opentcs.components.kernel.ResourceAllocationException extends KernelException implements Serializable

Package org.opentcs.components.kernel.dipatching

Class org.opentcs.components.kernel.dipatching.TransportOrderAssignmentException extends KernelRuntimeException implements Serializable

Serialized Fields

transportOrder

TCSObjectReference<TransportOrder> transportOrder

transportOrderAssignmentVeto

TransportOrderAssignmentVeto transportOrderAssignmentVeto

vehicle

TCSObjectReference<Vehicle> vehicle

Package org.opentcs.components.kernel.services

Class org.opentcs.components.kernel.services.ServiceUnavailableException extends KernelRuntimeException implements Serializable

Package org.opentcs.components.kernelcontrolcenter

Class org.opentcs.components.kernelcontrolcenter.ControlCenterPanel extends javax.swing.JPanel implements Serializable

Package org.opentcs.components.plantoverview

Class org.opentcs.components.plantoverview.PluggablePanel extends javax.swing.JPanel implements Serializable

Package org.opentcs.configuration

Class org.opentcs.configuration.ConfigurationException extends java.lang.RuntimeException implements Serializable

Package org.opentcs.data

Class org.opentcs.data.ObjectExistsException extends KernelRuntimeException implements Serializable

Class org.opentcs.data.ObjectHistory extends java.lang.Object implements Serializable

Serialized Fields

entries

java.util.List<ObjectHistory.Entry> entries

The actual history entries.

Class org.opentcs.data.ObjectHistory.Entry extends java.lang.Object implements Serializable

Serialized Fields

eventCode

java.lang.String eventCode

A code identifying the event that occured.

supplement

java.lang.Object supplement

Supplementary information about the event. How this information is to be interpreted (if at all) depends on the respective event code.

timestamp

java.time.Instant timestamp

The point of time at which the event occured.

Class org.opentcs.data.ObjectUnknownException extends KernelRuntimeException implements Serializable

Class org.opentcs.data.TCSObject extends java.lang.Object implements Serializable

Serialized Fields

history

ObjectHistory history

A history of events related to this object.

name

java.lang.String name

The name of the business object.

properties

java.util.Map<java.lang.String,java.lang.String> properties

A set of properties (key-value pairs) associated with this object.

propertiesReadOnly

java.util.Map<java.lang.String,java.lang.String> propertiesReadOnly

An unmodifiable view on this object's properties. This mainly exists for TCSObject.getProperties(), as the alternative of creating ad-hoc copies or unmodifiable views can lead to performance issues related to garbage collection in situations where TCSObject.getProperties() is called often.

reference

TCSObjectReference<E extends TCSObject<E>> reference

A transient reference to this business object.

Class org.opentcs.data.TCSObjectEvent extends java.lang.Object implements Serializable

Serialized Fields

currentObjectState

TCSObject<?> currentObjectState

The current state of the object for which this event was created.

previousObjectState

TCSObject<?> previousObjectState

The previous state of the object for which this event was created.

type

TCSObjectEvent.Type type

This event's type.

Class org.opentcs.data.TCSObjectReference extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The referenced object's name.

referentClass

java.lang.Class<?> referentClass

The referenced object's class.

Package org.opentcs.data.model

Class org.opentcs.data.model.Block extends TCSResource<Block> implements Serializable

Serialized Fields

layout

Block.Layout layout

The information regarding the grahical representation of this block.

members

java.util.Set<TCSResourceReference<?>> members

The resources aggregated in this block.

type

Block.Type type

This block's type.

Class org.opentcs.data.model.Block.Layout extends java.lang.Object implements Serializable

Serialized Fields

color

java.awt.Color color

The color in which block elements are to be emphasized.

Class org.opentcs.data.model.Couple extends java.lang.Object implements Serializable

Serialized Fields

x

long x

The X coordinate.

y

long y

The Y coordinate.

Class org.opentcs.data.model.Envelope extends java.lang.Object implements Serializable

Serialized Fields

vertices

java.util.List<Couple> vertices

Class org.opentcs.data.model.Group extends TCSObject<Group> implements Serializable

Serialized Fields

members

java.util.Set<TCSObjectReference<?>> members

Deprecated.

The model elements aggregated in this group.

Class org.opentcs.data.model.Location extends TCSResource<Location> implements Serializable

Serialized Fields

attachedLinks

java.util.Set<Location.Link> attachedLinks

A set of links attached to this location.

layout

Location.Layout layout

The information regarding the grahical representation of this location.

locked

boolean locked

A flag for marking this location as locked (i.e. to prevent transport orders leading to it from being assigned to vehicles).

peripheralInformation

PeripheralInformation peripheralInformation

Details about the peripheral devices this location may represent.

position

Triple position

This location's position in mm.

type

TCSObjectReference<LocationType> type

A reference to this location's type.

Class org.opentcs.data.model.Location.Layout extends java.lang.Object implements Serializable

Serialized Fields

labelOffset

Couple labelOffset

The offset of the label's position to the location's position (in lu).

layerId

int layerId

The ID of the layer on which the location is to be drawn.

locationRepresentation

LocationRepresentation locationRepresentation

The location representation to use.

position

Couple position

The coordinates at which the location is to be drawn (in mm).

Class org.opentcs.data.model.Location.Link extends java.lang.Object implements Serializable

Serialized Fields

allowedOperations

java.util.Set<java.lang.String> allowedOperations

The operations allowed at this link.

location

TCSResourceReference<Location> location

A reference to the location end of this link.

point

TCSResourceReference<Point> point

A reference to the point end of this link.

Class org.opentcs.data.model.LocationType extends TCSObject<LocationType> implements Serializable

Serialized Fields

allowedOperations

java.util.List<java.lang.String> allowedOperations

The operations allowed at locations of this type.

allowedPeripheralOperations

java.util.List<java.lang.String> allowedPeripheralOperations

The peripheral operations allowed at locations of this type.

layout

LocationType.Layout layout

The information regarding the grahical representation of this location type.

Class org.opentcs.data.model.LocationType.Layout extends java.lang.Object implements Serializable

Serialized Fields

locationRepresentation

LocationRepresentation locationRepresentation

The location representation to use for locations with this location type.

Class org.opentcs.data.model.Path extends TCSResource<Path> implements Serializable

Serialized Fields

destinationPoint

TCSObjectReference<Point> destinationPoint

A reference to the point which this point ends in.

layout

Path.Layout layout

The information regarding the grahical representation of this path.

length

long length

The length of this path (in mm).

locked

boolean locked

A flag for marking this path as locked (i.e. to prevent vehicles from using it).

maxReverseVelocity

int maxReverseVelocity

The absolute maximum allowed reverse velocity on this path (in mm/s). A value of 0 (default) means reverse movement is not allowed on this path.

maxVelocity

int maxVelocity

The absolute maximum allowed forward velocity on this path (in mm/s). A value of 0 (default) means forward movement is not allowed on this path.

peripheralOperations

java.util.List<PeripheralOperation> peripheralOperations

The peripheral operations to be performed when a vehicle travels along this path.

sourcePoint

TCSObjectReference<Point> sourcePoint

A reference to the point which this point originates in.

vehicleEnvelopes

java.util.Map<java.lang.String,Envelope> vehicleEnvelopes

A map of envelope keys to envelopes that vehicles traversing this path may occupy.

Class org.opentcs.data.model.Path.Layout extends java.lang.Object implements Serializable

Serialized Fields

connectionType

Path.Layout.ConnectionType connectionType

The connection type the path is represented as.

controlPoints

java.util.List<Couple> controlPoints

Control points describing the way the path is drawn (if the connection type is Path.Layout.ConnectionType.BEZIER, Path.Layout.ConnectionType.BEZIER_3 or Path.Layout.ConnectionType.POLYPATH).

layerId

int layerId

The ID of the layer on which the path is to be drawn.

Class org.opentcs.data.model.PeripheralInformation extends java.lang.Object implements Serializable

Serialized Fields

peripheralJob

TCSObjectReference<PeripheralJob> peripheralJob

A reference to the peripheral job this peripheral device is currently processing.

procState

PeripheralInformation.ProcState procState

This peripheral device's current processing state.

reservationToken

java.lang.String reservationToken

A token for which a location/peripheral device is currently reserved.

state

PeripheralInformation.State state

This peripheral device's current state.

Class org.opentcs.data.model.PlantModel extends java.lang.Object implements Serializable

Serialized Fields

blocks

java.util.Set<Block> blocks

locations

java.util.Set<Location> locations

locationTypes

java.util.Set<LocationType> locationTypes

name

java.lang.String name

paths

java.util.Set<Path> paths

points

java.util.Set<Point> points

properties

java.util.Map<java.lang.String,java.lang.String> properties

vehicles

java.util.Set<Vehicle> vehicles

visualLayouts

java.util.Set<VisualLayout> visualLayouts

Class org.opentcs.data.model.Point extends TCSResource<Point> implements Serializable

Serialized Fields

attachedLinks

java.util.Set<Location.Link> attachedLinks

A set of links attached to this point.

incomingPaths

java.util.Set<TCSObjectReference<Path>> incomingPaths

A set of references to paths ending in this point.

layout

Point.Layout layout

The information regarding the grahical representation of this point.

occupyingVehicle

TCSObjectReference<Vehicle> occupyingVehicle

A reference to the vehicle occupying this point.

outgoingPaths

java.util.Set<TCSObjectReference<Path>> outgoingPaths

A set of references to paths originating in this point.

pose

Pose pose

The pose of the vehicle at this point.

type

Point.Type type

This point's type.

vehicleEnvelopes

java.util.Map<java.lang.String,Envelope> vehicleEnvelopes

A map of envelope keys to envelopes that vehicles located at this point may occupy.

Class org.opentcs.data.model.Point.Layout extends java.lang.Object implements Serializable

Serialized Fields

labelOffset

Couple labelOffset

The offset of the label's position to the point's position (in lu).

layerId

int layerId

The ID of the layer on which the point is to be drawn.

position

Couple position

The coordinates at which the point is to be drawn (in mm).

Class org.opentcs.data.model.Pose extends java.lang.Object implements Serializable

Serialized Fields

orientationAngle

double orientationAngle

The orientation angle in degrees (-360..360). May be Double.NaN if unknown/undefined.

position

Triple position

The position/coordinates in mm.

Class org.opentcs.data.model.TCSResource extends TCSObject<E extends TCSResource<E>> implements Serializable

Class org.opentcs.data.model.TCSResourceReference extends TCSObjectReference<E extends TCSResource<E>> implements Serializable

Class org.opentcs.data.model.Triple extends java.lang.Object implements Serializable

Serialized Fields

x

long x

The X coordinate.

y

long y

The Y coordinate.

z

long z

The Z coordinate.

Class org.opentcs.data.model.Vehicle extends TCSObject<Vehicle> implements Serializable

Serialized Fields

allocatedResources

java.util.List<java.util.Set<TCSResourceReference<?>>> allocatedResources

The resources this vehicle has allocated.

allowedOrderTypes

java.util.Set<java.lang.String> allowedOrderTypes

The set of transport order types this vehicle is allowed to process.

claimedResources

java.util.List<java.util.Set<TCSResourceReference<?>>> claimedResources

The resources this vehicle has claimed for future allocation.

currentPosition

TCSObjectReference<Point> currentPosition

A reference to the point which this vehicle currently occupies.

energyLevel

int energyLevel

This vehicle's remaining energy (in percent of the maximum).

energyLevelCritical

int energyLevelCritical

The value at/below which the vehicle's energy level is considered "critical".

energyLevelFullyRecharged

int energyLevelFullyRecharged

The value at/above which the vehicle's energy level is considered fully recharged.

energyLevelGood

int energyLevelGood

The value at/above which the vehicle's energy level is considered "good".

energyLevelSufficientlyRecharged

int energyLevelSufficientlyRecharged

The value at/above which the vehicle's energy level is considered sufficiently recharged.

envelopeKey

java.lang.String envelopeKey

The key for selecting the envelope to be used for resources the vehicle occupies.

integrationLevel

Vehicle.IntegrationLevel integrationLevel

This vehicle's integration level.

layout

Vehicle.Layout layout

The information regarding the grahical representation of this vehicle.

length

int length

This vehicle's length (in mm).

loadHandlingDevices

java.util.List<LoadHandlingDevice> loadHandlingDevices

The current (state of the) load handling devices of this vehicle.

maxReverseVelocity

int maxReverseVelocity

This vehicle's maximum reverse velocity (in mm/s).

maxVelocity

int maxVelocity

This vehicle's maximum velocity (in mm/s).

nextPosition

TCSObjectReference<Point> nextPosition

A reference to the point which this vehicle is expected to be seen at next.

orderSequence

TCSObjectReference<OrderSequence> orderSequence

A reference to the order sequence this vehicle is currently processing.

orientationAngle

double orientationAngle

The vehicle's current orientation angle (-360..360). Set to Double.NaN if the vehicle hasn't provided an orientation angle.

paused

boolean paused

Whether this vehicle is currently paused.

precisePosition

Triple precisePosition

The vehicle's precise position in world coordinates [mm], independent from logical positions/point names. Set to null if the vehicle hasn't provided a precise position.

procState

Vehicle.ProcState procState

This vehicle's current processing state.

rechargeOperation

java.lang.String rechargeOperation

The operation the vehicle's current communication adapter accepts as a command to recharge the vehicle.

routeProgressIndex

int routeProgressIndex

The index of the last route step travelled for the current drive order of the current transport order.

state

Vehicle.State state

This vehicle's current state.

transportOrder

TCSObjectReference<TransportOrder> transportOrder

A reference to the transport order this vehicle is currently processing.

Class org.opentcs.data.model.Vehicle.Layout extends java.lang.Object implements Serializable

Serialized Fields

routeColor

java.awt.Color routeColor

The color in which vehicle routes are to be emphasized.

Package org.opentcs.data.model.visualization

Class org.opentcs.data.model.visualization.ImageData extends java.lang.Object implements Serializable

Serialized Fields

content

byte[] content

Deprecated.

The binary data describing the actual image.

contentFormat

java.lang.String contentFormat

Deprecated.

The type of image. Examples for possible values: "SVG", "WMF", "PNG", "JPEG".

label

java.lang.String label

Deprecated.

A label/name for this image.

Class org.opentcs.data.model.visualization.ImageLayoutElement extends LayoutElement implements Serializable

Serialized Fields

imageData

ImageData imageData

Deprecated.

The image to be displayed.

Class org.opentcs.data.model.visualization.Layer extends java.lang.Object implements Serializable

Serialized Fields

groupId

int groupId

The ID of the layer group this layer is assigned to.

id

int id

The unique ID of this layer.

name

java.lang.String name

The name of this layer.

ordinal

int ordinal

The ordinal of this layer. Layers with a higher ordinal are positioned above layers with a lower ordinal.

visible

boolean visible

Whether this layer is visible or not.

Class org.opentcs.data.model.visualization.LayerGroup extends java.lang.Object implements Serializable

Serialized Fields

id

int id

The unique ID of this layer group.

name

java.lang.String name

The name of this layer group.

visible

boolean visible

Whether this layer group is visible or not.

Class org.opentcs.data.model.visualization.LayoutElement extends java.lang.Object implements Serializable

Serialized Fields

layer

int layer

Deprecated.

The layer on which this layout element is to be displayed.

properties

java.util.Map<java.lang.String,java.lang.String> properties

Deprecated.

A set of generic key-value pairs associated with this layout element.

Class org.opentcs.data.model.visualization.ModelLayoutElement extends LayoutElement implements Serializable

Serialized Fields

visualizedObject

TCSObjectReference<?> visualizedObject

Deprecated.

The model object to be visualized.

Class org.opentcs.data.model.visualization.ShapeLayoutElement extends LayoutElement implements Serializable

Class org.opentcs.data.model.visualization.VisualLayout extends TCSObject<VisualLayout> implements Serializable

Serialized Fields

layerGroups

java.util.List<LayerGroup> layerGroups

The layer groups in this model.

layers

java.util.List<Layer> layers

The layers in this model.

layoutElements

java.util.Set<LayoutElement> layoutElements

Deprecated.

VisualLayout elements describing the visualization of a model and additional elements that need to be displayed.

scaleX

double scaleX

This layout's scale on the X axis (in mm/pixel).

scaleY

double scaleY

This layout's scale on the Y axis (in mm/pixel).

Package org.opentcs.data.notification

Class org.opentcs.data.notification.UserNotification extends java.lang.Object implements Serializable

Serialized Fields

level

UserNotification.Level level

This message's type.

source

java.lang.String source

An identifier of the notification's source.

text

java.lang.String text

This message's text.

timestamp

java.time.Instant timestamp

This message's creation timestamp.

Package org.opentcs.data.order

Class org.opentcs.data.order.DriveOrder extends java.lang.Object implements Serializable

Serialized Fields

destination

DriveOrder.Destination destination

This drive order's destination.

route

Route route

This drive order's route.

state

DriveOrder.State state

This drive order's current state.

transportOrder

TCSObjectReference<TransportOrder> transportOrder

A back-reference to the transport order this drive order belongs to.

Class org.opentcs.data.order.DriveOrder.Destination extends java.lang.Object implements Serializable

Serialized Fields

destination

TCSObjectReference<?> destination

The actual destination (point or location).

operation

java.lang.String operation

The operation to be performed at the destination location.

properties

java.util.Map<java.lang.String,java.lang.String> properties

Properties of this destination. May contain parameters for the operation, for instance.

Class org.opentcs.data.order.OrderSequence extends TCSObject<OrderSequence> implements Serializable

Serialized Fields

complete

boolean complete

Indicates whether this order sequence is complete and will not be extended by more orders.

failureFatal

boolean failureFatal

Indicates whether the failure of one order in this sequence is fatal to all subsequent orders.

finished

boolean finished

Indicates whether this order sequence has been processed completely.

finishedIndex

int finishedIndex

The index of the order that was last finished in the sequence. -1 if none was finished, yet.

intendedVehicle

TCSObjectReference<Vehicle> intendedVehicle

The vehicle that is intended to process this order sequence. If this sequence is free to be processed by any vehicle, this is null.

orders

java.util.List<TCSObjectReference<TransportOrder>> orders

Transport orders belonging to this sequence that still need to be processed.

processingVehicle

TCSObjectReference<Vehicle> processingVehicle

The vehicle processing this order sequence, or null, if no vehicle has been assigned to it, yet.

type

java.lang.String type

The type of this order sequence. An order sequence and all transport orders it contains share the same type.

Class org.opentcs.data.order.Route extends java.lang.Object implements Serializable

Serialized Fields

costs

long costs

The costs for travelling this route.

steps

java.util.List<Route.Step> steps

The sequence of steps this route consists of, in the order they are to be processed.

Class org.opentcs.data.order.Route.Step extends java.lang.Object implements Serializable

Serialized Fields

destinationPoint

Point destinationPoint

The point that is reached by travelling the path.

executionAllowed

boolean executionAllowed

Whether execution of this step is allowed.

path

Path path

The path to travel.

reroutingType

ReroutingType reroutingType

Marks this Route.Step as the origin of a recalculated route and indicates which ReroutingType was used to determine the (new) route.

Might be null, if this Route.Step is not the origin of a recalculated route.

routeIndex

int routeIndex

This step's index in the vehicle's route.

sourcePoint

Point sourcePoint

The point that the vehicle is starting from.

vehicleOrientation

Vehicle.Orientation vehicleOrientation

The direction into which the vehicle is supposed to travel.

Class org.opentcs.data.order.TransportOrder extends TCSObject<TransportOrder> implements Serializable

Serialized Fields

creationTime

java.time.Instant creationTime

The point of time at which this transport order was created.

currentDriveOrderIndex

int currentDriveOrderIndex

The index of the currently processed drive order.

currentRouteStepIndex

int currentRouteStepIndex

The index of the last route step travelled for the currently processed drive order.

deadline

java.time.Instant deadline

The point of time at which processing of this transport order must be finished.

dependencies

java.util.Set<TCSObjectReference<TransportOrder>> dependencies

A set of TransportOrders that must have been finished before this one may be processed.

dispensable

boolean dispensable

Whether this order is dispensable (may be withdrawn automatically).

driveOrders

java.util.List<DriveOrder> driveOrders

The drive orders this transport order consists of.

finishedTime

java.time.Instant finishedTime

The point of time at which processing of this transport order was finished.

intendedVehicle

TCSObjectReference<Vehicle> intendedVehicle

A reference to the vehicle that is intended to process this transport order. If this order is free to be processed by any vehicle, this is null.

peripheralReservationToken

java.lang.String peripheralReservationToken

An optional token for reserving peripheral devices while processing this transport order.

processingVehicle

TCSObjectReference<Vehicle> processingVehicle

A reference to the vehicle currently processing this transport order. If this transport order is not being processed at the moment, this is null.

state

TransportOrder.State state

This transport order's current state.

type

java.lang.String type

The type of this transport order.

wrappingSequence

TCSObjectReference<OrderSequence> wrappingSequence

The order sequence this transport order belongs to. May be null in case this order isn't part of any sequence.

Package org.opentcs.data.peripherals

Class org.opentcs.data.peripherals.PeripheralJob extends TCSObject<PeripheralJob> implements Serializable

Serialized Fields

creationTime

java.time.Instant creationTime

The point of time at which this peripheral job was created.

finishedTime

java.time.Instant finishedTime

The point of time at which processing of this peripheral job was finished.

peripheralOperation

PeripheralOperation peripheralOperation

The operation that is to be performed by the pripheral device.

relatedTransportOrder

TCSObjectReference<TransportOrder> relatedTransportOrder

The transport order for which this peripheral job was created. May be null, if this job wasn't created in the context of a transport order being processed by a vehicle.

relatedVehicle

TCSObjectReference<Vehicle> relatedVehicle

The vehicle for which this peripheral job was created. May be null, if this job wasn't created in the context of a transport order being processed by a vehicle.

reservationToken

java.lang.String reservationToken

A token that may be used to reserve a peripheral device. A peripheral device that is reserved for a specific token can only process jobs which match that reservation token. This string may not be empty.

state

PeripheralJob.State state

This peripheral job's current state.

Class org.opentcs.data.peripherals.PeripheralOperation extends java.lang.Object implements Serializable

Serialized Fields

completionRequired

boolean completionRequired

Whether the completion of this operation is required to allow a vehicle to continue driving.

executionTrigger

PeripheralOperation.ExecutionTrigger executionTrigger

The moment at which this operation is to be executed.

location

TCSResourceReference<Location> location

The location the peripheral device is associated with.

operation

java.lang.String operation

The actual operation to be executed by the peripheral device.

Package org.opentcs.drivers

Package org.opentcs.drivers.peripherals

Class org.opentcs.drivers.peripherals.PeripheralCommAdapterDescription extends java.lang.Object implements Serializable

Class org.opentcs.drivers.peripherals.PeripheralProcessModel extends java.lang.Object implements Serializable

Serialized Fields

commAdapterConnected

boolean commAdapterConnected

Whether the communication adapter is currently connected to the peripheral device.

commAdapterEnabled

boolean commAdapterEnabled

Whether the communication adapter is currently enabled.

location

TCSResourceReference<Location> location

The reference to the location that is attached to this model.

state

PeripheralInformation.State state

The peripheral device's current state.

Package org.opentcs.drivers.peripherals.management

Class org.opentcs.drivers.peripherals.management.PeripheralAttachmentEvent extends PeripheralCommAdapterEvent implements Serializable

Serialized Fields

attachmentInformation

PeripheralAttachmentInformation attachmentInformation

The information to the actual attachment.

location

TCSResourceReference<Location> location

The location a peripheral comm adapter has been attached to.

Class org.opentcs.drivers.peripherals.management.PeripheralAttachmentInformation extends java.lang.Object implements Serializable

Serialized Fields

attachedCommAdapter

PeripheralCommAdapterDescription attachedCommAdapter

The comm adapter attached to the referenced location.

availableCommAdapters

java.util.List<PeripheralCommAdapterDescription> availableCommAdapters

The list of comm adapters available to be attached to the referenced location.

locationReference

TCSResourceReference<Location> locationReference

The location this attachment information belongs to.

Class org.opentcs.drivers.peripherals.management.PeripheralCommAdapterEvent extends java.lang.Object implements Serializable

Class org.opentcs.drivers.peripherals.management.PeripheralCommAdapterPanel extends javax.swing.JPanel implements Serializable

Class org.opentcs.drivers.peripherals.management.PeripheralProcessModelEvent extends PeripheralCommAdapterEvent implements Serializable

Serialized Fields

attributeChanged

java.lang.String attributeChanged

The name of the attribute that has changed in the process model.

location

TCSResourceReference<Location> location

The location assiciated with the peripheral device.

processModel

PeripheralProcessModel processModel

The process model with its current/changed state.

Package org.opentcs.drivers.vehicle

Class org.opentcs.drivers.vehicle.DefaultVehicleCommAdapterDescription extends VehicleCommAdapterDescription implements Serializable

Serialized Fields

description

java.lang.String description

The description.

isSimVehicleCommAdapter

boolean isSimVehicleCommAdapter

Whether the comm adapter is a simulating one.

Class org.opentcs.drivers.vehicle.LoadHandlingDevice extends java.lang.Object implements Serializable

Serialized Fields

full

boolean full

A flag indicating whether this device is filled to its maximum capacity or not.

label

java.lang.String label

A name/label for this device.

Class org.opentcs.drivers.vehicle.VehicleCommAdapterDescription extends java.lang.Object implements Serializable

Class org.opentcs.drivers.vehicle.VehicleCommAdapterEvent extends java.lang.Object implements Serializable

Serialized Fields

adapterName

java.lang.String adapterName

The name of the adapter that emitted this event.

appendix

java.io.Serializable appendix

An optional appendix containing additional arbitrary information about the event.

Package org.opentcs.drivers.vehicle.commands

Class org.opentcs.drivers.vehicle.commands.InitPositionCommand extends java.lang.Object implements Serializable

Serialized Fields

position

java.lang.String position

The position to set.

Package org.opentcs.drivers.vehicle.management

Class org.opentcs.drivers.vehicle.management.AttachmentEvent extends CommAdapterEvent implements Serializable

Serialized Fields

updatedAttachmentInformation

AttachmentInformation updatedAttachmentInformation

Deprecated.

The AttachmentInformation to the actual attachment.

vehicleName

java.lang.String vehicleName

Deprecated.

The vehicle's name a comm adapter has been attached to.

Class org.opentcs.drivers.vehicle.management.AttachmentInformation extends java.lang.Object implements Serializable

Serialized Fields

attachedCommAdapter

VehicleCommAdapterDescription attachedCommAdapter

Deprecated.

The comm adapter attached to the referenced vehicle.

availableCommAdapters

java.util.List<VehicleCommAdapterDescription> availableCommAdapters

Deprecated.

The list of comm adapters available to be attached to the referenced vehicle.

vehicleReference

TCSObjectReference<Vehicle> vehicleReference

Deprecated.

The vehicle this attachment information belongs to.

Class org.opentcs.drivers.vehicle.management.CommAdapterEvent extends java.lang.Object implements Serializable

Class org.opentcs.drivers.vehicle.management.ProcessModelEvent extends CommAdapterEvent implements Serializable

Serialized Fields

attributeChanged

java.lang.String attributeChanged

The attribute's name that changed in the process model.

updatedProcessModel

VehicleProcessModelTO updatedProcessModel

A serializable representation of the corresponding process model.

Class org.opentcs.drivers.vehicle.management.VehicleAttachmentEvent extends AttachmentEvent implements Serializable

Class org.opentcs.drivers.vehicle.management.VehicleAttachmentInformation extends AttachmentInformation implements Serializable

Class org.opentcs.drivers.vehicle.management.VehicleCommAdapterPanel extends javax.swing.JPanel implements Serializable

Class org.opentcs.drivers.vehicle.management.VehicleProcessModelTO extends java.lang.Object implements Serializable

Serialized Fields

commAdapterConnected

boolean commAdapterConnected

commAdapterEnabled

boolean commAdapterEnabled

energyLevel

int energyLevel

length

int length

loadHandlingDevices

java.util.List<LoadHandlingDevice> loadHandlingDevices

name

java.lang.String name

notifications

java.util.Queue<UserNotification> notifications

orientationAngle

double orientationAngle

position

java.lang.String position

precisePosition

Triple precisePosition

state

Vehicle.State state

Package org.opentcs.drivers.vehicle.messages

Class org.opentcs.drivers.vehicle.messages.ClearError extends java.lang.Object implements Serializable

Class org.opentcs.drivers.vehicle.messages.SetSpeedMultiplier extends java.lang.Object implements Serializable

Serialized Fields

multiplier

int multiplier

The speed multiplier in percent.

Package org.opentcs.util

Class org.opentcs.util.ClassMatcher extends java.lang.Object implements Serializable

Serialized Fields

clazzes

java.util.Set<java.lang.Class<?>> clazzes

The set of classes to evaluate incoming events to.