RSeries astromech firmware
InterchangeArm Class Reference

#include <body/InterchangeArm.h>

Detailed Description

Base class for Zapper, Gripper, and Welder.

+ Inheritance diagram for InterchangeArm:
+ Collaboration diagram for InterchangeArm:

Public Member Functions

 InterchangeArm (byte idPin)
 
bool isArmed ()
 
void arm ()
 Arm. More...
 
void disarm ()
 Disarm. More...
 
virtual void on ()
 
virtual void off ()
 
virtual void handleCommand (const char *cmd) override
 Interchangable Arm Commands start with 'XC'. More...
 
- Public Member Functions inherited from CommandEvent
 CommandEvent ()
 Default Constructor. More...
 
virtual void handleCommand (String cmd)
 Subclasses should implement this function to process commands specific to their device. More...
 

Protected Attributes

bool fArmed
 

Additional Inherited Members

- Static Public Member Functions inherited from CommandEvent
static void process (char *cmd)
 Calls handleCommand() for each created CommandEvent subclass. More...
 
static void process (const char *cmd)
 Calls handleCommand() for each created CommandEvent subclass. More...
 
static void process (PROGMEMString pcmd)
 Calls handleCommand() for each created CommandEvent subclass. More...
 

Constructor & Destructor Documentation

◆ InterchangeArm()

InterchangeArm::InterchangeArm ( byte  idPin)
inline

Member Function Documentation

◆ arm()

void InterchangeArm::arm ( )
inline

Arm.

Extra step to make sure arm is not fired while inside the body.

◆ disarm()

void InterchangeArm::disarm ( )
inline

Disarm.

Extra step to make sure arm is not fired while inside the body.

◆ handleCommand()

virtual void InterchangeArm::handleCommand ( const char *  cmd)
inlineoverridevirtual

Interchangable Arm Commands start with 'XC'.

Implements CommandEvent.

◆ isArmed()

bool InterchangeArm::isArmed ( )
inline

◆ off()

virtual void InterchangeArm::off ( )
virtual

◆ on()

virtual void InterchangeArm::on ( )
virtual

Member Data Documentation

◆ fArmed

bool InterchangeArm::fArmed
protected

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