Serialisierte Form

Package org.opentcs.access

Ausnahmeklasse org.opentcs.access.CredentialsException

class CredentialsException extends KernelRuntimeException implements Serializable

Ausnahmeklasse org.opentcs.access.KernelException

class KernelException extends Exception implements Serializable

Ausnahmeklasse org.opentcs.access.KernelRuntimeException

class KernelRuntimeException extends RuntimeException implements Serializable

Klasse org.opentcs.access.KernelStateTransitionEvent

class KernelStateTransitionEvent extends Object implements Serializable

Serialisierte Felder

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.

Klasse org.opentcs.access.ModelTransitionEvent

class ModelTransitionEvent extends Object implements Serializable

Serialisierte Felder

modelContentChanged

boolean modelContentChanged

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

newModelName

String newModelName

The new model the kernel is in transition to.

oldModelName

String oldModelName

The old model the kernel is leaving.

transitionFinished

boolean transitionFinished

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

Klasse org.opentcs.access.NotificationPublicationEvent

class NotificationPublicationEvent extends Object implements Serializable

Serialisierte Felder

notification

UserNotification notification

The published message.

Klasse org.opentcs.access.SslParameterSet

class SslParameterSet extends Object implements Serializable

Serialisierte Felder

keystoreFile

File keystoreFile

The file path of the keystore.

keystorePassword

String keystorePassword

The password for the keystore file.

keystoreType

String keystoreType

The type used for keystore and truststore.

truststoreFile

File truststoreFile

The file path of the truststore.

truststorePassword

String truststorePassword

The password for the truststore file.

Package org.opentcs.access.rmi

Klasse org.opentcs.access.rmi.ClientID

class ClientID extends Object implements Serializable

Serialisierte Felder

clientName

String clientName

The client's name.

uuid

UUID uuid

The client's UUID.

Package org.opentcs.access.to

Klasse org.opentcs.access.to.CreationTO

class CreationTO extends Object implements Serializable

Serialisierte Felder

name

String name

The name of this transfer object.

properties

Map<String,String> properties

The properties of this transfer object.

Package org.opentcs.access.to.model

Klasse org.opentcs.access.to.model.BlockCreationTO

class BlockCreationTO extends CreationTO implements Serializable

Serialisierte Felder

layout

BlockCreationTO.Layout layout

The information regarding the grahical representation of this block.

memberNames

Set<String> memberNames

This block's member names.

type

Block.Type type

This block's type.

Klasse org.opentcs.access.to.model.BlockCreationTO.Layout

class Layout extends Object implements Serializable

Serialisierte Felder

color

Color color

The color in which block elements are to be emphasized.

Klasse org.opentcs.access.to.model.BoundingBoxCreationTO

class BoundingBoxCreationTO extends Object implements Serializable

Serialisierte Felder

height

long height

length

long length

referenceOffset

CoupleCreationTO referenceOffset

width

long width

Klasse org.opentcs.access.to.model.CoupleCreationTO

class CoupleCreationTO extends Object implements Serializable

Serialisierte Felder

x

long x

y

long y

Klasse org.opentcs.access.to.model.LocationCreationTO

class LocationCreationTO extends CreationTO implements Serializable

Serialisierte Felder

layout

LocationCreationTO.Layout layout

The information regarding the grahical representation of this location.

links

Map<String,Set<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

String typeName

The name of this location's type.

Klasse org.opentcs.access.to.model.LocationCreationTO.Layout

class Layout extends Object implements Serializable

Serialisierte Felder

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).

Klasse org.opentcs.access.to.model.LocationTypeCreationTO

class LocationTypeCreationTO extends CreationTO implements Serializable

Serialisierte Felder

allowedOperations

List<String> allowedOperations

The allowed operations for this location type.

allowedPeripheralOperations

List<String> allowedPeripheralOperations

The allowed peripheral operations for this location type.

layout

LocationTypeCreationTO.Layout layout

The information regarding the grahical representation of this location type.

Klasse org.opentcs.access.to.model.LocationTypeCreationTO.Layout

class Layout extends Object implements Serializable

Serialisierte Felder

locationRepresentation

LocationRepresentation locationRepresentation

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

Klasse org.opentcs.access.to.model.PathCreationTO

class PathCreationTO extends CreationTO implements Serializable

Serialisierte Felder

destPointName

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

List<PeripheralOperationCreationTO> peripheralOperations

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

srcPointName

String srcPointName

The point name this path originates in.

vehicleEnvelopes

Map<String,Envelope> vehicleEnvelopes

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

Klasse org.opentcs.access.to.model.PathCreationTO.Layout

class Layout extends Object implements Serializable

Serialisierte Felder

connectionType

Path.Layout.ConnectionType connectionType

The connection type the path is represented as.

controlPoints

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.

Klasse org.opentcs.access.to.model.PlantModelCreationTO

class PlantModelCreationTO extends CreationTO implements Serializable

Serialisierte Felder

blocks

List<BlockCreationTO> blocks

The plant model's blocks.

locations

List<LocationCreationTO> locations

The plant model's locations.

locationTypes

List<LocationTypeCreationTO> locationTypes

The plant model's location types.

paths

List<PathCreationTO> paths

The plant model's paths.

points

List<PointCreationTO> points

The plant model's points.

vehicles

List<VehicleCreationTO> vehicles

The plant model's vehicles.

visualLayout

VisualLayoutCreationTO visualLayout

The plant model's visual layout.

Klasse org.opentcs.access.to.model.PointCreationTO

class PointCreationTO extends CreationTO implements Serializable

Serialisierte Felder

layout

PointCreationTO.Layout layout

The information regarding the graphical representation of this point.

maxVehicleBoundingBox

BoundingBoxCreationTO maxVehicleBoundingBox

The maximum bounding box (in mm) that a vehicle at this point is allowed to have.

pose

Pose pose

The pose of the vehicle at this point.

type

Point.Type type

This point's type.

vehicleEnvelopes

Map<String,Envelope> vehicleEnvelopes

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

Klasse org.opentcs.access.to.model.PointCreationTO.Layout

class Layout extends Object implements Serializable

Serialisierte Felder

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).

Klasse org.opentcs.access.to.model.VehicleCreationTO

class VehicleCreationTO extends CreationTO implements Serializable

Serialisierte Felder

boundingBox

BoundingBoxCreationTO boundingBox

The vehicle's bounding box (in mm).

energyLevelThresholdSet

VehicleCreationTO.EnergyLevelThresholdSet energyLevelThresholdSet

Contains information regarding the energy level threshold values of the vehicle.

envelopeKey

String envelopeKey

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

layout

VehicleCreationTO.Layout layout

The information regarding the graphical representation of this vehicle.

maxReverseVelocity

int maxReverseVelocity

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

maxVelocity

int maxVelocity

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

Klasse org.opentcs.access.to.model.VehicleCreationTO.EnergyLevelThresholdSet

class EnergyLevelThresholdSet extends Object implements Serializable

Serialisierte Felder

energyLevelCritical

int energyLevelCritical

energyLevelFullyRecharged

int energyLevelFullyRecharged

energyLevelGood

int energyLevelGood

energyLevelSufficientlyRecharged

int energyLevelSufficientlyRecharged

Klasse org.opentcs.access.to.model.VehicleCreationTO.Layout

class Layout extends Object implements Serializable

Serialisierte Felder

routeColor

Color routeColor

The color in which vehicle routes are to be emphasized.

Klasse org.opentcs.access.to.model.VisualLayoutCreationTO

class VisualLayoutCreationTO extends CreationTO implements Serializable

Serialisierte Felder

layerGroups

List<LayerGroup> layerGroups

The layout's layer groups.

layers

List<Layer> layers

This layout's layers.

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.access.to.order

Klasse org.opentcs.access.to.order.DestinationCreationTO

class DestinationCreationTO extends CreationTO implements Serializable

Serialisierte Felder

destLocationName

String destLocationName

The name of the destination location (or point).

destOperation

String destOperation

The operation to be performed at the destination.

Klasse org.opentcs.access.to.order.OrderSequenceCreationTO

class OrderSequenceCreationTO extends CreationTO implements Serializable

Serialisierte Felder

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

String intendedVehicleName

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

type

String type

The type of the order sequence.

Klasse org.opentcs.access.to.order.TransportOrderCreationTO

class TransportOrderCreationTO extends CreationTO implements Serializable

Serialisierte Felder

deadline

Instant deadline

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

dependencyNames

Set<String> dependencyNames

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

destinations

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

String intendedVehicleName

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

peripheralReservationToken

String peripheralReservationToken

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

type

String type

The type of the transport order.

wrappingSequence

String wrappingSequence

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

Package org.opentcs.access.to.peripherals

Klasse org.opentcs.access.to.peripherals.PeripheralJobCreationTO

class PeripheralJobCreationTO extends CreationTO implements Serializable

Serialisierte Felder

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

String relatedTransportOrderName

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

relatedVehicleName

String relatedVehicleName

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

reservationToken

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.

Klasse org.opentcs.access.to.peripherals.PeripheralOperationCreationTO

class PeripheralOperationCreationTO extends CreationTO implements Serializable

Serialisierte Felder

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

String locationName

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

operation

String operation

The operation to be performed by the peripheral device.

Package org.opentcs.components.kernel

Klasse org.opentcs.components.kernel.Query.Void

class Void extends Object implements Serializable

Ausnahmeklasse org.opentcs.components.kernel.ResourceAllocationException

class ResourceAllocationException extends KernelException implements Serializable

Package org.opentcs.components.kernel.dipatching

Ausnahmeklasse org.opentcs.components.kernel.dipatching.TransportOrderAssignmentException

class TransportOrderAssignmentException extends KernelRuntimeException implements Serializable

Serialisierte Felder

transportOrder

TCSObjectReference<TransportOrder> transportOrder

transportOrderAssignmentVeto

TransportOrderAssignmentVeto transportOrderAssignmentVeto

vehicle

TCSObjectReference<Vehicle> vehicle

Package org.opentcs.components.kernel.services

Ausnahmeklasse org.opentcs.components.kernel.services.ServiceUnavailableException

class ServiceUnavailableException extends KernelRuntimeException implements Serializable

Package org.opentcs.components.kernelcontrolcenter

Klasse org.opentcs.components.kernelcontrolcenter.ControlCenterPanel

class ControlCenterPanel extends JPanel implements Serializable

Package org.opentcs.components.plantoverview

Klasse org.opentcs.components.plantoverview.PluggablePanel

class PluggablePanel extends JPanel implements Serializable

Package org.opentcs.configuration

Ausnahmeklasse org.opentcs.configuration.ConfigurationException

class ConfigurationException extends RuntimeException implements Serializable

Package org.opentcs.data

Ausnahmeklasse org.opentcs.data.ObjectExistsException

class ObjectExistsException extends KernelRuntimeException implements Serializable

Klasse org.opentcs.data.ObjectHistory

class ObjectHistory extends Object implements Serializable

Serialisierte Felder

entries

List<ObjectHistory.Entry> entries

The actual history entries.

Klasse org.opentcs.data.ObjectHistory.Entry

class Entry extends Object implements Serializable

Serialisierte Felder

eventCode

String eventCode

A code identifying the event that occured.

supplement

Object supplement

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

timestamp

Instant timestamp

The point of time at which the event occured.

Ausnahmeklasse org.opentcs.data.ObjectUnknownException

class ObjectUnknownException extends KernelRuntimeException implements Serializable

Klasse org.opentcs.data.TCSObject

class TCSObject extends Object implements Serializable

Serialisierte Felder

history

ObjectHistory history

A history of events related to this object.

name

String name

The name of the business object.

properties

Map<String,String> properties

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

propertiesReadOnly

Map<String,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.

Klasse org.opentcs.data.TCSObjectEvent

class TCSObjectEvent extends Object implements Serializable

Serialisierte Felder

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.

Klasse org.opentcs.data.TCSObjectReference

class TCSObjectReference extends Object implements Serializable

Serialisierte Felder

name

String name

The referenced object's name.

referentClass

Class<?> referentClass

The referenced object's class.

Package org.opentcs.data.model

Klasse org.opentcs.data.model.Block

class Block extends TCSResource<Block> implements Serializable

Serialisierte Felder

layout

Block.Layout layout

The information regarding the grahical representation of this block.

members

Set<TCSResourceReference<?>> members

The resources aggregated in this block.

type

Block.Type type

This block's type.

Klasse org.opentcs.data.model.Block.Layout

class Layout extends Object implements Serializable

Serialisierte Felder

color

Color color

The color in which block elements are to be emphasized.

Klasse org.opentcs.data.model.BoundingBox

class BoundingBox extends Object implements Serializable

Serialisierte Felder

height

long height

length

long length

referenceOffset

Couple referenceOffset

width

long width

Klasse org.opentcs.data.model.Couple

class Couple extends Object implements Serializable

Serialisierte Felder

x

long x

The X coordinate.

y

long y

The Y coordinate.

Klasse org.opentcs.data.model.Envelope

class Envelope extends Object implements Serializable

Serialisierte Felder

vertices

List<Couple> vertices

Klasse org.opentcs.data.model.Location

class Location extends TCSResource<Location> implements Serializable

Serialisierte Felder

attachedLinks

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.

Klasse org.opentcs.data.model.Location.Layout

class Layout extends Object implements Serializable

Serialisierte Felder

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).

Klasse org.opentcs.data.model.Location.Link

class Link extends Object implements Serializable

Serialisierte Felder

allowedOperations

Set<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.

Klasse org.opentcs.data.model.LocationType

class LocationType extends TCSObject<LocationType> implements Serializable

Serialisierte Felder

allowedOperations

List<String> allowedOperations

The operations allowed at locations of this type.

allowedPeripheralOperations

List<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.

Klasse org.opentcs.data.model.LocationType.Layout

class Layout extends Object implements Serializable

Serialisierte Felder

locationRepresentation

LocationRepresentation locationRepresentation

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

Klasse org.opentcs.data.model.Path

class Path extends TCSResource<Path> implements Serializable

Serialisierte Felder

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

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

Map<String,Envelope> vehicleEnvelopes

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

Klasse org.opentcs.data.model.Path.Layout

class Layout extends Object implements Serializable

Serialisierte Felder

connectionType

Path.Layout.ConnectionType connectionType

The connection type the path is represented as.

controlPoints

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.

Klasse org.opentcs.data.model.PeripheralInformation

class PeripheralInformation extends Object implements Serializable

Serialisierte Felder

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

String reservationToken

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

state

PeripheralInformation.State state

This peripheral device's current state.

Klasse org.opentcs.data.model.PlantModel

class PlantModel extends Object implements Serializable

Serialisierte Felder

blocks

Set<Block> blocks

locations

Set<Location> locations

locationTypes

Set<LocationType> locationTypes

name

String name

paths

Set<Path> paths

points

Set<Point> points

properties

Map<String,String> properties

vehicles

Set<Vehicle> vehicles

visualLayout

VisualLayout visualLayout

Klasse org.opentcs.data.model.Point

class Point extends TCSResource<Point> implements Serializable

Serialisierte Felder

attachedLinks

Set<Location.Link> attachedLinks

A set of links attached to this point.

incomingPaths

Set<TCSObjectReference<Path>> incomingPaths

A set of references to paths ending in this point.

layout

Point.Layout layout

The information regarding the graphical representation of this point.

maxVehicleBoundingBox

BoundingBox maxVehicleBoundingBox

The maximum bounding box (in mm) that a vehicle at this point is allowed to have.

occupyingVehicle

TCSObjectReference<Vehicle> occupyingVehicle

A reference to the vehicle occupying this point.

outgoingPaths

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

Map<String,Envelope> vehicleEnvelopes

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

Klasse org.opentcs.data.model.Point.Layout

class Layout extends Object implements Serializable

Serialisierte Felder

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).

Klasse org.opentcs.data.model.Pose

class Pose extends Object implements Serializable

Serialisierte Felder

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.

Klasse org.opentcs.data.model.TCSResource

class TCSResource extends TCSObject<E extends TCSResource<E>> implements Serializable

Klasse org.opentcs.data.model.TCSResourceReference

class TCSResourceReference extends TCSObjectReference<E extends TCSResource<E>> implements Serializable

Klasse org.opentcs.data.model.Triple

class Triple extends Object implements Serializable

Serialisierte Felder

x

long x

The X coordinate.

y

long y

The Y coordinate.

z

long z

The Z coordinate.

Klasse org.opentcs.data.model.Vehicle

class Vehicle extends TCSObject<Vehicle> implements Serializable

Serialisierte Felder

allocatedResources

List<Set<TCSResourceReference<?>>> allocatedResources

The resources this vehicle has allocated.

allowedOrderTypes

Set<String> allowedOrderTypes

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

boundingBox

BoundingBox boundingBox

The vehicle's bounding box (in mm).

claimedResources

List<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).

energyLevelThresholdSet

Vehicle.EnergyLevelThresholdSet energyLevelThresholdSet

Contains information regarding the energy level threshold values of the vehicle.

envelopeKey

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 graphical representation of this vehicle.

loadHandlingDevices

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.

paused

boolean paused

Whether this vehicle is currently paused.

pose

Pose pose

The vehicle's pose containing its precise position and current orientation angle.

procState

Vehicle.ProcState procState

This vehicle's current processing state.

rechargeOperation

String rechargeOperation

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

state

Vehicle.State state

This vehicle's current state.

transportOrder

TCSObjectReference<TransportOrder> transportOrder

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

Klasse org.opentcs.data.model.Vehicle.EnergyLevelThresholdSet

class EnergyLevelThresholdSet extends Object implements Serializable

Serialisierte Felder

energyLevelCritical

int energyLevelCritical

energyLevelFullyRecharged

int energyLevelFullyRecharged

energyLevelGood

int energyLevelGood

energyLevelSufficientlyRecharged

int energyLevelSufficientlyRecharged

Klasse org.opentcs.data.model.Vehicle.Layout

class Layout extends Object implements Serializable

Serialisierte Felder

routeColor

Color routeColor

The color in which vehicle routes are to be emphasized.

Package org.opentcs.data.model.visualization

Klasse org.opentcs.data.model.visualization.Layer

class Layer extends Object implements Serializable

Serialisierte Felder

groupId

int groupId

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

id

int id

The unique ID of this layer.

name

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.

Klasse org.opentcs.data.model.visualization.LayerGroup

class LayerGroup extends Object implements Serializable

Serialisierte Felder

id

int id

The unique ID of this layer group.

name

String name

The name of this layer group.

visible

boolean visible

Whether this layer group is visible or not.

Klasse org.opentcs.data.model.visualization.VisualLayout

class VisualLayout extends TCSObject<VisualLayout> implements Serializable

Serialisierte Felder

layerGroups

List<LayerGroup> layerGroups

The layer groups in this model.

layers

List<Layer> layers

The layers in this model.

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

Klasse org.opentcs.data.notification.UserNotification

class UserNotification extends Object implements Serializable

Serialisierte Felder

level

UserNotification.Level level

This message's type.

source

String source

An identifier of the notification's source.

text

String text

This message's text.

timestamp

Instant timestamp

This message's creation timestamp.

Package org.opentcs.data.order

Klasse org.opentcs.data.order.DriveOrder

class DriveOrder extends Object implements Serializable

Serialisierte Felder

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.

Klasse org.opentcs.data.order.DriveOrder.Destination

class Destination extends Object implements Serializable

Serialisierte Felder

destination

TCSObjectReference<?> destination

The actual destination (point or location).

operation

String operation

The operation to be performed at the destination location.

properties

Map<String,String> properties

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

Klasse org.opentcs.data.order.OrderSequence

class OrderSequence extends TCSObject<OrderSequence> implements Serializable

Serialisierte Felder

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

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

String type

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

Klasse org.opentcs.data.order.Route

class Route extends Object implements Serializable

Serialisierte Felder

costs

long costs

The costs for travelling this route.

steps

List<Route.Step> steps

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

Klasse org.opentcs.data.order.Route.Step

class Step extends Object implements Serializable

Serialisierte Felder

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.

Klasse org.opentcs.data.order.TransportOrder

class TransportOrder extends TCSObject<TransportOrder> implements Serializable

Serialisierte Felder

creationTime

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

Instant deadline

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

dependencies

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

List<DriveOrder> driveOrders

The drive orders this transport order consists of.

finishedTime

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

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

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

Klasse org.opentcs.data.peripherals.PeripheralJob

class PeripheralJob extends TCSObject<PeripheralJob> implements Serializable

Serialisierte Felder

creationTime

Instant creationTime

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

finishedTime

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

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.

Klasse org.opentcs.data.peripherals.PeripheralOperation

class PeripheralOperation extends Object implements Serializable

Serialisierte Felder

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

String operation

The actual operation to be executed by the peripheral device.

Package org.opentcs.drivers

Package org.opentcs.drivers.peripherals

Klasse org.opentcs.drivers.peripherals.PeripheralCommAdapterDescription

class PeripheralCommAdapterDescription extends Object implements Serializable

Klasse org.opentcs.drivers.peripherals.PeripheralProcessModel

class PeripheralProcessModel extends Object implements Serializable

Serialisierte Felder

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

Klasse org.opentcs.drivers.peripherals.management.PeripheralAttachmentEvent

class PeripheralAttachmentEvent extends PeripheralCommAdapterEvent implements Serializable

Serialisierte Felder

attachmentInformation

PeripheralAttachmentInformation attachmentInformation

The information to the actual attachment.

location

TCSResourceReference<Location> location

The location a peripheral comm adapter has been attached to.

Klasse org.opentcs.drivers.peripherals.management.PeripheralAttachmentInformation

class PeripheralAttachmentInformation extends Object implements Serializable

Serialisierte Felder

attachedCommAdapter

PeripheralCommAdapterDescription attachedCommAdapter

The comm adapter attached to the referenced location.

availableCommAdapters

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.

Klasse org.opentcs.drivers.peripherals.management.PeripheralCommAdapterEvent

class PeripheralCommAdapterEvent extends Object implements Serializable

Klasse org.opentcs.drivers.peripherals.management.PeripheralCommAdapterPanel

class PeripheralCommAdapterPanel extends JPanel implements Serializable

Klasse org.opentcs.drivers.peripherals.management.PeripheralProcessModelEvent

class PeripheralProcessModelEvent extends PeripheralCommAdapterEvent implements Serializable

Serialisierte Felder

attributeChanged

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

Klasse org.opentcs.drivers.vehicle.DefaultVehicleCommAdapterDescription

class DefaultVehicleCommAdapterDescription extends VehicleCommAdapterDescription implements Serializable

Serialisierte Felder

description

String description

The description.

isSimVehicleCommAdapter

boolean isSimVehicleCommAdapter

Whether the comm adapter is a simulating one.

Klasse org.opentcs.drivers.vehicle.LoadHandlingDevice

class LoadHandlingDevice extends Object implements Serializable

Serialisierte Felder

full

boolean full

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

label

String label

A name/label for this device.

Klasse org.opentcs.drivers.vehicle.VehicleCommAdapterDescription

class VehicleCommAdapterDescription extends Object implements Serializable

Klasse org.opentcs.drivers.vehicle.VehicleCommAdapterEvent

class VehicleCommAdapterEvent extends Object implements Serializable

Serialisierte Felder

adapterName

String adapterName

The name of the adapter that emitted this event.

appendix

Serializable appendix

An optional appendix containing additional arbitrary information about the event.

Package org.opentcs.drivers.vehicle.commands

Klasse org.opentcs.drivers.vehicle.commands.InitPositionCommand

class InitPositionCommand extends Object implements Serializable

Serialisierte Felder

position

String position

The position to set.

Package org.opentcs.drivers.vehicle.management

Klasse org.opentcs.drivers.vehicle.management.CommAdapterEvent

class CommAdapterEvent extends Object implements Serializable

Klasse org.opentcs.drivers.vehicle.management.ProcessModelEvent

class ProcessModelEvent extends CommAdapterEvent implements Serializable

Serialisierte Felder

attributeChanged

String attributeChanged

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

updatedProcessModel

VehicleProcessModelTO updatedProcessModel

A serializable representation of the corresponding process model.

Klasse org.opentcs.drivers.vehicle.management.VehicleAttachmentEvent

class VehicleAttachmentEvent extends CommAdapterEvent implements Serializable

Serialisierte Felder

attachmentInformation

VehicleAttachmentInformation attachmentInformation

The VehicleAttachmentInformation to the actual attachment.

vehicleName

String vehicleName

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

Klasse org.opentcs.drivers.vehicle.management.VehicleAttachmentInformation

class VehicleAttachmentInformation extends Object implements Serializable

Serialisierte Felder

attachedCommAdapter

VehicleCommAdapterDescription attachedCommAdapter

The comm adapter attached to the referenced vehicle.

availableCommAdapters

List<VehicleCommAdapterDescription> availableCommAdapters

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

vehicleReference

TCSObjectReference<Vehicle> vehicleReference

The vehicle this attachment information belongs to.

Klasse org.opentcs.drivers.vehicle.management.VehicleCommAdapterPanel

class VehicleCommAdapterPanel extends JPanel implements Serializable

Klasse org.opentcs.drivers.vehicle.management.VehicleProcessModelTO

class VehicleProcessModelTO extends Object implements Serializable

Serialisierte Felder

boundingBox

BoundingBox boundingBox

commAdapterConnected

boolean commAdapterConnected

commAdapterEnabled

boolean commAdapterEnabled

energyLevel

int energyLevel

loadHandlingDevices

List<LoadHandlingDevice> loadHandlingDevices

name

String name

notifications

Queue<UserNotification> notifications

pose

Pose pose

position

String position

state

Vehicle.State state

Package org.opentcs.drivers.vehicle.messages

Klasse org.opentcs.drivers.vehicle.messages.ClearError

class ClearError extends Object implements Serializable

Klasse org.opentcs.drivers.vehicle.messages.SetSpeedMultiplier

class SetSpeedMultiplier extends Object implements Serializable

Serialisierte Felder

multiplier

int multiplier

The speed multiplier in percent.

Package org.opentcs.util

Klasse org.opentcs.util.ClassMatcher

class ClassMatcher extends Object implements Serializable

Serialisierte Felder

clazzes

Set<Class<?>> clazzes

The set of classes to evaluate incoming events to.