Homepage Demos Overview Downloads Tutorials Reference
Credits
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members | Related Pages | Search

EStopControllerBehavior Class Reference

#include <EStopControllerBehavior.h>

Inheritance diagram for EStopControllerBehavior:

Inheritance graph
[legend]
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, and deletes if zero
Note:
you should 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 &)
 Allows you to get away with not supplying a processEvent() function for the EventListener interface. By default, does nothing.

virtual std::string getName () const
 Identifies the behavior in menus and such.

virtual void runCommand (std::string s)

Static Public Member Functions

int callback (char *buf, int bytes)
 called by wireless when there's new data

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

EStopControllerBehavior * theOne = NULL

Protected Attributes

Socket * cmdsock
 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 25 of file EStopControllerBehavior.h.

References cmdsock, estop_id, SocketNS::SOCK_STREAM, theOne, and wireless.

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

destructor

Definition at line 33 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 53 of file EStopControllerBehavior.cc.

References runCommand(), and theOne.

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.

References EventRouter::addListener(), callback(), cmdsock, config, BehaviorBase::DoStart(), erouter, Config::main_config::estopControl_port, EventBase::estopEGID, Wireless::listen(), Config::main, Wireless::setReceiver(), Socket::sock, and wireless.

void EStopControllerBehavior::DoStop (   )  [virtual]
 

By default, subtracts from the reference counter, and deletes if zero

Note:
you should 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 17 of file EStopControllerBehavior.cc.

References Wireless::close(), cmdsock, BehaviorBase::DoStop(), erouter, EventRouter::forgetListener(), and wireless.

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).

Reimplemented from BehaviorBase.

Definition at line 42 of file EStopControllerBehavior.h.

References config, Config::main_config::estopControl_port, and Config::main.

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

Identifies the behavior in menus and such.

Implements BehaviorBase.

Definition at line 41 of file EStopControllerBehavior.h.

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

don't call

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

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 44 of file EStopControllerBehavior.cc.

References EventBase::activateETID, cmdsock, EventBase::deactivateETID, EventBase::getTypeID(), and Socket::printf().

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

Definition at line 26 of file EStopControllerBehavior.cc.

References MMAccessor< MC_t >::checkin(), cmdsock, estop_id, Socket::printf(), and serr.

Member Data Documentation

Socket* EStopControllerBehavior::cmdsock [protected]
 

The input command stream socket.

Definition at line 52 of file EStopControllerBehavior.h.

MotionManager::MC_ID EStopControllerBehavior::estop_id [protected]
 

The estop to control.

Definition at line 55 of file EStopControllerBehavior.h.

EStopControllerBehavior * EStopControllerBehavior::theOne = NULL [static]
 

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 5 of file EStopControllerBehavior.cc.

The documentation for this class was generated from the following files:
Tekkotsu v1.4
 		Generated Sat Jul 19 00:08:55 2003 by Doxygen 1.3.2