routine_behaviours.patrol_routine.PatrolRoutine Class Reference

Inheritance diagram for routine_behaviours.patrol_routine.PatrolRoutine:

Public Member Functions
def	__init__
def	all_waypoints (self)
def	all_waypoints_except
def	create_patrol_routine
def	create_routine (self)
def	get_nodes (self)
def	map_callback (self, msg)
def	max_single_trip_time (self, waypoints)
def	on_idle (self)
Public Member Functions inherited from routine_behaviours.robot_routine.RobotRoutine
def	__init__
def	add_night_task (self, task)
def	battery_ok (self)
def	clear_then_charge (self, charge_duration)
def	create_task_routine
def	demand_charge (self, charge_duration)
def	dynamic_reconfigure_cb (self, config, level)
def	is_after_day_end (self, time)
def	is_before_day_start (self, time)
def	is_during_day (self, time)
def	on_day_end (self)
def	on_day_start (self)
def	on_idle (self)
def	start_routine (self)
def	task_allowed_now (self, task)

Public Attributes
	node_names
	random_nodes
	tour_duration_estimate
Public Attributes inherited from routine_behaviours.robot_routine.RobotRoutine
	add_tasks
	addition
	battery_count
	battery_count_thres
	battery_state
	charge_window
	charging_point
	clear_schedule
	daily_end
	daily_start
	demand_task
	force_charge_duration
	idle_charge_duration
	idle_count
	idle_thres
	maps_msg_store
	night_duration
	night_tasks
	recfg_sever
	routine
	runner
	sent_night_tasks
	sent_to_charge
	set_execution_status
	threshold

Detailed Description

Creates a routine which simply visits nodes. 

Definition at line 24 of file patrol_routine.py.

Constructor & Destructor Documentation

def routine_behaviours.patrol_routine.PatrolRoutine.__init__	(		self,
			daily_start,
			daily_end,
			tour_duration_estimate = None,
			idle_duration = rospy.Duration(5),
			charging_point = 'ChargingPoint'
	)

Definition at line 27 of file patrol_routine.py.

Member Function Documentation

def routine_behaviours.patrol_routine.PatrolRoutine.all_waypoints

(

self

)

Definition at line 48 of file patrol_routine.py.

def routine_behaviours.patrol_routine.PatrolRoutine.all_waypoints_except	(		self,
			exceptions = []
	)

Definition at line 51 of file patrol_routine.py.

def routine_behaviours.patrol_routine.PatrolRoutine.create_patrol_routine	(		self,
			waypoints = None,
			daily_start = None,
			daily_end = None,
			repeat_delta = None
	)

Definition at line 69 of file patrol_routine.py.

def routine_behaviours.patrol_routine.PatrolRoutine.create_routine

(

self

)

Definition at line 86 of file patrol_routine.py.

def routine_behaviours.patrol_routine.PatrolRoutine.get_nodes

(

self

)

Definition at line 41 of file patrol_routine.py.

def routine_behaviours.patrol_routine.PatrolRoutine.map_callback	(		self,
			msg
	)

Definition at line 35 of file patrol_routine.py.

def routine_behaviours.patrol_routine.PatrolRoutine.max_single_trip_time	(		self,
			waypoints
	)

Definition at line 55 of file patrol_routine.py.

def routine_behaviours.patrol_routine.PatrolRoutine.on_idle

(

self

)

    Called when the routine is idle. Default is to trigger travel to the charging. As idleness is determined by the current schedule, if this call doesn't utlimately cause a task schedule to be generated this will be called repeatedly.

Definition at line 92 of file patrol_routine.py.

Member Data Documentation

routine_behaviours.patrol_routine.PatrolRoutine.node_names

Definition at line 30 of file patrol_routine.py.

routine_behaviours.patrol_routine.PatrolRoutine.random_nodes

Definition at line 33 of file patrol_routine.py.

routine_behaviours.patrol_routine.PatrolRoutine.tour_duration_estimate

Definition at line 31 of file patrol_routine.py.

---

The documentation for this class was generated from the following file:

• patrol_routine.py