#include <AnnotatorJr.h>
Inheritance diagram for AnnotatorComm::AnnotatorJr::AnnotatorJr:
Public Member Functions | |
AnnotatorJr (FTD2XX::FTD2XX *ftd2xx) throw (IOException) | |
virtual | ~AnnotatorJr () |
virtual void | close () throw (IOException) |
virtual void | signal (ResponseMessage &rsp) |
TriggerMode | getTriggerMode () throw (IOException) |
void | setTriggerMode (TriggerMode &triggerMode) throw (IOException) |
TimestampDestination | getTimeStampDestination () throw (IOException) |
void | setTimeStampDestination (TimestampDestination &destination) throw (IOException) |
int | getTimestampCount () throw (IOException) |
vector< TriggerTimestamp > | getTimestamps (int first, int last) throw (IOException) |
void | clearTimeTags () throw (IOException) |
int | getRtcCalibration () throw (IOException) |
void | setRtcCalibration (int cal) throw (IOException) |
void | saveRtcCalibration () throw (IOException) |
void | setRtcCalibrationMode (bool isEnabled) throw (IOException) |
Static Public Member Functions | |
static vector< FTD2XX::FTD2XXDeviceInfo > | scanForAnnotatorJrs () throw (IOException) |
static FTD2XX::FTD2XX * | openFTD2XX (FTD2XX::FTD2XXDeviceInfo &deviceInfo) throw (IOException) |
Static Public Attributes | |
static const int | IONETRICS_USB_VID |
static const int | ANNOTATOR_JR_USB_PID |
Definition at line 36 of file AnnotatorJr.h.
AnnotatorComm::AnnotatorJr::AnnotatorJr::AnnotatorJr | ( | FTD2XX::FTD2XX * | ftd2xx | ) | throw (IOException) |
virtual AnnotatorComm::AnnotatorJr::AnnotatorJr::~AnnotatorJr | ( | ) | [virtual] |
AnnotatorJr
destructor
void AnnotatorComm::AnnotatorJr::AnnotatorJr::clearTimeTags | ( | ) | throw (IOException) |
Clear all timestamps stored in the current storage destination.
IOException | failure to clear timestamps |
virtual void AnnotatorComm::AnnotatorJr::AnnotatorJr::close | ( | ) | throw (IOException) [virtual] |
Close the AnnotatorJr
.
IOException | failure to close streams |
Reimplemented from AnnotatorComm::AnnotatorComm.
int AnnotatorComm::AnnotatorJr::AnnotatorJr::getRtcCalibration | ( | ) | throw (IOException) |
Get the RTC calibration value. This value adjusts the oscillator driving the RTC.
IOException | failure to get valibration value |
int AnnotatorComm::AnnotatorJr::AnnotatorJr::getTimestampCount | ( | ) | throw (IOException) |
Get the number of timestamps stored in the currently selected destination.
IOException | failure to get number of timestamps |
TimestampDestination AnnotatorComm::AnnotatorJr::AnnotatorJr::getTimeStampDestination | ( | ) | throw (IOException) |
Get the timestamp storage destination.
IOException | failure to get destination |
vector<TriggerTimestamp> AnnotatorComm::AnnotatorJr::AnnotatorJr::getTimestamps | ( | int | first, | |
int | last | |||
) | throw (IOException) |
Get the requested timestamps from the current storage destination. There is a maximum number of transferable time tags at one time of ten.
first | index of the first timestamp to get | |
last | index of the last timestamp to get |
IOException | failure to retrieve timestamps |
TriggerMode AnnotatorComm::AnnotatorJr::AnnotatorJr::getTriggerMode | ( | ) | throw (IOException) |
static FTD2XX::FTD2XX* AnnotatorComm::AnnotatorJr::AnnotatorJr::openFTD2XX | ( | FTD2XX::FTD2XXDeviceInfo & | deviceInfo | ) | throw (IOException) [static] |
Open a FTD2XX interface appropriate for Annotator communication.
deviceInfo | device information for the desired FTD2XX |
IOException | failure to open |
void AnnotatorComm::AnnotatorJr::AnnotatorJr::saveRtcCalibration | ( | ) | throw (IOException) |
Save the RTC calibration value to flash. This value will be reloaded on the Annotator Jr's next power up.
IOException | failure to save calibration value |
static vector<FTD2XX::FTD2XXDeviceInfo> AnnotatorComm::AnnotatorJr::AnnotatorJr::scanForAnnotatorJrs | ( | ) | throw (IOException) [static] |
Scan FTD2XX devices for the Ionetrics VID and Annotator Jr PID.
IOException | thrown on scan failure |
void AnnotatorComm::AnnotatorJr::AnnotatorJr::setRtcCalibration | ( | int | cal | ) | throw (IOException) |
Set the RTC calibration value. This value adjusts the oscillator driving the RTC. This command is not affect by the Save Options command. See Save RTC Calibration command instead.
cal | calibration value |
IOException | failure to get calibration value |
void AnnotatorComm::AnnotatorJr::AnnotatorJr::setRtcCalibrationMode | ( | bool | isEnabled | ) | throw (IOException) |
Enter and exit RTC calibration mode. This command is not affect by the Save Options command.
isEnabled | calibration enable flag |
IOException | failure to set mode |
void AnnotatorComm::AnnotatorJr::AnnotatorJr::setTimeStampDestination | ( | TimestampDestination & | destination | ) | throw (IOException) |
Set the timestamp storage destination. Selecting a new destination does not clear the previous destination's timestamps.
destination | storage destination |
IOException | failure to set destination |
void AnnotatorComm::AnnotatorJr::AnnotatorJr::setTriggerMode | ( | TriggerMode & | triggerMode | ) | throw (IOException) |
Set the event trigger mode.
triggerMode | event trigger mode |
IOException | failure to set mode |
virtual void AnnotatorComm::AnnotatorJr::AnnotatorJr::signal | ( | ResponseMessage & | rsp | ) | [virtual] |
Signal that a response message has been read and needs tending. Override this method to provide device specific response message functionality.
rsp | new response message |
Reimplemented from AnnotatorComm::AnnotatorComm.
const int AnnotatorComm::AnnotatorJr::AnnotatorJr::ANNOTATOR_JR_USB_PID [static] |
Annotator Jr USB Product ID
Definition at line 47 of file AnnotatorJr.h.
const int AnnotatorComm::AnnotatorJr::AnnotatorJr::IONETRICS_USB_VID [static] |
Ionetrics USB Vendor ID
Definition at line 42 of file AnnotatorJr.h.