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

MotionManagerMsg Struct Reference

#include <MotionManagerMsg.h>

Inheritance diagram for MotionManagerMsg:

Inheritance graph
[legend]
List of all members.

Detailed Description

A small header that preceeds data sent by MotionManager between processes.

Definition at line 6 of file MotionManagerMsg.h.

Public Types

typedef unsigned short MC_ID
 the type to use when referring to MotionCommand ID's


Public Member Functions

 MotionManagerMsg ()
 constructor

virtual ~MotionManagerMsg ()
 virtual destructor

MC_ID getID () const
 Accessor for the id number, set by MotionManager::addMotion().


Static Public Attributes

const MC_ID invalid_MC_ID = static_cast<MC_ID>(-1)
 for errors and undefined stuff


Protected Member Functions

void clearID ()
 resets the mc_id to invalid_MC_ID


Private Types

enum  MsgType { addMotion, deleteMotion, unknown }
 Denotes what type of message this is. More...


Private Member Functions

void setAdd (MC_ID id)
 Sets up the header as an add motion message.

void setDelete (MC_ID id)
 Sets up the header as an erase motion message.


Private Attributes

enum MotionManagerMsg::MsgType type
 Denotes what type of message this is.

MC_ID mc_id
 The id of the MotionCommand this is in reference to.


Friends

class MotionManager

Member Typedef Documentation

typedef unsigned short MotionManagerMsg::MC_ID
 

the type to use when referring to MotionCommand ID's

Definition at line 8 of file MotionManagerMsg.h.

Member Enumeration Documentation

enum MotionManagerMsg::MsgType [private]
 

Denotes what type of message this is.

Enumeration values:
addMotion 
deleteMotion 
unknown 

Definition at line 31 of file MotionManagerMsg.h.

Constructor & Destructor Documentation

MotionManagerMsg::MotionManagerMsg (   )  [inline]
 

constructor

Definition at line 14 of file MotionManagerMsg.h.

References invalid_MC_ID, mc_id, type, and unknown.

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

virtual destructor

doesn't do anything, but don't remove it, otherwise this would no longer be a virtual base class

Definition at line 18 of file MotionManagerMsg.h.

Member Function Documentation

void MotionManagerMsg::clearID (   )  [inline, protected]
 

resets the mc_id to invalid_MC_ID

Definition at line 25 of file MotionManagerMsg.h.

References invalid_MC_ID, and mc_id.

MC_ID MotionManagerMsg::getID (   )  const [inline]
 

Accessor for the id number, set by MotionManager::addMotion().

Definition at line 21 of file MotionManagerMsg.h.

References mc_id, and MC_ID.

void MotionManagerMsg::setAdd (  MC_ID  id  )  [inline, private]
 

Sets up the header as an add motion message.

Definition at line 37 of file MotionManagerMsg.h.

References addMotion, mc_id, MC_ID, and type.

void MotionManagerMsg::setDelete (  MC_ID  id  )  [inline, private]
 

Sets up the header as an erase motion message.

Definition at line 43 of file MotionManagerMsg.h.

References deleteMotion, mc_id, MC_ID, and type.

Friends And Related Function Documentation

friend class MotionManager [friend]
 

Definition at line 28 of file MotionManagerMsg.h.

Member Data Documentation

const MC_ID MotionManagerMsg::invalid_MC_ID = static_cast<MC_ID>(-1) [static]
 

for errors and undefined stuff

Definition at line 11 of file MotionManagerMsg.h.

MC_ID MotionManagerMsg::mc_id [private]
 

The id of the MotionCommand this is in reference to.

Definition at line 34 of file MotionManagerMsg.h.

enum MotionManagerMsg::MsgType MotionManagerMsg::type [private]
 

Denotes what type of message this is.

The documentation for this struct was generated from the following file:
Tekkotsu v1.5
 		Generated Fri Oct 10 15:57:00 2003 by Doxygen 1.3.4