NodeGuard Class Reference

A class which encapsulates CAN node guarding when it runs. More...

#include <NodeGuard.hpp>

Inheritance diagram for NodeGuard:
CANListenerInterface

List of all members.

Public Member Functions

 NodeGuard (CANBus *_bus, unsigned int nodeId)
 Create a NodeGuard for a node on a bus.
unsigned int getStatus ()
 Returns the status bits of the Remote Transmission Request.
bool isPreOperational ()
 Returns true if the node is preoperational.
bool isOperational ()
 Returns true if the node is operational.
bool isStopped ()
 Returns true if the node is stopped.
bool validToggle ()
 Returns true if the toggle flag switching is valid (indicates that no messages were lost.
bool configure ()
bool initialize ()
void step ()
void finalize ()
void process (const CANMessage *msg)
 This method instructs the CANDeviceInterface instance to process a certain CANMessage.

Detailed Description

A class which encapsulates CAN node guarding when it runs.

Definition at line 53 of file NodeGuard.hpp.


Constructor & Destructor Documentation

NodeGuard ( CANBus _bus,
unsigned int  nodeId 
) [inline]

Create a NodeGuard for a node on a bus.

Parameters:
_bus The bus the node is on.
node The node number on that bus.

Definition at line 72 of file NodeGuard.hpp.


Member Function Documentation

void process ( const CANMessage msg  )  [inline, virtual]

This method instructs the CANDeviceInterface instance to process a certain CANMessage.

You are not the owner of msg.

Parameters:
msg The message to be processed by this instance.
Invariant:
Only this may be removed from the CANBusInterface during process.

Implements CANListenerInterface.

Definition at line 179 of file NodeGuard.hpp.

References CANMessage::getData(), and CANMessage::isRemote().


The documentation for this class was generated from the following file:
Generated on Thu Dec 23 15:05:29 2010 for OrocosComponentLibrary by  doxygen 1.6.3