Package org.opentcs.access.to.model
Class LocationCreationTO
java.lang.Object
org.opentcs.access.to.CreationTO
org.opentcs.access.to.model.LocationCreationTO
- All Implemented Interfaces:
Serializable
A transfer object describing a location in a plant model.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Contains information regarding the grahical representation of a location. -
Constructor Summary
ConstructorsConstructorDescriptionLocationCreationTO
(String name, String typeName, Triple position) Creates a new instance. -
Method Summary
Modifier and TypeMethodDescriptionReturns the information regarding the grahical representation of this location.getLinks()
Returns the links attaching points to this location.Returns the position of this location (in mm).Returns the name of this location's type.boolean
isLocked()
Returns the lock status of this location (i.e.toString()
withLayout
(LocationCreationTO.Layout layout) Creates a copy of this object, with the given layout.Creates a copy of this object with the given links that attach points to this location.Creates a copy of this object with the given links that attach points to this location.withLocked
(boolean locked) Creates a copy of this object with the given locked flag.Creates a copy of this object with the given name.withPosition
(Triple position) Creates a copy of this object with the given position (in mm).withProperties
(Map<String, String> properties) Creates a copy of this object with the given properties.withProperty
(String key, String value) Creates a copy of this object and adds the given property.withTypeName
(String typeName) Creates a copy of this object with the location's type.Methods inherited from class org.opentcs.access.to.CreationTO
getModifiableProperties, getName, getProperties, listWithAppendix, mapWithMapping, propertiesWith
-
Constructor Details
-
LocationCreationTO
Creates a new instance.- Parameters:
name
- The name of this location.typeName
- The name of this location's type.position
- The position of this location.
-
-
Method Details
-
withName
Creates a copy of this object with the given name.- Overrides:
withName
in classCreationTO
- Parameters:
name
- The new name.- Returns:
- A copy of this object, differing in the given name.
-
getTypeName
Returns the name of this location's type.- Returns:
- The name of this location's type.
-
withTypeName
Creates a copy of this object with the location's type.- Parameters:
typeName
- The location type.- Returns:
- A copy of this object, differing in the given type.
-
getPosition
Returns the position of this location (in mm).- Returns:
- The position of this location (in mm).
-
withPosition
Creates a copy of this object with the given position (in mm).- Parameters:
position
- the new position of this location (in mm).- Returns:
- A copy of this object, differing in the given position.
-
getLinks
Returns the links attaching points to this location. This is a map of point names to allowed operations.- Returns:
- The links attaching points to this location.
-
withLinks
Creates a copy of this object with the given links that attach points to this location.- Parameters:
links
- the new links. This is supposed to be a map of point names to allowed operations.- Returns:
- A copy of this object, differing in the given links.
-
withLink
public LocationCreationTO withLink(@Nonnull String pointName, @Nonnull Set<String> allowedOperations) Creates a copy of this object with the given links that attach points to this location.- Parameters:
pointName
- The name of the point linked to.allowedOperations
- The operations allowed at the point.- Returns:
- A copy of this object, differing in the given link.
-
isLocked
public boolean isLocked()Returns the lock status of this location (i.e. whether it my be used by vehicles or not).- Returns:
true
if this location is currently locked (i.e. it may not be used by vehicles), elsefalse
.
-
withLocked
Creates a copy of this object with the given locked flag.- Parameters:
locked
- The new locked attribute.- Returns:
- A copy of this object, differing in the locked attribute.
-
withProperties
Creates a copy of this object with the given properties.- Overrides:
withProperties
in classCreationTO
- Parameters:
properties
- The new properties.- Returns:
- A copy of this object, differing in the given properties.
-
withProperty
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:
withProperty
in 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.
-
getLayout
Returns the information regarding the grahical representation of this location.- Returns:
- The information regarding the grahical representation of this location.
-
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
-