Public Member Functions | Private Member Functions | Private Attributes | List of all members
nextage_ros_bridge.command.abs_hand_command.AbsractHandCommand Class Reference
Inheritance diagram for nextage_ros_bridge.command.abs_hand_command.AbsractHandCommand:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, hands, hand, dio_pins)
 
def execute (self, operation)
 

Private Member Functions

def _assign_dio_names (self, dio_pins)
 

Private Attributes

 _hand
 
 _hands
 

Detailed Description

Following Command design pattern, this class represents an abstract
command for hand classes of NEXTAGE OPEN.

Definition at line 40 of file abs_hand_command.py.

Constructor & Destructor Documentation

def nextage_ros_bridge.command.abs_hand_command.AbsractHandCommand.__init__ (   self,
  hands,
  hand,
  dio_pins 
)
@type hands: nextage_ros_bridge.base_hands.BaseHands
@type hand: str
@param hand: Side of hand. Variables that are defined in
     nextage_ros_bridge.base_hands.BaseHands can be used
     { HAND_L, HAND_R }.
@type dio_pins: [int]
@param dio_pins: List of DIO pins that are used in each HandCommand
         class. The order is important; it needs be defined
         in subclasses.

Definition at line 47 of file abs_hand_command.py.

Member Function Documentation

def nextage_ros_bridge.command.abs_hand_command.AbsractHandCommand._assign_dio_names (   self,
  dio_pins 
)
private
It's recommended in the derived classes to re-assign DIO names to
better represent the specific purposes of each DIO pin in there.
Since doing so isn' mandatory, this method doesn't emit error even when
it's not implemented.
@type dio_pins: [int]
@param dio_pins: List of DIO pins that are used in each HandCommand
         class. The order is important; it needs be defined
         in subclasses.

Definition at line 78 of file abs_hand_command.py.

def nextage_ros_bridge.command.abs_hand_command.AbsractHandCommand.execute (   self,
  operation 
)
Needs overriddedn, otherwise expcetion occurs.

@type operation: str
@param operation: name of the operation.
@rtype: bool
@return: True if dout was writtable to the register. False otherwise.

@raise exception: RuntimeError

Definition at line 63 of file abs_hand_command.py.

Member Data Documentation

nextage_ros_bridge.command.abs_hand_command.AbsractHandCommand._hand
private

Definition at line 60 of file abs_hand_command.py.

nextage_ros_bridge.command.abs_hand_command.AbsractHandCommand._hands
private

Definition at line 59 of file abs_hand_command.py.


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


nextage_ros_bridge
Author(s): Isaac Isao Saito , Akio Ochiai
autogenerated on Wed Jun 17 2020 04:14:47