RadioState Class Reference

#include <RadioState.h>

List of all members.

---

Detailed Description

Class to hold the radio state of the host.

Holds the actual state of the radio. Possible states are : IDLE, RECV, TRANSMIT and SLEEP

IDLE: channel is empty (radio is in receive mode)

BUSY: channel is busy (radio is in receive mode)

TRANSMIT: the radio is transmitting

SLEEP: the radio is sleeping

Author:

Andreas Köpke

See also:

NotificationBoard

Public Types
enum	States { IDLE, RECV, TRANSMIT, SLEEP }
	possible states of the radio More...
Public Member Functions
States	getState () const
	function to get the state
void	setState (States s)
	set the state of the radio
int	getChannelId () const
	function to get the channel
void	setChannelId (int chan)
	set the radio channel
	RadioState (States s=IDLE)
	Constructor.
std::string	info () const
	Enables inspection.
Private Attributes
States	state
	Variable that hold the actual state.
int	channelId
	Identifies the radio channel.

---

Member Enumeration Documentation

enum RadioState::States

possible states of the radio Enumeration values: IDLE  RECV  TRANSMIT  SLEEP  { IDLE, RECV, TRANSMIT, SLEEP };

---

Constructor & Destructor Documentation

RadioState::RadioState (  States  s = IDLE  )  [inline]

Constructor. : cPolymorphic(), state(s), channelId(-1) {};

---

Member Function Documentation

int RadioState::getChannelId (   )  const [inline]

function to get the channel { return channelId; }

States RadioState::getState (   )  const [inline]

function to get the state { return state; }

std::string RadioState::info (   )  const [inline]

Enables inspection. { // FIXME add channel switch(state) { case IDLE: return "IDLE"; case RECV: return "RECV"; case TRANSMIT: return "TRANSMIT"; case SLEEP: return "SLEEP"; default: return "???"; } }

void RadioState::setChannelId (  int  chan  )  [inline]

set the radio channel { channelId = chan; }

void RadioState::setState (  States  s  )  [inline]

set the state of the radio { state = s; }

---

Member Data Documentation

int RadioState::channelId [private]

Identifies the radio channel.

States RadioState::state [private]

Variable that hold the actual state.

---

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

• RadioState.h

---