Package org.opentcs.access.to.model
Class VehicleCreationTO
java.lang.Object
org.opentcs.access.to.CreationTO
org.opentcs.access.to.model.VehicleCreationTO
- All Implemented Interfaces:
java.io.Serializable
public class VehicleCreationTO extends CreationTO implements java.io.Serializable
A transfer object describing a block in the plant model.
- See Also:
- Serialized Form
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVehicleCreationTO.LayoutContains information regarding the grahical representation of a vehicle. -
Constructor Summary
Constructors Constructor Description VehicleCreationTO(java.lang.String name)Creates a new instance. -
Method Summary
Modifier and Type Method Description intgetEnergyLevelCritical()Returns this vehicle's critical energy level (in percent of the maximum).intgetEnergyLevelFullyRecharged()Returns this vehicle's fully recharged energy level (in percent of the maximum).intgetEnergyLevelGood()Returns this vehicle's good energy level (in percent of the maximum).intgetEnergyLevelSufficientlyRecharged()Returns this vehicle's sufficiently recharged energy level (in percent of the maximum).java.lang.StringgetEnvelopeKey()Returns the key for selecting the envelope to be used for resources the vehicle occupies.VehicleCreationTO.LayoutgetLayout()Returns the information regarding the grahical representation of this vehicle.intgetLength()Returns the vehicle's length (in mm).intgetMaxReverseVelocity()intgetMaxVelocity()java.lang.StringtoString()VehicleCreationTOwithEnergyLevelCritical(int energyLevelCritical)Creates a copy of this object with the given critical energy level.VehicleCreationTOwithEnergyLevelFullyRecharged(int energyLevelFullyRecharged)Creates a copy of this object with the vehicle's fully recharged energy level (in percent of the maximum).VehicleCreationTOwithEnergyLevelGood(int energyLevelGood)Creates a copy of this object with the vehicle's good energy level (in percent of the maximum).VehicleCreationTOwithEnergyLevelSufficientlyRecharged(int energyLevelSufficientlyRecharged)Creates a copy of this object with the vehicle's sufficiently recharged energy level (in percent of the maximum).VehicleCreationTOwithEnvelopeKey(java.lang.String envelopeKey)Creates a copy of this object, with the given envelope key.VehicleCreationTOwithLayout(VehicleCreationTO.Layout layout)Creates a copy of this object, with the given layout.VehicleCreationTOwithLength(int length)Creates a copy of this object with the vehicle's given length (in mm).VehicleCreationTOwithMaxReverseVelocity(int maxReverseVelocity)Creates a copy of this object with the given maximum reverse velocity (in mm/s).VehicleCreationTOwithMaxVelocity(int maxVelocity)Creates a copy of this object with the given maximum velocity (in mm/s).VehicleCreationTOwithName(java.lang.String name)Creates a copy of this object with the given name.VehicleCreationTOwithProperties(java.util.Map<java.lang.String,java.lang.String> properties)Creates a copy of this object with the given properties.VehicleCreationTOwithProperty(java.lang.String key, java.lang.String value)Creates a copy of this object and adds the given property.Methods inherited from class org.opentcs.access.to.CreationTO
getModifiableProperties, getName, getProperties, listWithAppendix, mapWithMapping, propertiesWith
-
Constructor Details
-
VehicleCreationTO
public VehicleCreationTO(@Nonnull java.lang.String name)Creates a new instance.- Parameters:
name- The name of this vehicle.
-
-
Method Details
-
withName
Creates a copy of this object with the given name.- Overrides:
withNamein classCreationTO- Parameters:
name- The new instance.- Returns:
- A copy of this object, differing in the given name.
-
withProperties
public VehicleCreationTO withProperties(@Nonnull java.util.Map<java.lang.String,java.lang.String> properties)Creates a copy of this object with the given properties.- Overrides:
withPropertiesin classCreationTO- Parameters:
properties- The new properties.- Returns:
- A copy of this object, differing in the given properties.
-
withProperty
public VehicleCreationTO withProperty(@Nonnull java.lang.String key, @Nonnull java.lang.String value)Creates a copy of this object and adds the given property. If value == null, then the key-value pair is removed from the properties.- Overrides:
withPropertyin classCreationTO- Parameters:
key- the key.value- the value- Returns:
- A copy of this object that either includes the given entry in it's current properties, if value != null or excludes the entry otherwise.
-
getLength
public int getLength()Returns the vehicle's length (in mm).- Returns:
- The vehicle's length (in mm).
-
withLength
Creates a copy of this object with the vehicle's given length (in mm).- Parameters:
length- The new length. Must be at least 1.- Returns:
- A copy of this object, differing in the given vehicle length.
-
getEnergyLevelCritical
public int getEnergyLevelCritical()Returns this vehicle's critical energy level (in percent of the maximum). The critical energy level is the one at/below which the vehicle should be recharged.- Returns:
- This vehicle's critical energy level.
-
withEnergyLevelCritical
Creates a copy of this object with the given critical energy level. The critical energy level is the one at/below which the vehicle should be recharged.- Parameters:
energyLevelCritical- The new critical energy level. Must not be smaller than 0 or greater than 100.- Returns:
- A copy of this object, differing in the given value.
-
getEnergyLevelGood
public int getEnergyLevelGood()Returns this vehicle's good energy level (in percent of the maximum). The good energy level is the one at/above which the vehicle can be dispatched again when charging.- Returns:
- This vehicle's good energy level.
-
withEnergyLevelGood
Creates a copy of this object with the vehicle's good energy level (in percent of the maximum). The good energy level is the one at/above which the vehicle can be dispatched again when charging.- Parameters:
energyLevelGood- The new good energy level. Must not be smaller than 0 or greater than 100.- Returns:
- A copy of this object, differing in the given value.
-
getEnergyLevelFullyRecharged
public int getEnergyLevelFullyRecharged()Returns this vehicle's fully recharged energy level (in percent of the maximum).- Returns:
- This vehicle's fully recharged energy level.
-
withEnergyLevelFullyRecharged
Creates a copy of this object with the vehicle's fully recharged energy level (in percent of the maximum).- Parameters:
energyLevelFullyRecharged- The new fully recharged energy level. Must not be smaller than 0 or greater than 100.- Returns:
- A copy of this object, differing in the given value.
-
getEnergyLevelSufficientlyRecharged
public int getEnergyLevelSufficientlyRecharged()Returns this vehicle's sufficiently recharged energy level (in percent of the maximum).- Returns:
- This vehicle's sufficiently recharged energy level.
-
withEnergyLevelSufficientlyRecharged
public VehicleCreationTO withEnergyLevelSufficientlyRecharged(int energyLevelSufficientlyRecharged)Creates a copy of this object with the vehicle's sufficiently recharged energy level (in percent of the maximum).- Parameters:
energyLevelSufficientlyRecharged- The new sufficiently recharged energy level. Must not be smaller than 0 or greater than 100.- Returns:
- A copy of this object, differing in the given value.
-
getMaxVelocity
public int getMaxVelocity() -
withMaxVelocity
Creates a copy of this object with the given maximum velocity (in mm/s).- Parameters:
maxVelocity- the new max velocity.- Returns:
- A copy of this object, differing in the given value.
-
getMaxReverseVelocity
public int getMaxReverseVelocity() -
withMaxReverseVelocity
Creates a copy of this object with the given maximum reverse velocity (in mm/s).- Parameters:
maxReverseVelocity- the new maximum reverse velocity.- Returns:
- A copy of this object, differing in the given value.
-
getEnvelopeKey
@Nullable public java.lang.String getEnvelopeKey()Returns the key for selecting the envelope to be used for resources the vehicle occupies.- Returns:
- The key for selecting the envelope to be used for resources the vehicle occupies.
-
withEnvelopeKey
Creates a copy of this object, with the given envelope key.- Parameters:
envelopeKey- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
getLayout
Returns the information regarding the grahical representation of this vehicle.- Returns:
- The information regarding the grahical representation of this vehicle.
-
withLayout
Creates a copy of this object, with the given layout.- Parameters:
layout- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
toString
public java.lang.String toString()- Overrides:
toStringin classjava.lang.Object
-