TransientStatus.H File Reference

#include "Util/log.H"
Include dependency graph for TransientStatus.H:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations

enum  TransientStatus { TSTATUS_OFF, TSTATUS_ON, TSTATUS_BEGIN, TSTATUS_END }
 

Indicate the on/off/begin/end of some transient.

More...

Functions

TransientStatus transientStatus (const bool oldstate, const bool newstate)
 Compute a transient from the steady states oldstate and newstate.
TransientStatus transientStatus (const int oldstate, const int newstate, const int m)
 Compute a transient from oldstate and newstate and-masked by mask m.
const char * transientStatusToStr (const TransientStatus &ts)
 Display a TransientStatus as a 3-char C string.
bool transientStatusIsOn (const TransientStatus ts)
 Check whether status is on right now (could be ON or BEGIN).
bool transientStatusIsOff (const TransientStatus ts)
 Check whether status is off right now (could be OFF or END).

Detailed Description

Helper for transient boolean status

Definition in file TransientStatus.H.


Enumeration Type Documentation

Indicate the on/off/begin/end of some transient.

Enumerator:
TSTATUS_OFF 

we are off

TSTATUS_ON 

we are on

TSTATUS_BEGIN 

we just switched from off to on

TSTATUS_END 

we just switched from on to off

Definition at line 44 of file TransientStatus.H.


Function Documentation

TransientStatus transientStatus ( const int  oldstate,
const int  newstate,
const int  m 
) [inline]

Compute a transient from oldstate and newstate and-masked by mask m.

Definition at line 63 of file TransientStatus.H.

References transientStatus().

TransientStatus transientStatus ( const bool  oldstate,
const bool  newstate 
) [inline]
bool transientStatusIsOff ( const TransientStatus  ts  )  [inline]

Check whether status is off right now (could be OFF or END).

A return value of true means that it's off right now (either because it has been off for a while, or it just ended). A return value of false DOES NOT mean that it's on, rather it means that it is not off.

Definition at line 96 of file TransientStatus.H.

References TSTATUS_END, and TSTATUS_OFF.

bool transientStatusIsOn ( const TransientStatus  ts  )  [inline]

Check whether status is on right now (could be ON or BEGIN).

A return value of true means that it's on right now (either because it has been on for a while, or it just began). A return value of false DOES NOT mean that it's off, rather it means that it is not on.

Definition at line 88 of file TransientStatus.H.

References TSTATUS_BEGIN, and TSTATUS_ON.

const char* transientStatusToStr ( const TransientStatus ts  )  [inline]

Display a TransientStatus as a 3-char C string.

Definition at line 70 of file TransientStatus.H.

References TSTATUS_BEGIN, TSTATUS_END, TSTATUS_OFF, and TSTATUS_ON.

Referenced by SimEventSaccadeStatus::toString().

Generated on Sun May 8 08:42:53 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3