IGSTK
Classes | Namespaces | Enumerations
/build/buildd/igstk-4.4.0/Source/igstkAscensionCommandInterpreter.h File Reference
#include "igstkObject.h"
#include "igstkSerialCommunication.h"
#include <string>
Include dependency graph for igstkAscensionCommandInterpreter.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  igstk::AscensionCommandInterpreter

Namespaces

namespace  igstk
 

This file contains the declarations of IGSTK Events used to communicate among components.


Enumerations

enum  igstk::AscensionCommand {
  igstk::FB_POINT = 'B', igstk::FB_STREAM = '@', igstk::FB_REPORT_RATE_FULL = 'Q', igstk::FB_REPORT_RATE_DIV2 = 'R',
  igstk::FB_REPORT_RATE_DIV8 = 'S', igstk::FB_REPORT_RATE_DIV32 = 'T', igstk::FB_C_POSITION = 'V', igstk::FB_C_ANGLES = 'W',
  igstk::FB_C_MATRIX = 'X', igstk::FB_C_POSITION_ANGLES = 'Y', igstk::FB_C_POSITION_MATRIX = 'Z', igstk::FB_C_QUATERNION = '\\',
  igstk::FB_C_POSITION_QUATERNION = ']', igstk::FB_BUTTON_MODE = 'M', igstk::FB_BUTTON_READ = 'N', igstk::FB_ANGLE_ALIGN1 = 'J',
  igstk::FB_REFERENCE_FRAME1 = 'H', igstk::FB_ANGLE_ALIGN2 = 'q', igstk::FB_REFERENCE_FRAME2 = 'r', igstk::FB_FBB_RESET = '/',
  igstk::FB_HEMISPHERE = 'L', igstk::FB_NEXT_TRANSMITTER = '0', igstk::FB_RUN = 'F', igstk::FB_SLEEP = 'G',
  igstk::FB_SYNC = 'A', igstk::FB_XOFF = '\x13', igstk::FB_XON = '\x11', igstk::FB_RS232_TO_FBB = '\xF0',
  igstk::FB_RS232_TO_FBB_E = '\xE0', igstk::FB_RS232_TO_FBB_SE = '\xA0', igstk::FB_EXAMINE_VALUE = 'O', igstk::FB_CHANGE_VALUE = 'P'
}
 Every bird command consists of a single byte. More...
enum  igstk::AscensionDataFormat {
  igstk::FB_POSITION = 'V', igstk::FB_ANGLES = 'W', igstk::FB_MATRIX = 'X', igstk::FB_POSITION_ANGLES = 'Y',
  igstk::FB_POSITION_MATRIX = 'Z', igstk::FB_QUATERNION = '\\', igstk::FB_POSITION_QUATERNION = ']'
}
 The Flock of Birds supports several different data formats, which can be set with the SetFormat() method. More...
enum  igstk::AscensionStatusBits {
  igstk::FB_STATUS_STREAMING = 0x0001, igstk::FB_STATUS_FORMAT = 0x001E, igstk::FB_STATUS_SLEEPING = 0x0020, igstk::FB_STATUS_XOFF = 0x0040,
  igstk::FB_STATUS_FACTORY = 0x0080, igstk::FB_STATUS_NO_SYNC = 0x0100, igstk::FB_STATUS_CRT_SYNC = 0x0200, igstk::FB_STATUS_EXPANDED = 0x0400,
  igstk::FB_STATUS_HOST_SYNC = 0x0800, igstk::FB_STATUS_RUNNING = 0x1000, igstk::FB_STATUS_ERROR = 0x2000, igstk::FB_STATUS_INITIALIZED = 0x4000,
  igstk::FB_STATUS_MASTER = 0x8000
}
 The bird status parameter FB_STATUS can be examined using the ExamineValue() function. More...
enum  igstk::AscensionBusStatusBits {
  igstk::FB_FBB_STATUS_ERT0 = 0x01, igstk::FB_FBB_STATUS_ERT1 = 0x02, igstk::FB_FBB_STATUS_ERT2 = 0x04, igstk::FB_FBB_STATUS_ERT3 = 0x08,
  igstk::FB_FBB_STATUS_ERT = 0x10, igstk::FB_FBB_STATUS_SENSOR = 0x20, igstk::FB_FBB_STATUS_RUNNING = 0x40, igstk::FB_FBB_STATUS_ACCESSIBLE = 0x80
}
 The FB_FBB_STATUS parameter can be examined using ExamineValueBytes(), which will provide one status byte for each bird supported by the current addressing mode: 14 in FB_NORMAL addressing mode, 30 in FB_EXPANDED addressing mode, and 126 in FB_SUPER_EXPANDED addressing mode. More...
enum  igstk::AscensionErrorCode {
  igstk::FB_NO_ERROR = 0, igstk::FB_OPEN_ERROR = 1, igstk::FB_COM_ERROR = 2, igstk::FB_IO_ERROR = 3,
  igstk::FB_TIMEOUT_ERROR = 4, igstk::FB_PARM_ERROR = 5, igstk::FB_COMMAND_ERROR = 6, igstk::FB_ILLEGAL_ERROR = 7,
  igstk::FB_PHASE_ERROR = 8, igstk::FB_RESOURCE_ERROR = 9
}
 The following error codes are returned by GetError(): More...
enum  igstk::AscensionAddressMode { igstk::FB_NORMAL = 0, igstk::FB_EXPANDED = 1, igstk::FB_SUPER_EXPANDED = 3 }
 The FB_FBB_ADDRESS_MODE parameter can be examined with ExamineValue(). More...
enum  igstk::AscensionHemisphere {
  igstk::FB_FORWARD = 0x0000, igstk::FB_AFT = 0x0100, igstk::FB_UPPER = 0x010C, igstk::FB_LOWER = 0x000C,
  igstk::FB_LEFT = 0x0106, igstk::FB_RIGHT = 0x0006
}
 The FB_P_HEMISPHERE parameter can be examined with ExamineValue() and changed with fbChangeValue(). More...
enum  igstk::AscensionPositionScale { igstk::FB_STANDARD = 0, igstk::FB_EXTENDED = 1 }
 The FB_POSITION_SCALING parameter is specified here in millimeters rather than inches. More...
enum  igstk::AscensionParameter {
  igstk::FB_STATUS = 0, igstk::FB_REVISION = 1, igstk::FB_SPEED = 2, igstk::FB_POSITION_SCALING = 3,
  igstk::FB_FILTER = 4, igstk::FB_ALPHA_MIN = 5, igstk::FB_RATE_COUNT = 6, igstk::FB_RATE = 7,
  igstk::FB_DATA_READY = 8, igstk::FB_DATA_READY_CHAR = 9, igstk::FB_ERROR_CODE = 10, igstk::FB_ERROR_BEHAVIOR = 11,
  igstk::FB_VM = 12, igstk::FB_ALPHA_MAX = 13, igstk::FB_ELIMINATION = 14, igstk::FB_IDENTIFICATION = 15,
  igstk::FB_ERROR_CODE_EXPANDED = 16, igstk::FB_REFERENCE_FRAME = 17, igstk::FB_TRANSMITTER_MODE = 18, igstk::FB_FBB_ADDRESS_MODE = 19,
  igstk::FB_LINE_FILTER = 20, igstk::FB_FBB_ADDRESS = 21, igstk::FB_P_HEMISPHERE = 22, igstk::FB_P_ANGLE_ALIGN2 = 23,
  igstk::FB_P_REFERENCE_FRAME2 = 24, igstk::FB_SERIAL_NUMBER = 25, igstk::FB_SENSOR_SERIAL_NUMBER = 26, igstk::FB_XMTR_SERIAL_NUMBER = 27,
  igstk::FB_FBB_DELAY = 32, igstk::FB_GROUP_MODE = 35, igstk::FB_FBB_STATUS = 36, igstk::FB_FBB_AUTOCONFIG = 50
}
enum  igstk::AscensionBaudRate {
  igstk::FB_2400 = 0, igstk::FB_4800 = 1, igstk::FB_9600 = 2, igstk::FB_19200 = 3,
  igstk::FB_38400 = 4, igstk::FB_57600 = 5, igstk::FB_115200 = 6
}