Laelaps Common Simple Types

Enumerations
enum	laelaps::LaeTriState {   laelaps::LaeTriStateUnknown = -1,   laelaps::LaeTriStateFalse = 0,   laelaps::LaeTriStateOff = 0,   laelaps::LaeTriStateDisabled = 0,   laelaps::LaeTriStateLow = 0,   laelaps::LaeTriStateOpen = 0,   laelaps::LaeTriStateDark = 0,   laelaps::LaeTriStateTrue = 1,   laelaps::LaeTriStateOn = 1,   laelaps::LaeTriStateEnabled = 1,   laelaps::LaeTriStateHigh = 1,   laelaps::LaeTriStateClosed = 1,   laelaps::LaeTriStateLight = 1 }
	Laelaps tri-state type. More...
enum	laelaps::LaeRobotMode {   laelaps::LaeRobotModeUnknown = -1,   laelaps::LaeRobotModeManual = 1,   laelaps::LaeRobotModeAuto = 2 }
	Laelaps mode of operation. More...
enum	laelaps::LaeOpState {   laelaps::LaeOpStateUncalibrated = 0,   laelaps::LaeOpStateCalibrating = 1,   laelaps::LaeOpStateCalibrated = 2 }
	Robot or joint operational states. More...
enum	laelaps::LaeAsyncTaskState {   laelaps::LaeAsyncTaskStateIdle = 0,   laelaps::LaeAsyncTaskStateWorking = 1 }
	Asynchronous task state. More...
enum	laelaps::LaeNorm {   laelaps::LaeNormL1 = 1,   laelaps::LaeNormL2 = 2,   laelaps::LaeNormLinf = 3 }
	Length/Distance Norm. More...

Detailed Description

Common types used to control and report robot information. fields.

Enumeration Type Documentation

enum laelaps::LaeAsyncTaskState

Asynchronous task state.

Enumerator
LaeAsyncTaskStateIdle	idle, no async task running
LaeAsyncTaskStateWorking	async task running

Definition at line 347 of file laelaps.h.

  {
    LaeAsyncTaskStateIdle     = 0,    ///< idle, no async task running
    LaeAsyncTaskStateWorking  = 1     ///< async task running
  };

enum laelaps::LaeNorm

Length/Distance Norm.

Enumerator
LaeNormL1	L1 norm (taxicab or manhattan norm)
LaeNormL2	L2 norm (Euclidean norm)
LaeNormLinf	Linf norm (maximum, infinity, or supremum norm)

Definition at line 356 of file laelaps.h.

  {
    LaeNormL1   = 1,    ///< L1 norm (taxicab or manhattan norm)
    LaeNormL2   = 2,    ///< L2 norm (Euclidean norm)
    LaeNormLinf = 3     ///< Linf norm (maximum, infinity, or supremum norm)
  };

enum laelaps::LaeOpState

Robot or joint operational states.

Enumerator
LaeOpStateUncalibrated	uncalibrated
LaeOpStateCalibrating	calibrating
LaeOpStateCalibrated	calibrated

Definition at line 337 of file laelaps.h.

  {
    LaeOpStateUncalibrated  = 0,    ///< uncalibrated
    LaeOpStateCalibrating   = 1,    ///< calibrating
    LaeOpStateCalibrated    = 2     ///< calibrated
  };

enum laelaps::LaeRobotMode

Laelaps mode of operation.

Robot mode of operation.

Enumerator
LaeRobotModeUnknown	unknown mode state
LaeRobotModeManual	can only be operated locally, not remotely
LaeRobotModeAuto	fully available

Definition at line 327 of file laelaps.h.

  {
    LaeRobotModeUnknown = -1,   ///< unknown mode state
    LaeRobotModeManual  =  1,   ///< can only be operated locally, not remotely
    LaeRobotModeAuto    =  2    ///< fully available
  };

enum laelaps::LaeTriState

Laelaps tri-state type.

Basically, a tri-state value is either unknown, 0, or 1.

Enumerator
LaeTriStateUnknown	unknown state
LaeTriStateFalse	false
LaeTriStateOff	off
LaeTriStateDisabled	disabled
LaeTriStateLow	low
LaeTriStateOpen	open
LaeTriStateDark	dark
LaeTriStateTrue	true
LaeTriStateOn	on
LaeTriStateEnabled	enabled
LaeTriStateHigh	high
LaeTriStateClosed	closed
LaeTriStateLight	light

Definition at line 300 of file laelaps.h.

  {
    // unknown
    LaeTriStateUnknown  = -1,     ///< unknown state

    // low state synonyms
    LaeTriStateFalse    = 0,      ///< false
    LaeTriStateOff      = 0,      ///< off
    LaeTriStateDisabled = 0,      ///< disabled
    LaeTriStateLow      = 0,      ///< low
    LaeTriStateOpen     = 0,      ///< open
    LaeTriStateDark     = 0,      ///< dark

    // high state synonyms
    LaeTriStateTrue     = 1,      ///< true
    LaeTriStateOn       = 1,      ///< on
    LaeTriStateEnabled  = 1,      ///< enabled
    LaeTriStateHigh     = 1,      ///< high
    LaeTriStateClosed   = 1,      ///< closed
    LaeTriStateLight    = 1       ///< light
  };