primary namespace More...
Classes | |
| class | ApiCommandPackage |
| Base Class for command packages. More... | |
| class | BTSFraming |
| BTSFraming class, contains methods for control of BTS frames. all dimension Units are in millimeters More... | |
| class | BTSFramingCommandStatusSet |
| class | CommandCallbacks |
| DEPRECIATED Base Clase to be overridden by user exposing methods called on command state changes. More... | |
| class | CommandStateInfo |
| class | CommandStatus |
| Command Status Object for tracking the current state of a queued or executing command. More... | |
| class | CommandStatusControlMethods |
| Base class for implementing methods for CommandStatus objects. More... | |
| class | CommunicationCommandPackage |
| Generic Command to communicate with a device. More... | |
| class | CompositeCommandStatusSet |
| base class for giving access to composite command status sets. and functions to manage groups of commands etc. More... | |
| class | CompositeFrameBase |
| class | ControlSystem |
| Primary class for managing upper-level control over a multi-axis system with different devices. Supports addition of Devices, Controllers, and Control/Commands. More... | |
| class | DeviceCommandPackage |
| Base Class containing command parameters needed to run a command for a device. The package is referenced during command updating. so parameters can be changed during command execution. More... | |
| class | DeviceController |
| Base Class For Controlling Devices. More... | |
| class | DeviceInfo |
| Base Class for describing a device to be attached to a DeviceController. More... | |
| class | dmxController |
| controller base class for dmx devices More... | |
| class | DMXDeviceCommand_HSLColor8Bit |
| command to set the hsl color of a dmx lighting device More... | |
| class | DMXDeviceCommand_RGBColor8Bit |
| command to set the rgb color of a dmx lighting device More... | |
| class | DMXDeviceCommand_SetPersonality |
| command to set the dmx personality of a dmx lighting device More... | |
| class | DMXDeviceCommandLightingPackage |
| base class for dmx lighting command packages More... | |
| class | DMXDeviceCommandPackage |
| base class for dmx command packages More... | |
| class | DMXDeviceInfo |
| class | DummyController |
| Fully Virtual Controller Example used for controlling DummyDevices More... | |
| class | DummyDeviceInfo |
| class | EntTecController |
| controller for EntTec DMX USB Pro More... | |
| class | ExoLight2DeviceInfo |
| Device Info for the ExoLight2 device. More... | |
| class | ExoLightCommand_SetDCLighting |
| Command to set the lighting (DC current drive mode) of a ExoLight device. More... | |
| class | ExoLightCommand_SetLighting |
| Command to set the lighting of a ExoLight device. More... | |
| class | ExoLightCommand_SetStrobeLighting |
| Command to set the lighting (strobe mode) of a ExoLight device. More... | |
| class | ExoLightCommand_SetVoltageLighting |
| Command to set the lighting (voltage mode) of a ExoLight device. More... | |
| class | HardwareDeviceController |
| Base Class for hardware controllers. More... | |
| struct | HardwareInfo |
| class | IsolightPuckCommand_Update |
| Command to update the lighting and take light sensor reading from the isolight puck. More... | |
| class | IsolightPuckCommandStatus |
| Command status for the isolight puck. More... | |
| class | IsolightPuckController |
| Controller for the isolight puck. More... | |
| class | IsolightPuckDeviceInfo |
| Device Info for the isolight puck. More... | |
| class | IsolightPuckUpdateStateInfo |
| State Info providing readings from the isolight puck sensor. More... | |
| class | KinoFloDeviceCommand_RGBColor8Bit |
| class | KinoFloDeviceInfo |
| class | LedLightBoxCommand_Lighting |
| Command to set the lighting of a led light box. More... | |
| class | LedLightBoxController |
| controller for LedLightBox More... | |
| class | LedLightBoxControllerBase |
| base class for led light box controllers More... | |
| class | LedLightBoxDevice_High_LUX_LED_Box_Mixed_Info |
| device info for High_LUX_LED_Box_Mixed More... | |
| class | LedLightBoxDevice_High_LUX_LED_Box_Single_Info |
| device info for High_LUX_LED_Box_Single More... | |
| class | LedLightBoxDevice_Standard_LED_Box_Mixed_Info |
| device info for Standard_LED_Box_Mixed More... | |
| class | LedLightBoxDevice_Standard_LED_Box_Single_Info |
| device info for Standard_LED_Box_Single More... | |
| class | LedLightBoxDevice_Ultra_High_Illumination_Flickering_Info |
| device info for Ultra_High_Illumination_Flickering More... | |
| class | LedLightBoxDeviceInfo |
| https://www.imatest.com/product/imatest-led-lightbox/ More... | |
| class | LedLightPanel_Single_Info |
| https://www.imatest.com/wp-content/uploads/2019/04/Imatest-LED-Light-Panel_Info-Sheet.pdf More... | |
| class | LedLightPanelCommand_SetLighting |
| Command to set the lighting of a led light panel. More... | |
| class | LiftingColumnCommandGetEncoderPos |
| Get the Internal Encoder Count of the RoboClaw More... | |
| class | LiftingColumnCommandMovementPackage |
| class | LiftingColumnCommandSetEncoderPos |
| Set the Internal Encoder Count of the RoboClaw More... | |
| class | LiftingColumnCommandStatus |
| Lifting Column Command Status More... | |
| class | LiftingColumnController |
| controller for Lifting Column More... | |
| class | LiftingColumnDeviceInfo |
| Device Info for the Lifting Column More... | |
| class | LiftingColumnMovementStateInfo |
| Lifting Column Movement State Info More... | |
| class | LoggerFunctionality |
| base class implementing logger functionality for classes. More... | |
| class | LoopBackComController |
| class | LoopBackComDeviceInfo |
| struct | LowLightSensor_DataInfo |
| Data Info for the Low Light Sensor More... | |
| class | LowLightSensorCommand_Update |
| Command to update the lighting and take light sensor reading More... | |
| class | LowLightSensorCommandStatus |
| Command Status for the Low Light Sensor More... | |
| class | LowLightSensorController |
| Controller for the Low Light Sensor More... | |
| class | LowLightSensorDeviceInfo |
| Device Info for the Low Light Sensor More... | |
| class | LowLightSensorUpdateStateInfo |
| State Info providing readings from the low light sensor More... | |
| class | MonitorCommandPackage |
| Base class command to get current state of device. More... | |
| class | MOTYZ_Framing |
| The MOTYZ_Framing object can be calibrated to the coordinates of a target chart by calling frame.calibrate() and following the prompts to enter in distance values from the chart center using the range finder. MOTYZ_Frame. state can be saved by saving/restoring the chartDisplacement_Ref, chartDisplacement, and liftingCol_refPos variables at any time if the frame is in the same position after calibration. More... | |
| class | MovementCommandPackage |
| Generic Movement Command Supported on moving devices. More... | |
| class | MovementStateInfo |
| base class for representing the movement state of a command at any time. More... | |
| class | PheonixMecanoActuator |
| Device Info for the Pheonix Mecano Actuator (DEPRECATED) More... | |
| struct | PhysicalAxisControlInfo |
| base class representing a physical axis (linear or rotational, with movement limits) More... | |
| struct | SpectralSensor_SpecDataInfo |
| Data Info for the Spectral Sensor More... | |
| class | SpectralSensorCommand_Update |
| Command to update the lighting and take light sensor reading from the isolight puck. More... | |
| class | SpectralSensorCommandStatus |
| Command Status for the Spectral Sensor More... | |
| class | SpectralSensorController |
| Controller for the Spectral Sensor More... | |
| class | SpectralSensorDeviceInfo |
| Device Info for the Spectral Sensor More... | |
| class | SpectralSensorUpdateStateInfo |
| State Info providing readings from the SpectralSensor More... | |
| class | SynchronizeDeviceCommand |
| Command that synchronizes multiple commands to finish at a certain time. More... | |
| class | ThorLabsUPLED_Controller |
| controller for ThorLabs UPLED devices More... | |
| class | ThorLabsUPLED_DeviceInfo |
| Device Info for the ThorLabs UPLED device. More... | |
| class | ThorLabsUPLED_SetLighting |
| Command to set the lighting of a ThorLabs UPLED device. More... | |
| class | ThousliteCommand_SetLighting |
| Command to set the lighting of a Thouslite device. More... | |
| class | ThousliteController |
| controller for Thouslite devices More... | |
| class | ThousliteDeviceInfo |
| Device Info for the Thouslite device. More... | |
| class | TimeDelayDeviceCommand |
| Command that adds a time delay. More... | |
| struct | ULC2_DC_Mode |
| struct | ULC2_STROBE_Mode |
| struct | ULC2_VOLTAGE_Mode |
| class | ULC2Controller |
| base class controller for ULC2 More... | |
| class | VCXFraming |
| DEPRECIATED. VCX Framing class, contains methods for control of VCX frames. all dimension Units are in millimeters More... | |
| class | Vector3D |
| primative 3D Vector More... | |
| struct | ZaberAxisInfo |
| Axis Info for attaching to a Zaber Device More... | |
| class | ZaberCommandGetStorageKey |
| command to get the storage key / value on a zaber device. More... | |
| class | ZaberCommandSetAxisMovement |
| command to set axis movement on a zaber device More... | |
| class | ZaberCommandSetStorageKey |
| command to set the storage key / value on a zaber device. More... | |
| class | ZaberCommandStorageKeyStateInfo |
| state info for storage keystate of a zaber device. More... | |
| class | zaberController |
| controller for Zaber devices More... | |
| class | ZaberDeviceInfo |
| Device Info for a single Zaber device. More... | |
Enumerations | |
| enum | IsoLightPuck_LEDPatterns { IsoLightPuck_LEDPatterns_Continuous_Red = 16, IsoLightPuck_LEDPatterns_Continuous_Yellow, IsoLightPuck_LEDPatterns_Continuous_Green, IsoLightPuck_LEDPatterns_Continuous_Blue, IsoLightPuck_LEDPatterns_Continuous_Magenta, IsoLightPuck_LEDPatterns_Flashing_Red, IsoLightPuck_LEDPatterns_Flashing_Yellow, IsoLightPuck_LEDPatterns_Flashing_Green, IsoLightPuck_LEDPatterns_Flashing_Blue, IsoLightPuck_LEDPatterns_Flashing_Magenta, IsoLightPuck_LEDPatterns_Spin_Red, IsoLightPuck_LEDPatterns_Spin_Yellow, IsoLightPuck_LEDPatterns_Spin_Green, IsoLightPuck_LEDPatterns_Spin_Blue, IsoLightPuck_LEDPatterns_Spin_Magenta, IsoLightPuck_LEDPatterns_RainbowCycle } |
| IsoLightPuck Supported LED Patterns. More... | |
| enum | ExoLightDriveMode { ExoLightDriveMode_DC, ExoLightDriveMode_Strobe, ExoLightDriveMode_Voltage } |
| enum | ExoLightTriggerType { TriggerType_Internal, TriggerType_External } |
Functions | |
| int | throwTestException () |
| throw a test exception from the library More... | |
| int | raiseTestSIGSEG () |
| raise a test SIGSEGV signal from the library More... | |
| void | printTestMessage () |
| print a test message from the library | |
| void | printTestErrorMessage () |
| print a test error message from the library | |
| void | printTestErrorThrowMessage () |
| print a test error message from the library and throw an exception | |
| std::string | logLocation (int index) |
| return the full path of the log location More... | |
| void | addLogPath (std::string logFilePath) |
| Add a new log path for log files to be created in. More... | |
| std::string | getRuntimeLibraryPath () |
| std::string | getRuntimeDependancyPath () |
| MovementStateInfo * | As_MovementStateInfo (CommandStateInfo *obj) |
| Dynamic Cast a CommandStateInfo pointer into a MovementStateInfo pointer. | |
| MovementCommandPackage * | As_MovementCommandPackage (DeviceCommandPackage *obj) |
| std::shared_ptr< ZaberCommandSetAxisMovement > HC_API | As_ZaberCommandSetAxisMovement (std::shared_ptr< DeviceCommandPackage > package) |
| std::shared_ptr< ZaberCommandSetStorageKey > HC_API | As_ZaberCommandSetStorageKey (std::shared_ptr< DeviceCommandPackage > package) |
| std::shared_ptr< ZaberCommandGetStorageKey > HC_API | As_ZaberCommandGetStorageKey (std::shared_ptr< DeviceCommandPackage > package) |
| int HC_API | basicFunc (int a, int b) |
Variables | |
| const std::string | KinoFlo_NALPCODE = "KINO" |
| const std::string | LedLightBox_NALPCODE = "LTBOX" |
| const std::string | LowLightSensor_NALPCODE = "LLSN" |
| const std::string | SpectralSensor_NALPCODE = "HPCS" |
| const std::string | Thouslite_NALPCODE = "THOUS" |
| const std::string | ThousliteRecipeDescriptions [14] |
| Thouslite Recipe Descriptions More... | |
Detailed Description
primary namespace
Enumeration Type Documentation
◆ IsoLightPuck_LEDPatterns
IsoLightPuck Supported LED Patterns.
Function Documentation
◆ addLogPath()
| void ControlAPI::addLogPath | ( | std::string | logFilePath | ) |
Add a new log path for log files to be created in.
- Parameters
-
logFilePath
◆ logLocation()
| std::string ControlAPI::logLocation | ( | int | index | ) |
return the full path of the log location
- Parameters
-
index the log location index (default 0)
- Returns
- the log location as a string.
◆ raiseTestSIGSEG()
| int ControlAPI::raiseTestSIGSEG | ( | ) |
raise a test SIGSEGV signal from the library
- Returns
◆ throwTestException()
| int ControlAPI::throwTestException | ( | ) |
throw a test exception from the library
- Returns
Variable Documentation
◆ ThousliteRecipeDescriptions
| const std::string ControlAPI::ThousliteRecipeDescriptions[14] |
Initial value:
= {
"White (Broad spectrum)",
"Orange (585nm)",
"Lt Orange (Broad spectrum)",
"Blue-Green (480nm)",
"Red (660nm)",
"Green-Blue (505nm)",
"Green (520nm)",
"Blue (445nm)",
"Lt Violet (420nm)",
"Red (635nm)",
"Yellow-Grn (545nm)",
"Dk Violet (405nm)",
"Red (670nm)",
"Red/IR (700/850nm)"
}
Thouslite Recipe Descriptions