rnr::State Class Reference

#include <State.h>

Inheritance diagram for rnr::State:

Public Types
typedef std::map< int, StateEvent * >	TransTblMap_T
	transition table type

Public Member Functions
	State (int nStateId, const std::string &strStateName="", const std::string &strRefTag="")
	Initialization constructor. More...
	State (int nStateId, const std::string &strStateName, const std::string &strRefTag, StateEvent *listStateEvents[])
	List constructor. More...
virtual	~State ()
	Destructor.
int	addStateEvents (StateEvent *pStateEvent,...)
	Add a list of state events to this state. More...
void	addStateEvent (StateEvent *pStateEvent)
	Add state to this state. More...
bool	deleteStateEvent (int nEventId)
	Delete state event from this state. More...
uint_t	setTimeOut (uint_t usecTimeOut)
	Set recieve event time out. More...
uint_t	getTimeOut ()
	Get recieve event time out. More...
virtual int	receiveEvent ()
	Receive next event. More...
virtual void	queueNextEvent (int nEventId)
	Queue the next event to be "recieved". More...
virtual int	dispatchEvent (int nPrevStateId, int nEventId)
	Dispatch received event by executing associated action and transitioning to the next state. More...
virtual void	actionEnterState (int nPrevStateId, int nEventId)
	Execute 'enter state' action. More...
virtual void	actionExitState (int nNextStateId, int nEventId)
	Execute 'exit state' action. More...
virtual int	actionDefault (int nPrevStateId, int nEventId)
	Execute 'default' action. More...
int	getStateId () const
	Get state id. More...
std::string	getStateName () const
	Get state name. More...
std::string	getRefTag () const
	Get state reference tag. More...
std::string	getEventName (int nEventId)
	Get state event name. More...
std::string	getActionName (int nEventId)
	Get state action name. More...
virtual void	printState (FILE *fp=stdout, int indent=0)
	Print out state. More...
	State (Session &session, int nInitAction=UIActionNone)
virtual int	getNextAction (Session &session, int nTimeoutMs)
virtual int	setNextAction (int nAction)
	Set the next input action to process. More...
int	getCurAction ()
	Get the currently retrieved input action. More...
bool	hasFatal ()
	Test if state has fatal condition. More...
void	setFatal ()
bool	isModified ()
void	setModifiedState (bool bModified)
void	maskHardButton (bool bEnDis)
	Enable/disable masking of hard button input. More...
virtual bool	isHardButtonPushed (Session &session)
virtual void	prompt (Session &session)
	Prompt user, given the state. More...
virtual void	setMenuStates (Session &session)
virtual void	transQuit (Session &session)
virtual void	transPrev (Session &session)

Static Public Attributes
static const int	StateIdUndef = 0
	undefined state
static const int	StateIdStart = 1
	start state
static const int	StateIdPrev = 2
	the previous state
static const int	StateIdThis = 3
	the current (this) state
static const int	StateIdTerminate = 4
	terminate state
static const int	StateIdNumOf = 5
	number of reserved state id's

Protected Member Functions
void	init (int nStateId, const std::string &strStateName="", const std::string &strRefTag="")
	Initialize data. More...
virtual std::string	getReservedStateName (int nStateId)
	Get the reserved state name. More...
virtual void	buildInterface (Session &session)
virtual void	destroyInterface ()
virtual void	initButtonMenu ()

Protected Attributes
int	m_nStateId
	state id
std::string	m_strStateName
	state name
std::string	m_strRefTag
	state tag (short id string)
TransTblMap_T	m_mapTransTbl
	state transition table
int	m_nQueuedEventId
	queue state event
bool	m_bHasQueuedEvent
	[no] queued state event
uint_t	m_usecTimeOut
	receive event time out (useconds)
Window *	m_pWin
	bound window
Menu *	m_pMenu
	button menu
int	m_nInitAction
	initial state input action
int	m_nCurAction
	current state input action
bool	m_bFatal
	fatal error
bool	m_bModified
	state [not] modified
bool	m_bHardBttnEnable
	enable/disable hard button input

Friends
class	StateEvent
	friend

Detailed Description

State base class.

Workflow Simplified State Machine Class

Definition at line 158 of file State.h.

Constructor & Destructor Documentation

rnr::State::State ( int  nStateId, const std::string &  strStateName = "", const std::string &  strRefTag = ""  )

inline

Initialization constructor.

Parameters

nStateId	State id. Must be state machine unique.
strStateName	State name.
strRefTag	State reference id.

Definition at line 180 of file State.h.

    {
      init(nStateId, strStateName, strRefTag);
    }

rnr::State::State	(	int	nStateId,
		const std::string &	strStateName,
		const std::string &	strRefTag,
		StateEvent *	listStateEvents[]
	)

List constructor.

Parameters

nStateId	State id. Must be state machine unique.
strStateName	State name.
strRefTag	State reference id.
listStateEvents	Declaration list of allocated state events. NULL terminated.

Member Function Documentation

virtual int rnr::State::actionDefault ( int  nPrevStateId, int  nEventId  )

inlinevirtual

Execute 'default' action.

Parameters

nPrevStateId	Previous state id.
nEventId	Received event id.

Returns

Returns next state (this).

Definition at line 327 of file State.h.

    {
      return m_nStateId;
    }

virtual void rnr::State::actionEnterState ( int  nPrevStateId, int  nEventId  )

inlinevirtual

Execute 'enter state' action.

Parameters

nPrevStateId	Previous state id.
nEventId	Received event id.

Reimplemented in rnr::StateWin.

Definition at line 305 of file State.h.

Referenced by rnr::StateMach::run().

    {
    }

virtual void rnr::State::actionExitState ( int  nNextStateId, int  nEventId  )

inlinevirtual

Execute 'exit state' action.

Parameters

nNextStateId	Next state id.
nEventId	Received event id.

Reimplemented in rnr::StateWin.

Definition at line 315 of file State.h.

Referenced by rnr::StateMach::run().

    {
    }

void State::addStateEvent

(

StateEvent *

pStateEvent

)

Add state to this state.

This state machine owns the state and will automatically delete it when this state machine is deleted.

Parameters

pStateEvent

Allocated state object.

Definition at line 162 of file State.cxx.

{
  TransTblMap_T::iterator pos;

  if( pStateEvent != NULL )
  {
    if( (pos = m_mapTransTbl.find(pStateEvent->getEventId()))
                != m_mapTransTbl.end() )
    {
      LOGWARN("%s: Event %s.%d already exists - replacing.",
        m_strStateName.c_str(),
        pos->second->getEventName().c_str(), pos->second->getEventId());
      delete pos->second;
      m_mapTransTbl.erase(pos);
    }

    m_mapTransTbl[pStateEvent->getEventId()] = pStateEvent;

    LOGDIAG3("%s: %s.%d state event added.",
          m_strStateName.c_str(),
          pStateEvent->getEventName().c_str(), pStateEvent->getEventId());
  }
}

int State::addStateEvents	(	StateEvent *	pStateEvent,
			...
	)

Add a list of state events to this state.

This state owns all of the states events and will automatically delete them when this state is deleted.

Parameters

pStateEvent	First allocated state event object.
...	Subsequent allocated state event object. Terminate list with NULL.

Returns

Returns the number of state events added.

Definition at line 145 of file State.cxx.

{
  va_list ap;
  int     i;

  va_start(ap, pStateEvent);

  for(i=0; pStateEvent != NULL; pStateEvent = va_arg(ap, StateEvent *), ++i)
  {
    addStateEvent(pStateEvent);
  }

  va_end(ap);

  return i;
}

bool State::deleteStateEvent

(

int

nEventId

)

Delete state event from this state.

Parameters

nEventId

Event id.

Returns

Returns true if state event is deleted, false otherwise.

Definition at line 186 of file State.cxx.

{
  TransTblMap_T::iterator pos;

  if( (pos = m_mapTransTbl.find(nEventId)) != m_mapTransTbl.end() )
  {
    delete pos->second;
    m_mapTransTbl.erase(pos);
    return true;
  }
  else
  {
    LOGERROR("%s: No event found in transition table with id=%d.",
        m_strStateName.c_str(), nEventId);
    return false;
  }
}

int State::dispatchEvent ( int  nPrevStateId, int  nEventId  )

virtual

Dispatch received event by executing associated action and transitioning to the next state.

Parameters

nPrevStateId	Previous state id.
nEventId	Received event id.

Returns

Returns next state.

Definition at line 225 of file State.cxx.

References rnr::StateEvent::evalGuardExpr(), and rnr::StateEvent::execAction().

Referenced by rnr::StateMach::run().

{
  TransTblMap_T::iterator   pos;
  StateEvent               *pEvent;
  int                       nNextStateId;

  //
  // Find event in transition table and execute. 
  //
  if( (pos = m_mapTransTbl.find(nEventId)) != m_mapTransTbl.end() )
  {
    pEvent = pos->second;

    // evaluate guard expression
    if( pEvent->evalGuardExpr(this, nPrevStateId, nEventId) )
    {
      // execute action
      nNextStateId = pEvent->execAction(this, nPrevStateId, nEventId);
    }

    // evaluated to false
    else
    {
      nNextStateId = m_nStateId;
    }
  }

  //
  // No event in transition table, so execute default action. 
  //
  else
  {
    nNextStateId = actionDefault(nPrevStateId, nEventId);
  }

  // stay is this state
  if( nNextStateId == StateIdThis )
  {
    nNextStateId = m_nStateId;
  }

  return nNextStateId;
}

string State::getActionName

(

int

nEventId

)

Get state action name.

Parameters

nEventId

Event id.

Returns

String.

Definition at line 283 of file State.cxx.

{
  TransTblMap_T::iterator pos;

  if( (pos = m_mapTransTbl.find(nEventId)) != m_mapTransTbl.end() )
  {
    return pos->second->getActionName();
  }
  else
  {
    return "";
  }
}

int rnr::State::getCurAction ( )

inline

Get the currently retrieved input action.

Returns

Current action.

Definition at line 128 of file State.orig.h.

References m_nCurAction.

    {
      return m_nCurAction;
    }

string State::getEventName

(

int

nEventId

)

Get state event name.

Parameters

nEventId

Event id.

Returns

String.

Definition at line 269 of file State.cxx.

{
  TransTblMap_T::iterator pos;

  if( (pos = m_mapTransTbl.find(nEventId)) != m_mapTransTbl.end() )
  {
    return pos->second->getEventName();
  }
  else
  {
    return "";
  }
}

std::string rnr::State::getRefTag ( ) const

inline

Get state reference tag.

Returns

String.

Definition at line 357 of file State.h.

References rnr::io::indent().

    {
      return m_strRefTag;
    }

string State::getReservedStateName ( int  nStateId )

protectedvirtual

Get the reserved state name.

Parameters

nStateId

State id.

Returns

String.

Definition at line 352 of file State.cxx.

{
  switch( nStateId )
  {
    case StateIdStart:
      return "*Start";
    case StateIdPrev:
      return "Previous";    // if recording, then ...
    case StateIdThis:
      return m_strStateName;
    case StateIdTerminate:
      return "Terminate*";
    case StateIdUndef:
      return "#undef";
    default:
      return "";
  }
}

int rnr::State::getStateId ( ) const

inline

Get state id.

Returns

State id.

Definition at line 337 of file State.h.

Referenced by rnr::StateMach::addState().

    {
      return m_nStateId;
    }

std::string rnr::State::getStateName ( ) const

inline

Get state name.

Returns

String.

Definition at line 347 of file State.h.

Referenced by rnr::StateMach::addState().

    {
      return m_strStateName;
    }

uint_t rnr::State::getTimeOut ( )

inline

Get recieve event time out.

Returns

Returns time out value.

Definition at line 259 of file State.h.

    {
      return m_usecTimeOut;
    }

bool rnr::State::hasFatal ( )

inline

Test if state has fatal condition.

Returns

Returns true or false.

Definition at line 138 of file State.orig.h.

References m_bFatal, and m_bModified.

    {
      return m_bFatal;
    }

void State::init ( int  nStateId, const std::string &  strStateName = "", const std::string &  strRefTag = ""  )

protected

Initialize data.

Parameters

nStateId	State id. Must be state machine unique.
strStateName	State name.
strRefTag	State reference id.

Definition at line 318 of file State.cxx.

{
  m_nStateId        = nStateId;
  m_bHasQueuedEvent = false;
  m_usecTimeOut     = 0;

  if( strStateName.empty() )
  {
    stringstream  ss;

    ss << "S" << m_nStateId;
    ss >> m_strStateName;
  }
  else
  {
    m_strStateName = strStateName;
  }

  if( strRefTag.empty() )
  {
    stringstream  ss;

    ss << m_nStateId;
    ss >> m_strRefTag;
  }
  else
  {
    m_strRefTag = strRefTag;
  }
}

void rnr::State::maskHardButton ( bool  bEnDis )

inline

Enable/disable masking of hard button input.

Parameters

bEnDis

Enable (true) or disable (false) reading hard button input.

Definition at line 163 of file State.orig.h.

References m_bHardBttnEnable.

    {
      m_bHardBttnEnable = bEnDis;
    }

void State::printState ( FILE *  fp = stdout, int  indent = 0  )

virtual

Print out state.

Parameters

fp	Output file pointer.
indent	Left indentation.

Definition at line 298 of file State.cxx.

{
  TransTblMap_T::iterator  iter;
  StateEvent              *pEvent;

  fprintf(fp, "%*sState: %s.%d\n",
      indent, "", m_strStateName.c_str(), m_nStateId);

  for(iter  = m_mapTransTbl.begin();
      iter != m_mapTransTbl.end();
      ++iter )
  {
    pEvent = iter->second;
    fprintf(fp, "%*sEvent: %s.%d %s\n",
      indent+2, "",
      pEvent->getEventName().c_str(), pEvent->getEventId(),
      pEvent->getActionName().c_str());
  }
}

virtual void rnr::State::prompt ( Session &  session )

inlinevirtual

Prompt user, given the state.

Parameters

session

Session data.

Definition at line 175 of file State.orig.h.

{ }

virtual void rnr::State::queueNextEvent ( int  nEventId )

inlinevirtual

Queue the next event to be "recieved".

Subsequent call to receiveEvent() should retrieve this event rather than doing the state's standard receive operations.

Definition at line 282 of file State.h.

    {
      m_nQueuedEventId  = nEventId;
      m_bHasQueuedEvent = true;
    }

int State::receiveEvent ( )

virtual

Receive next event.

Randomly chooses an event id listed in the transition table.

The receive event may set state internal variables used specifically by the state.

Returns

Returns event id.

Reimplemented in rnr::StateKb, and rnr::StateWin.

Definition at line 204 of file State.cxx.

References rnr::Random::randrange().

Referenced by rnr::StateMach::run().

{
  if( m_mapTransTbl.size() > 0 )
  {
    TransTblMap_T::iterator pos;
    Random                  rand;
    int                     i;

    i = rand.randrange(0, (int)m_mapTransTbl.size()-1);

    // no '+' or '+=' operator - so crawl through map
    for(pos = m_mapTransTbl.begin(); i > 0; --i, ++pos);

    return pos->second->getEventId();
  }
  else
  {
    return 0;
  }
}

virtual int rnr::State::setNextAction ( int  nAction )

inlinevirtual

Set the next input action to process.

Subsequent call to getNextAction() will retrieve this action.

Returns

The to-be-retrieved next action.

Definition at line 115 of file State.orig.h.

References m_pMenu.

    {
      if( m_pMenu != NULL )
      {
        m_pMenu->SetCurrentAction(nAction);
      }
    }

uint_t rnr::State::setTimeOut ( uint_t  usecTimeOut )

inline

Set recieve event time out.

Parameters

usecTimeOut

Time out in seconds. Set to 0 for blocking until event with no time out.

Returns

Returns last time out value.

Definition at line 247 of file State.h.

    {
      uint_t  usecLast = m_usecTimeOut;
      m_usecTimeOut = usecTimeOut;
      return usecLast;
    }

---

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

• include/rnr/appkit/State.h
• include/rnr/appkit/State.orig.h
• sw/librnr_appkit/State.cxx