Main Page   Hardware Class Hierarchy   Hardware API     Mapping Class Hierarchy  Mapping API 

IR_chain Class Reference

A class representing a list of IRs mounted on a mobile robot. More...

#include <ir_chain.h>

Inheritance diagram for IR_chain:

chain

Public Member Functions

 IR_chain (void)
bool append (IR_base *)
 append a command structure.

IR_baseserve (void)
 Returns next motion to be executed on list.

IR_baseoperator[] (int) const
 Accessor operator.

IR_basereserve (void)
 Reserve the same was as was just served.

void clear (void)
 Resets the list and command execution index.

void set (int)
 Sets the command execution index value.

int size () const
 Returns current size of structure.

int execute () const
 Returns the current index value.


Protected Attributes

IR_base_ir_chain [IR_CHAIN_MAX]
int _top
int _next

Private Member Functions

void init (void)

Friends

class mission_profile

Detailed Description

A class representing a list of IRs mounted on a mobile robot.

Remarks
Using a pointer as we don't actually take up space for all the IR_bases; only a pointer max. Also, it eliminates the need to also put in an count or in_use flag.


Constructor & Destructor Documentation

IR_chain void   ) 
 


Member Function Documentation

bool append IR_base  ) 
 

append a command structure.

void clear void   )  [inherited]
 

Resets the list and command execution index.

int execute  )  const [inherited]
 

Returns the current index value.

void init void   )  [private]
 

IR_base* operator[] int   )  const
 

Accessor operator.

IR_base* reserve void   ) 
 

Reserve the same was as was just served.

IR_base* serve void   ) 
 

Returns next motion to be executed on list.

void set int   )  [inherited]
 

Sets the command execution index value.

int size  )  const [inherited]
 

Returns current size of structure.


Friends And Related Function Documentation

friend class mission_profile [friend, inherited]
 


Field Documentation

IR_base* _ir_chain[IR_CHAIN_MAX] [protected]
 

int _next [protected, inherited]
 

int _top [protected, inherited]
 


Generated on Mon Oct 8 19:32:25 2007 for OOMRM Mapping API by doxygen1.3