Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

EStopControllerBehavior Class Reference

#include <EStopControllerBehavior.h>

Inheritance diagram for EStopControllerBehavior:

List of all members.


Detailed Description

Listens to control commands coming in from the command port for remotely controlling the head.

Definition at line 14 of file EStopControllerBehavior.h.


Public Member Functions

 EStopControllerBehavior (MotionManager::MC_ID estop)
 constructor
virtual ~EStopControllerBehavior ()
 destructor
virtual void DoStart ()
 By default, merely adds to the reference counter (through AddReference()); Note you should still call this from your overriding methods.
virtual void DoStop ()
 By default, subtracts from the reference counter (RemoveReference()), and thus may deletex if zero; Don't forget to still call this when you override this; Warning: call this at the end of your DoStop(), not beginning (it might delete this ).
virtual void processEvent (const EventBase &)
 By defining here, allows you to get away with not supplying a processEvent() function for the EventListener interface. By default, does nothing.
virtual std::string getDescription () const
 Gives a short description of what this particular instantiation does (in case a more specific description is needed on an individual basis).
virtual void runCommand (const std::string &s)
 processes a string received from wireless

Static Public Member Functions

static int callback (char *buf, int bytes)
 called by wireless when there's new data
static std::string getClassDescription ()
 Gives a short description of what this class of behaviors does... you should override this (but don't have to).

Static Public Attributes

static EStopControllerBehaviortheOne = NULL
 Points to the one EStopControllerBehavior object that the input command stream is talking to.

Protected Attributes

Socketcmdsock
 The input command stream socket.
MotionManager::MC_ID estop_id
 The estop to control.

Private Member Functions

 EStopControllerBehavior (const EStopControllerBehavior &)
 don't call
EStopControllerBehavior operator= (const EStopControllerBehavior &)
 don't call

Constructor & Destructor Documentation

EStopControllerBehavior::EStopControllerBehavior ( MotionManager::MC_ID  estop  )  [inline]

constructor

Definition at line 24 of file EStopControllerBehavior.h.

virtual EStopControllerBehavior::~EStopControllerBehavior (  )  [inline, virtual]

destructor

Definition at line 32 of file EStopControllerBehavior.h.

EStopControllerBehavior::EStopControllerBehavior ( const EStopControllerBehavior  )  [private]

don't call


Member Function Documentation

int EStopControllerBehavior::callback ( char *  buf,
int  bytes 
) [static]

called by wireless when there's new data

Definition at line 56 of file EStopControllerBehavior.cc.

Referenced by DoStart().

void EStopControllerBehavior::DoStart (  )  [virtual]

By default, merely adds to the reference counter (through AddReference()); Note you should still call this from your overriding methods.

Reimplemented from BehaviorBase.

Definition at line 7 of file EStopControllerBehavior.cc.

void EStopControllerBehavior::DoStop (  )  [virtual]

By default, subtracts from the reference counter (RemoveReference()), and thus may deletex if zero; Don't forget to still call this when you override this; Warning: call this at the end of your DoStop(), not beginning (it might delete this ).

Reimplemented from BehaviorBase.

Definition at line 19 of file EStopControllerBehavior.cc.

void EStopControllerBehavior::processEvent ( const EventBase  )  [virtual]

By defining here, allows you to get away with not supplying a processEvent() function for the EventListener interface. By default, does nothing.

Reimplemented from BehaviorBase.

Definition at line 47 of file EStopControllerBehavior.cc.

static std::string EStopControllerBehavior::getClassDescription (  )  [inline, static]

Gives a short description of what this class of behaviors does... you should override this (but don't have to).

If you do override this, also consider overriding getDescription() to return it

Reimplemented from BehaviorBase.

Definition at line 42 of file EStopControllerBehavior.h.

Referenced by getDescription().

virtual std::string EStopControllerBehavior::getDescription (  )  const [inline, virtual]

Gives a short description of what this particular instantiation does (in case a more specific description is needed on an individual basis).

By default simply returns getName(), because any calls from a BehaviorBase function to getClassDescription() are going to call BehaviorBase::getClassDescription(), not ~YourSubClass~getClassDescription(), because static functions can't be virtual in C++ (doh!)

This means that getDescription called on a pointer to a BehaviorBase of unknown subtype would always return an empty string, which is pretty useless. So instead we return the name in this situation. If you want getDescription to return getClassDescription, you'll have to override it in your subclass to do so.

Reimplemented from BehaviorBase.

Definition at line 47 of file EStopControllerBehavior.h.

void EStopControllerBehavior::runCommand ( const std::string &  s  )  [virtual]

processes a string received from wireless

Definition at line 29 of file EStopControllerBehavior.cc.

Referenced by callback().

EStopControllerBehavior EStopControllerBehavior::operator= ( const EStopControllerBehavior  )  [private]

don't call


Member Data Documentation

Points to the one EStopControllerBehavior object that the input command stream is talking to.

A kludge. Dunno how you're gonna make sure you're not using this uninitialized.

Definition at line 19 of file EStopControllerBehavior.h.

Referenced by EStopControllerBehavior(), and ~EStopControllerBehavior().

The input command stream socket.

Definition at line 53 of file EStopControllerBehavior.h.

Referenced by DoStart(), DoStop(), processEvent(), and runCommand().

The estop to control.

Definition at line 56 of file EStopControllerBehavior.h.

Referenced by runCommand().


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

Tekkotsu v4.0
Generated Thu Nov 22 00:58:18 2007 by Doxygen 1.5.4