Package org.opentcs.data.peripherals

Klasse PeripheralOperation

java.lang.Object

org.opentcs.data.peripherals.PeripheralOperation

Alle implementierten Schnittstellen:

Serializable

public class PeripheralOperation
extends Object
implements Serializable

Describes an operation that is to be executed by a peripheral device.

Siehe auch:

• Serialisierte Form

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static enum	PeripheralOperation.ExecutionTrigger	Defines the various moments at which an operation may be executed.

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
PeripheralOperation(TCSResourceReference<Location> location, String operation, PeripheralOperation.ExecutionTrigger executionTrigger, boolean completionRequired)	Creates a new instance.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
PeripheralOperation.ExecutionTrigger	getExecutionTrigger()	Returns the moment at which this operation is to be executed.
TCSResourceReference<Location>	getLocation()	Returns the location the peripheral device is associated with.
String	getOperation()	Returns the actual operation to be executed by the peripheral device.
boolean	isCompletionRequired()	Returns whether the completion of this operation is required to allow a vehicle to continue driving.
String	toString()

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Konstruktordetails

PeripheralOperation

public PeripheralOperation(@Nonnull
 TCSResourceReference<Location> location,
 @Nonnull
 String operation,
 @Nonnull
 PeripheralOperation.ExecutionTrigger executionTrigger,
 boolean completionRequired)

Creates a new instance.

Parameter:

location - The location the peripheral device is associated with.

operation - The actual operation to be executed by the peripheral device.

executionTrigger - The moment at which this operation is to be executed.

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

Methodendetails

getLocation

@Nonnull
public TCSResourceReference<Location> getLocation()

Returns the location the peripheral device is associated with.

Gibt zurück:

The location the peripheral device is associated with.

getOperation

@Nonnull
public String getOperation()

Returns the actual operation to be executed by the peripheral device.

Gibt zurück:

The actual operation to be executed by the peripheral device.

getExecutionTrigger

@Nonnull
public PeripheralOperation.ExecutionTrigger getExecutionTrigger()

Returns the moment at which this operation is to be executed.

Gibt zurück:

The moment at which this operation is to be executed.

isCompletionRequired

public boolean isCompletionRequired()

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

Gibt zurück:

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

toString

public String toString()

Setzt außer Kraft:

toString in Klasse Object