ReleaseTransporter

Releases the transporter previously seized by the SeizeTransporter block.

Different policies are available to define the transporter's actions after release (this setting is configured by the Transporter parameter). It can return to its current home location node, move to the nearest home location node (if several nodes were specified in the TransporterFleet block), move to any other specified location or remain where it is.

Transporter can return to the specified location every time it is released and only then move to perform the next task, or it can prioritize the performance of the task (if there is one) over the return to the specified location.

The release operation takes zero time.

Note: All seized transporters must be released before the agent is disposed by the Sink block.

Demo model: SeizeTransporter and ReleaseTransporter

Parameters

Transporter [dynamic]
Defines the behaviour of the released transporter. Depending on your choice, the transporter can:
Type of value: ReleaseTransporter.TransporterReleaseMovingPolicy
Valid values: Returns to current home location - ReleaseTransporter.MP_RETURNS_TO_HOME
                     Returns to the nearest location - ReleaseTransporter.MP_RETURNS_TO_NEAREST_HOME
                     Goes to... - ReleaseTransporter.MP_GO_TO
                     Stays where it is - ReleaseTransporter.MP_STAYS_WHERE_IT_IS
Local variable: Agent unit - the transporter that is currently released by the block
Destination is
Defines where the transporter will move after being released. The possible destinations are:
Node - transporter moves to the specified network node.
Attractor
- transporter moves to the specified attractor.
Path - transporter moves to the specified path.
Conveyor - transporter moves to the specified conveyor.
Position on conveyor - transporter moves to the specified position on conveyor.
Conveyor station - transporter moves to the specified station.
(x, y, z) - transporter moves to the point with the specified coordinates.
Syntax: DestinationType destinationType
Valid values: ReleaseTransporterReleaseTransporter.DEST_NODE; ReleaseTransporter.DEST_ATTRACTOR; ReleaseTransporter.DEST_PATH; ReleaseTransporter.DEST_CONVEYOR; ReleaseTransporter.DEST_POSITION_ON_CONVEYOR; ReleaseTransporter.DEST_CONVEYOR_STATION; ReleaseTransporter.DEST_XYZ
Node [dynamic]
[Visible and applies only if the Destination is option is set to Node] The network node the transporter will move to.
Type of value: Node
Local variables: Agent unit - the transporter
Attractor [dynamic]
[Visible and applies only if the Destination is option is set to Attractor] The attractor the transporter will move to.
Type of value: Attractor
Local variables: Agent unit - the transporter
Path [dynamic]
[Visible and applies only if the Destination is option is set to Path] The path the transporter will move to.
Type of value: Path
Local variables: Agent unit - the transporter
Conveyor [dynamic]
[Visible and applies only if the Destination is option is set to Conveyor] The conveyor the transporter will move to.
Type of value: ConveyorPath
Local variables: Agent unit - the transporter
Offset from [dynamic]
[Visible and applies only if the Destination is option is set to Path or Conveyor] Defines how to calculate the offset of the exact point on a path or a conveyor the transporter will move to: from The beginning of the conveyor/path, or from The end of the conveyor/path.
Type of value: boolean
Local variables: Agent unit - the transporter
Offset [dynamic]
[Visible and applies only if the Destination is option is set to Path or Conveyor] The distance from the start or end point of the path/conveyor (depends on the Offset from parameter) defining the exact destination point for the transporter.
Type of value: double
Local variables: Agent unit - the transporter
Position on conveyor [dynamic]
[Visible and applies only if the Destination is option is set to Position on conveyor] The position on conveyor the transporter will move to.
Type of value: PositionOnConveyor
Local variables: Agent unit - the transporter
Conveyor station [dynamic]
[Visible and applies only if the Destination is option is set to Conveyor station] The station the transporter will move to.
Type of value: ConveyorStation
Local variables: Agent unit - the transporter
X, Y, Z [dynamic]
[Visible and applies only if the Destination is option is set to (x, y, z)] X, Y, Z coordinates of the point the transporter will move to.
Type of value: double
Local variables: Agent unit - the transporter
... located in [dynamic]
[Visible and applies only if the Destination is option is set to (x, y, z)] Specifies where the the transporter will be added to after the release: either Level or Network.
Type of value: boolean destinationInNetwork
Default value: false
Level [dynamic]
[Visible and applies only if the ...located in Level option is selected] The level the transporter will be added to once it is released.
Type of value: Level
Local variables: Agent unit - the transporter
Network [dynamic]
[Visible and applies only if the ...located in Network option is selected] The network the transporter will be added to once it is released.
Type of value: INetwork
Local variables: Agent unit - the transporter
Returns [dynamic]
[Visible and applies if any of the return options is selected in the Transporter parameter] Defines the policy of the transporter's return after the release. It can either proceed to perform the next task (if there is one) and return only when no tasks are left for it or always return to the specified location and only then move to perform the next task.
Type of value: ReleaseTransporter.TransporterReleaseReturnPolicy
Valid values: if no other tasks - ReleaseTransporter.RP_IF_NO_OTHER_TASKS
each time - ReleaseTransporter.RP_EACH_TIME
Local variable: T unit - the transporter that is currently released by the block
Actions
On enter [code]
Here you can type Java code to be executed when an agent enters the block.
Local variable: T agent - the agent that just entered the block
On release transporter [code]
Here you can type Java code to be executed when the transporter has been released.
Local variables: Agent agent - the agent that is releasing the transporter
T unit - the transporter being released
On exit [code]
Here you can type Java code to be executed when an agent exits the block.
Local variable: Agent agent - the agent that is exiting the block currently

Ports

in
The input port.
out
The output port.