yocs_ar_pair_approach.rotate.Rotate Class Reference

Classes. More...

Inheritance diagram for yocs_ar_pair_approach.rotate.Rotate:

Public Member Functions
def	__init__ (self, cmd_vel_topic)
def	change_direction (self)
def	execute (self)
def	init (self, yaw_absolute_rate=1.2, yaw_direction=CLOCKWISE)
def	is_running (self)
def	is_stopped (self)
def	shutdown (self)
def	stop (self)

Public Attributes
	yaw_absolute_rate
	yaw_direction

Static Public Attributes
int	CLOCKWISE = -1
int	COUNTER_CLOCKWISE = 1

Private Attributes
	_cmd_vel_frequency
	_cmd_vel_publisher
	_cmd_vel_topic
	_initialise_pose_trigger
	_rate
	_running
	_stop
	_twist

Static Private Attributes
list	__slots__

Detailed Description

Classes.

    implements a rotating motion.

Definition at line 20 of file rotate.py.

Constructor & Destructor Documentation

def yocs_ar_pair_approach.rotate.Rotate.__init__	(		self,
			cmd_vel_topic
	)

Definition at line 40 of file rotate.py.

Member Function Documentation

def yocs_ar_pair_approach.rotate.Rotate.change_direction

(

self

)

Definition at line 75 of file rotate.py.

def yocs_ar_pair_approach.rotate.Rotate.execute

(

self

)

  Drop this into threading.Thread or QThread for execution

Definition at line 87 of file rotate.py.

def yocs_ar_pair_approach.rotate.Rotate.init	(		self,
			yaw_absolute_rate = 1.2,
			yaw_direction = CLOCKWISE
	)

  Initialise the direction and rate the robot should rotate at.

Definition at line 60 of file rotate.py.

def yocs_ar_pair_approach.rotate.Rotate.is_running

(

self

)

Definition at line 72 of file rotate.py.

def yocs_ar_pair_approach.rotate.Rotate.is_stopped

(

self

)

Definition at line 81 of file rotate.py.

def yocs_ar_pair_approach.rotate.Rotate.shutdown

(

self

)

Definition at line 67 of file rotate.py.

def yocs_ar_pair_approach.rotate.Rotate.stop

(

self

)

Definition at line 84 of file rotate.py.

Member Data Documentation

list yocs_ar_pair_approach.rotate.Rotate.__slots__

staticprivate

Initial value:

= [
            'yaw_absolute_rate',
            'yaw_direction',  # +1, or -1
            '_stop',
            '_cmd_vel_topic',
            '_cmd_vel_publisher',
            '_cmd_vel_frequency',
            '_rate',
            '_running',
            '_twist',
            '_listener',
            '_initialise_pose_trigger'  # tell the initial pose manager to grab an initialisation
        ]

Definition at line 24 of file rotate.py.

yocs_ar_pair_approach.rotate.Rotate._cmd_vel_frequency

private

Definition at line 42 of file rotate.py.

yocs_ar_pair_approach.rotate.Rotate._cmd_vel_publisher

private

Definition at line 41 of file rotate.py.

yocs_ar_pair_approach.rotate.Rotate._cmd_vel_topic

private

Definition at line 43 of file rotate.py.

yocs_ar_pair_approach.rotate.Rotate._initialise_pose_trigger

private

Definition at line 47 of file rotate.py.

yocs_ar_pair_approach.rotate.Rotate._rate

private

Definition at line 44 of file rotate.py.

yocs_ar_pair_approach.rotate.Rotate._running

private

Definition at line 46 of file rotate.py.

yocs_ar_pair_approach.rotate.Rotate._stop

private

Definition at line 45 of file rotate.py.

yocs_ar_pair_approach.rotate.Rotate._twist

private

Definition at line 56 of file rotate.py.

int yocs_ar_pair_approach.rotate.Rotate.CLOCKWISE = -1

static

Definition at line 37 of file rotate.py.

int yocs_ar_pair_approach.rotate.Rotate.COUNTER_CLOCKWISE = 1

static

Definition at line 38 of file rotate.py.

yocs_ar_pair_approach.rotate.Rotate.yaw_absolute_rate

Definition at line 64 of file rotate.py.

yocs_ar_pair_approach.rotate.Rotate.yaw_direction

Definition at line 65 of file rotate.py.

---

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

• rotate.py