com.kuka.nav.fleet
Class Plan

java.lang.Object
  com.kuka.nav.fleet.Plan

public class Plan
extends Object

Represents a plan of a single robot. A plan consists of a list of PlanSteps. Furthermore, it provides access to the MobileRobot that is supposed to execute the plan.

Constructor Summary

Plan(List<PlanStep> planSteps, com.kuka.nav.robot.MobileRobot robot)
Constructor.

Method Summary

List<PlanStep>	getPlanSteps() Gets an unmodifiable view of this plan's list of PlanSteps.
com.kuka.nav.robot.MobileRobot	getRobot() Gets the MobileRobot executing this plan.
boolean	isFirstStep(TopologyNode node) Deprecated. (since 1.11, reason: it is simpler to retrieve node from first plan step and compare them directly, refactoring advice: use getPlanSteps() and PlanStep.getNode() to access node of first plan step directly).
boolean	isLastStep(TopologyNode node) Deprecated. (since 1.11, reason: it is simpler to retrieve node from last plan step and compare them directly, refactoring advice: use getPlanSteps() and PlanStep.getNode() to access node of last plan step directly).
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Plan

public Plan(List<PlanStep> planSteps,
            com.kuka.nav.robot.MobileRobot robot)

Constructor.

Parameters:

planSteps - a list of PlanSteps that should be added to this plan

robot - the robot to execute this plan

Method Detail

getRobot

public com.kuka.nav.robot.MobileRobot getRobot()

Gets the MobileRobot executing this plan.

Returns:

the robot.

getPlanSteps

public List<PlanStep> getPlanSteps()

Gets an unmodifiable view of this plan's list of PlanSteps.

Returns:

the list of step.

isFirstStep

@Deprecated
public boolean isFirstStep(TopologyNode node)

Deprecated. (since 1.11, reason: it is simpler to retrieve node from first plan step and compare them directly, refactoring advice: use getPlanSteps() and PlanStep.getNode() to access node of first plan step directly).

Returns true if and only if the first step of this plan visits the given topology node instance.

Parameters:

node - the node

Returns:

true if and only if the given node is the first one visited in this plan.

isLastStep

@Deprecated
public boolean isLastStep(TopologyNode node)

Deprecated. (since 1.11, reason: it is simpler to retrieve node from last plan step and compare them directly, refactoring advice: use getPlanSteps() and PlanStep.getNode() to access node of last plan step directly).

Returns true if and only if the last step of this plan visits the given topology node instance.

Parameters:

node - the node

Returns:

true if and only if the given node is the last one visited is this plan.

toString

public String toString()

Overrides:

toString in class Object