Hekateros Common Simple Types

Enumerations
enum	hekateros::HekTriState {   hekateros::HekTriStateUnknown = -1,   hekateros::HekTriStateFalse = 0,   hekateros::HekTriStateOff = 0,   hekateros::HekTriStateDisabled = 0,   hekateros::HekTriStateLow = 0,   hekateros::HekTriStateOpen = 0,   hekateros::HekTriStateDark = 0,   hekateros::HekTriStateTrue = 1,   hekateros::HekTriStateOn = 1,   hekateros::HekTriStateEnabled = 1,   hekateros::HekTriStateHigh = 1,   hekateros::HekTriStateClosed = 1,   hekateros::HekTriStateLight = 1 }
	Hekateros tri-state type. More...
enum	hekateros::HekRobotMode {   hekateros::HekRobotModeUnknown = -1,   hekateros::HekRobotModeManual = 1,   hekateros::HekRobotModeAuto = 2 }
	Hekateros mode of operation. More...
enum	hekateros::HekOpState {   hekateros::HekOpStateUncalibrated = 0,   hekateros::HekOpStateCalibrating = 1,   hekateros::HekOpStateCalibrated = 2 }
	Robot or joint operational states. More...
enum	hekateros::HekAsyncTaskState {   hekateros::HekAsyncTaskStateIdle = 0,   hekateros::HekAsyncTaskStateWorking = 1 }
	Asynchronous task state. More...
enum	hekateros::HekNorm {   hekateros::HekNormL1 = 1,   hekateros::HekNormL2 = 2,   hekateros::HekNormLinf = 3 }
	Length/Distance Norm. More...

Detailed Description

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

Enumeration Type Documentation

enum hekateros::HekAsyncTaskState

Asynchronous task state.

Enumerator
HekAsyncTaskStateIdle	idle, no async task running
HekAsyncTaskStateWorking	async task running

Definition at line 526 of file hekateros.h.

  {
    HekAsyncTaskStateIdle     = 0,    ///< idle, no async task running
    HekAsyncTaskStateWorking  = 1     ///< async task running
  };

enum hekateros::HekNorm

Length/Distance Norm.

Enumerator
HekNormL1	L1 norm (taxicab or manhattan norm)
HekNormL2	L2 norm (Euclidean norm)
HekNormLinf	Linf norm (maximum, infinity, or supremum norm)

Definition at line 535 of file hekateros.h.

  {
    HekNormL1   = 1,    ///< L1 norm (taxicab or manhattan norm)
    HekNormL2   = 2,    ///< L2 norm (Euclidean norm)
    HekNormLinf = 3     ///< Linf norm (maximum, infinity, or supremum norm)
  };

enum hekateros::HekOpState

Robot or joint operational states.

Enumerator
HekOpStateUncalibrated	uncalibrated
HekOpStateCalibrating	calibrating
HekOpStateCalibrated	calibrated

Definition at line 516 of file hekateros.h.

  {
    HekOpStateUncalibrated  = 0,    ///< uncalibrated
    HekOpStateCalibrating   = 1,    ///< calibrating
    HekOpStateCalibrated    = 2     ///< calibrated
  };

enum hekateros::HekRobotMode

Hekateros mode of operation.

Robot mode of operation.

Enumerator
HekRobotModeUnknown	unknown mode state
HekRobotModeManual	can only be operated locally, not remotely
HekRobotModeAuto	fully available

Definition at line 506 of file hekateros.h.

  {
    HekRobotModeUnknown = -1,   ///< unknown mode state
    HekRobotModeManual  =  1,   ///< can only be operated locally, not remotely
    HekRobotModeAuto    =  2    ///< fully available
  };

enum hekateros::HekTriState

Hekateros tri-state type.

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

Enumerator
HekTriStateUnknown	unknown state
HekTriStateFalse	false
HekTriStateOff	off
HekTriStateDisabled	disabled
HekTriStateLow	low
HekTriStateOpen	open
HekTriStateDark	dark
HekTriStateTrue	true
HekTriStateOn	on
HekTriStateEnabled	enabled
HekTriStateHigh	high
HekTriStateClosed	closed
HekTriStateLight	light

Definition at line 479 of file hekateros.h.

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

    // low state synonyms
    HekTriStateFalse    = 0,      ///< false
    HekTriStateOff      = 0,      ///< off
    HekTriStateDisabled = 0,      ///< disabled
    HekTriStateLow      = 0,      ///< low
    HekTriStateOpen     = 0,      ///< open
    HekTriStateDark     = 0,      ///< dark

    // high state synonyms
    HekTriStateTrue     = 1,      ///< true
    HekTriStateOn       = 1,      ///< on
    HekTriStateEnabled  = 1,      ///< enabled
    HekTriStateHigh     = 1,      ///< high
    HekTriStateClosed   = 1,      ///< closed
    HekTriStateLight    = 1       ///< light
  };