Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
ArrayOf
AutoScopeInitClass which relies on its constructor/destructor pair to ensure destruct() is called
AXS1SensorsResponseExpected response from a ReadAXS1SensorsCmd
BaseControl
BroadcastBaudCmdSets 'baud rate' parameter to the specified value, where resulting bits per second will be 2M / (baud+1)
BroadcastFullComplianceCmdBroadcasts a command to set controller parameters to 0, also disabling torque (see also BroadcastNoPunchCmd)
BroadcastNoPunchCmdSets 'punch' parameter to 0, eliminating torque jump (see also BroadcastFullComplianceCmd)
BroadcastTorqueCmdBroadcasts a 'torque enable' (or disable) command to all servos using a write command to the appropriate address
BroadcastTorqueEntryBroadcasts a 'max torque' value to all servos using a write command to the appropriate address
BroadcastZeroSpeedCmdSets 'speed' parameter to 0, ensuring no motion will occur from leftover 'free spin' commands
BufferSourceDescription of BufferSource
CameraDriverPtGreyDescription of CameraDriverPtGrey
CameraDriverQTKitThis driver provides camera capture through the QTKit API, which is the only capture interface which supports 64-bit on OS X
CameraDriverQTSGThis driver provides camera capture through QuickTime and the Sequence Grabber, which is deprecated. See the alternative CameraDriverQTKit implementation
CameraDriverV4L1Description of CameraDriverV4L1
CameraDriverV4L2Description of CameraDriverV4L2
CameraSourceQTKitThis interfaces with a specific camera through the QTKit API, which is the only capture interface which supports 64-bit on OS X
CameraSourceQTKitDelegate
CameraSourceQTSGThis interfaces with a specific camera through QuickTime and the Sequence Grabber, which is deprecated. See the alternative CameraSourceQTKit implementation
ClearSoundCountCmdClears the sound detected count field of an AX-S1
ClearSoundHoldAndCountCmdClears the sound data max hold and sound detected count fields of an AX-S1 at the same time, see ClearSoundHold and ClearSoundCount
ClearSoundHoldCmdClears the sound data max hold field of an AX-S1
Cliff
Column
CommandThread
CommPortA CommPort provides an abstract interface to a communication resource, based on wrapping a standard library stream buffer
CommThread
ConfigErrorCheckWarning regarding configuration settings
CoreSensor
CreateDriverDescription of CreateDriver
CreateStatus_t
Current
DataCache
DataSourceAbstract base class for simulator data sources
DataStreamDriverA generic base class for drivers which are receiving a stream of data through a comm port, also providing an interface to be used as a data source in another driver
DataThread
DepthSource
DepthSubscription
DeviceDriverDescription of DeviceDriver
DockInfraRed
DynamixelDriverDescription of Dynamixel
ExecutableCommPortRun a specified executable, with the comm port connected to its stdin and stdout
FileInfoStores basic information regarding each file in the queue, including routines for loading to and from disk
FileInfo
FileSystemCommPortProvides CommPort interface to file system devices, such as serial ports
FileSystemDataSourceManages the loading of a series of files from disk
FileSystemImageSourceExtends FileSystemDataSource to decompress image data
FileSystemSensorSourceExtends FileSystemDataSource to parse sensor data
FrameCounterSubscribed by Simulator to message queue's send; ensures that SharedGlobals::MotionSimConfig::frameNumber stays in sync with the message serial number
GenericCmdHeader
GenericResponseHeaderFields global to all response packets
GpInput
ImageHeaderThis structure should be written into the beginning of each image buffer sent via setImage()
ImageInfoExtends FileInfo to provide image decompression and some additional fields for image meta-data
ImageStreamDriverDescription of ImageStreamDriver
ImageSubscription
Inertia
invalid_streambufStd::streambuf uses a protected constructor, so we have to inherit to make an empty streambuf for invalid
IPCMotionHookDescription of IPCMotionHook
KinectDriver
KobukiCommand
KobukiDriver
KobukiSensors
LoggedDataDriverDescription of LoggedDataDriver
Main
MemoryMapping
MirageCommHandles communication with Mirage to place and control an object in the environment
MirageDriverDescription of MirageDriver
Motion
MotionExecThreadDescription of MotionExecThread
MotionHookInterface for connections to remote hosts and hardware devices which should be polled with output values
MotionMonitorThread
MotionSimConfigHolds configuration parameters for the motion process
NetworkCommPortInterfaces to a machine over the internet, TCP/IP or UDP/IP
NSObject
PIDUpdateUsed as input to updatePIDs()
PingThreadAttempts to ping the specified servo by reading its model number, and if successful, current sensor values
PListSensorDriverAccepts a stream of plist packets, each containing dictionaries for output, button, and sensor values (see DynamicRobotState)
ProcessRepresents a common interface for each process being run
ReadAXS1SensorsCmdRequests a block of AX-S1 sensor values be sent, module should respond with a AXS1SensorsResponse
ReadCmdContains fields which are global to all read commands, which can read a block of parameters from the unit
ReadModelCmdRequests the 'model number' be sent, servo should respond with a ServoInfoResponse
ReadServoSensorsCmdRequests a block of servo sensor values be sent, servo should respond with a ServoSensorsResponse
ReadTorqueCmdRequests the 'torque enable' status be sent, servo should respond with a TorqueResponse
RedirectionCommPortAllows you to recombine the input/output of other CommPorts in various ways
RGBSource
SensorInfoExtends FileInfo to provide sensor parsing
SensorStateA global instance of this structure is registered via DataSource::setSensorState() during launch, so that DataSources know where to put their results
SensorStateAccessorNot a real DataSource, but an interface for the HAL command line to support set/print of values
SensorSubscription
SerialCommPortProvides CommPort interface to serial port devices -- essentially just a FileSystemCommPort, but can apply terminal IO settings
ServoInfo
ServoInfoIDSync
ServoInfoResponseExpected response from a ReadModelCmd
ServoSensorsResponseExpected response from a ReadServoSensorsCmd, common across AX, RX, and EX series at least
SetDigitalOut
SetPosSpeedCmdSets the position and speed for a single servo
SetReturnDelayTimeCmdSets 'return delay time' parameter to the specified value, where actual delay time is 2┬Ás * value
SetServoIDCmdSends a command to change a servo's ID value (use carefully!)
SetStatusResponseLevelCmdSets 'status response level' parameter to the specified value, see StatusResponseLevel
SharedGlobalsA class to hold various simulator parameters which need to be accessed from multiple processes
sim
SimConfigProvides the root dictionary of the simulator configuration, items from SharedGlobals and LoadFileThreads are added as entries in this dictionary
Simulator
SkewlZoneDriverDescription of SkewlZoneDriver
SoundPlay
SoundPlayThread
SourceListenerAllows LoadDataThreads to be notified when a data source is added or removed
SSC32DriverDescription of SSC32Driver
streambuf
StreamSimConfig
Subscription< T >
SyncDataThread
SyncWriteComplianceEntry
SyncWriteContinuousRotationEntryAn element that follows a SyncWriteHeader, enables or disables continuous rotation mode
SyncWriteEntry
SyncWriteHeader< T >Allows you to do a "synchronized write", where all recipients commit the value(s) at the same time, and do not send any response packets
SyncWriteLEDEntryAn element that follows a SyncWriteHeader, toggles LED value
SyncWritePIDEntryFor MX series servos, not AX or RX
SyncWritePosSpeedEntryAn element that follows a SyncWriteHeader, controls position and speed
SyncWritePunchEntry
SyncWriteSoundCountEntryClears the sound detected count field of an AX-S1
SyncWriteSoundHoldAndCountEntryClears the sound data max hold and sound detected count fields of an AX-S1 at the same time, see ClearSoundHold and ClearSoundCount
SyncWriteSoundHoldEntryClears the sound data max hold field of an AX-S1
SyncWriteTorqueEntry
ThreeAxisGyro
TimerExecThreadExecutes EventRouter::processTimers() as necessary (allows timers to work without any other vision or sensor processing)
TorqueResponseExpected response from a ReadTorqueCmd
WiiMoteDriverProvides something
WirelessThread
WriteHeader
WriteResponseExpected response from a Write command (when sent to non-broadcast address)

Tekkotsu Hardware Abstraction Layer 5.1CVS
Generated Mon May 9 05:01:40 2016 by Doxygen 1.6.3