nextage_ros_bridge.command.handlight_command.HandlightCommand Class Reference

Inheritance diagram for nextage_ros_bridge.command.handlight_command.HandlightCommand:

Public Member Functions
def	__init__ (self, hands, hand, dio_pins)
def	execute (self, operation)
def	turn_handlight (self, hand=None, on=True)

Public Attributes
	HANDLIGHT_ON

Static Public Attributes
bool	HANDLIGHT_OFF = False
bool	HANDLIGHT_ON = True

Private Member Functions
def	_assign_dio_names (self, dio_pins)

Private Attributes
	_DIO_LHAND
	_DIO_RHAND

Detailed Description

Following Command design pattern, this class represents commands
for turning hand lights.

Definition at line 40 of file handlight_command.py.

Constructor & Destructor Documentation

def nextage_ros_bridge.command.handlight_command.HandlightCommand.__init__	(		self,
			hands,
			hand,
			dio_pins
	)

Definition at line 50 of file handlight_command.py.

Member Function Documentation

def nextage_ros_bridge.command.handlight_command.HandlightCommand._assign_dio_names (   self,   dio_pins  )

private

@see abs_hand_command.AbsractHandCommand._assign_dio_names

Definition at line 53 of file handlight_command.py.

def nextage_ros_bridge.command.handlight_command.HandlightCommand.execute	(		self,
			operation
	)

@see abs_hand_command.AbsractHandCommand.execute

@param operation: param type:
          - 'True': Turn the light on.
          - 'False': Turn the light off.
@rtype: bool
@return: True if digital out was writable to the register.
 False otherwise.

Definition at line 60 of file handlight_command.py.

def nextage_ros_bridge.command.handlight_command.HandlightCommand.turn_handlight	(		self,
			hand = None,
			on = True
	)

@param hand: Both hands if None.
@type on: bool
@param on: Despite its type, it's handled as str in this method.
@rtype: bool
@return: True if the lights turned. False otherwise.

Definition at line 89 of file handlight_command.py.

Member Data Documentation

nextage_ros_bridge.command.handlight_command.HandlightCommand._DIO_LHAND

private

Definition at line 57 of file handlight_command.py.

nextage_ros_bridge.command.handlight_command.HandlightCommand._DIO_RHAND

private

Definition at line 58 of file handlight_command.py.

bool nextage_ros_bridge.command.handlight_command.HandlightCommand.HANDLIGHT_OFF = False

static

Definition at line 48 of file handlight_command.py.

bool nextage_ros_bridge.command.handlight_command.HandlightCommand.HANDLIGHT_ON = True

static

Definition at line 47 of file handlight_command.py.

nextage_ros_bridge.command.handlight_command.HandlightCommand.HANDLIGHT_ON

Definition at line 73 of file handlight_command.py.

---

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

• handlight_command.py