SeaBreeze
Public Member Functions | Protected Member Functions | Protected Attributes
seabreeze::api::DeviceAdapter Class Reference
Collaboration diagram for seabreeze::api::DeviceAdapter:
Collaboration graph

Public Member Functions

 DeviceAdapter (Device *dev, unsigned long id)
 
int open (int *errorCode)
 
void close ()
 
DeviceLocatorInterfacegetLocation ()
 
unsigned long getID ()
 
int getDeviceType (int *errorCode, char *buffer, unsigned int maxLength)
 
unsigned char getDeviceEndpoint (int *errorCode, usbEndpointType anEndpointType)
 
int getNumberOfRawUSBBusAccessFeatures ()
 
int getRawUSBBusAccessFeatures (long *buffer, int maxFeatures)
 
int rawUSBBusAccessRead (long featureID, int *errorCode, unsigned char *buffer, unsigned int bufferLength, unsigned char endpoint)
 
int rawUSBBusAccessWrite (long featureID, int *errorCode, unsigned char *buffer, unsigned int bufferLength, unsigned char endpoint)
 
int getNumberOfSerialNumberFeatures ()
 
int getSerialNumberFeatures (long *buffer, int maxFeatures)
 
int getSerialNumber (long featureID, int *errorCode, char *buffer, int bufferLength)
 
unsigned char getSerialNumberMaximumLength (long featureID, int *errorCode)
 
int getNumberOfSpectrometerFeatures ()
 
int getSpectrometerFeatures (long *buffer, int maxFeatures)
 
void spectrometerSetTriggerMode (long spectrometerFeatureID, int *errorCode, int mode)
 
void spectrometerSetIntegrationTimeMicros (long spectrometerFeatureID, int *errorCode, unsigned long integrationTimeMicros)
 
unsigned long spectrometerGetMinimumIntegrationTimeMicros (long spectrometerFeatureID, int *errorCode)
 
unsigned long spectrometerGetMaximumIntegrationTimeMicros (long spectrometerFeatureID, int *errorCode)
 
double spectrometerGetMaximumIntensity (long spectrometerFeatureID, int *errorCode)
 
int spectrometerGetUnformattedSpectrumLength (long spectrometerFeatureID, int *errorCode)
 
int spectrometerGetUnformattedSpectrum (long spectrometerFeatureID, int *errorCode, unsigned char *buffer, int bufferLength)
 
int spectrometerGetFormattedSpectrumLength (long spectrometerFeatureID, int *errorCode)
 
int spectrometerGetFormattedSpectrum (long spectrometerFeatureID, int *errorCode, double *buffer, int bufferLength)
 
int spectrometerGetWavelengths (long spectrometerFeatureID, int *errorCode, double *wavelengths, int length)
 
int spectrometerGetElectricDarkPixelCount (long spectrometerFeatureID, int *errorCode)
 
int spectrometerGetElectricDarkPixelIndices (long spectrometerFeatureID, int *errorCode, int *indices, int length)
 
int getNumberOfPixelBinningFeatures ()
 
int getPixelBinningFeatures (long *buffer, int maxFeatures)
 
void binningSetPixelBinningFactor (long spectrometerFeatureID, int *errorCode, const unsigned char binningFactor)
 
unsigned char binningGetPixelBinningFactor (long spectrometerFeatureID, int *errorCode)
 
void binningSetDefaultPixelBinningFactor (long spectrometerFeatureID, int *errorCode, const unsigned char binningFactor)
 
void binningSetDefaultPixelBinningFactor (long spectrometerFeatureID, int *errorCode)
 
unsigned char binningGetDefaultPixelBinningFactor (long spectrometerFeatureID, int *errorCode)
 
unsigned char binningGetMaxPixelBinningFactor (long spectrometerFeatureID, int *errorCode)
 
int getNumberOfThermoElectricFeatures ()
 
int getThermoElectricFeatures (long *buffer, int maxFeatures)
 
double tecReadTemperatureDegreesC (long featureID, int *errorCode)
 
void tecSetTemperatureSetpointDegreesC (long featureID, int *errorCode, double temperatureDegreesCelsius)
 
void tecSetEnable (long featureID, int *errorCode, bool tecEnable)
 
int getNumberOfIrradCalFeatures ()
 
int getIrradCalFeatures (long *buffer, int maxFeatures)
 
int irradCalibrationRead (long featureID, int *errorCode, float *buffer, int bufferLength)
 
int irradCalibrationWrite (long featureID, int *errorCode, float *buffer, int bufferLength)
 
int irradCalibrationHasCollectionArea (long featureID, int *errorCode)
 
float irradCalibrationReadCollectionArea (long featureID, int *errorCode)
 
void irradCalibrationWriteCollectionArea (long featureID, int *errorCode, float area)
 
int getNumberOfEEPROMFeatures ()
 
int getEEPROMFeatures (long *buffer, int maxFeatures)
 
int eepromReadSlot (long featureID, int *errorCode, int slotNumber, unsigned char *buffer, int length)
 
int getNumberOfLightSourceFeatures ()
 
int getLightSourceFeatures (long *buffer, int maxFeatures)
 
int lightSourceGetCount (long featureID, int *errorCode)
 
bool lightSourceHasEnable (long featureID, int *errorCode, int lightSourceIndex)
 
bool lightSourceIsEnabled (long featureID, int *errorCode, int lightSourceIndex)
 
void lightSourceSetEnable (long featureID, int *errorCode, int lightSourceIndex, bool enable)
 
bool lightSourceHasVariableIntensity (long featureID, int *errorCode, int lightSourceIndex)
 
double lightSourceGetIntensity (long featureID, int *errorCode, int lightSourceIndex)
 
void lightSourceSetIntensity (long featureID, int *errorCode, int lightSourceIndex, double intensity)
 
int getNumberOfStrobeLampFeatures ()
 
int getStrobeLampFeatures (long *buffer, int maxFeatures)
 
void lampSetStrobeEnable (long featureID, int *errorCode, bool strobeEnable)
 
int getNumberOfContinuousStrobeFeatures ()
 
int getContinuousStrobeFeatures (long *buffer, int maxFeatures)
 
void continuousStrobeSetPeriodMicroseconds (long featureID, int *errorCode, unsigned long period_usec)
 
void continuousStrobeSetEnable (long featureID, int *errorCode, bool enable)
 
int getNumberOfShutterFeatures ()
 
int getShutterFeatures (long *buffer, int maxFeatures)
 
void shutterSetShutterOpen (long featureID, int *errorCode, bool opened)
 
int getNumberOfNonlinearityCoeffsFeatures ()
 
int getNonlinearityCoeffsFeatures (long *buffer, int maxFeatures)
 
int nonlinearityCoeffsGet (long featureID, int *errorCode, double *buffer, int bufferLength)
 
int getNumberOfTemperatureFeatures ()
 
int getTemperatureFeatures (long *buffer, int maxFeatures)
 
unsigned char temperatureCountGet (long temperatureFeatureID, int *errorCode)
 
double temperatureGet (long temperatureFeatureID, int *errorCode, int index)
 
int temperatureGetAll (long temperatureFeatureID, int *errorCode, double *buffer, int bufferLength)
 
int getNumberOfRevisionFeatures ()
 
int getRevisionFeatures (long *buffer, int maxFeatures)
 
unsigned char revisionHardwareGet (long revisionFeatureID, int *errorCode)
 
unsigned short int revisionFirmwareGet (long revisionFeatureID, int *errorCode)
 
int getNumberOfSpectrumProcessingFeatures ()
 
int getSpectrumProcessingFeatures (long *buffer, int maxFeatures)
 
unsigned short int spectrumProcessingScansToAverageGet (long spectrumProcessingFeatureID, int *errorCode)
 
unsigned char spectrumProcessingBoxcarWidthGet (long spectrumProcessingFeatureID, int *errorCode)
 
void spectrumProcessingBoxcarWidthSet (long featureID, int *errorCode, unsigned char boxcarWidth)
 
void spectrumProcessingScansToAverageSet (long featureID, int *errorCode, unsigned short int scansToAverage)
 
int getNumberOfOpticalBenchFeatures ()
 
int getOpticalBenchFeatures (long *buffer, int maxFeatures)
 
unsigned short int opticalBenchGetFiberDiameterMicrons (long opticalBenchFeatureID, int *errorCode)
 
unsigned short int opticalBenchGetSlitWidthMicrons (long opticalBenchFeatureID, int *errorCode)
 
int opticalBenchGetID (long opticalBenchFeatureID, int *errorCode, char *buffer, int bufferLength)
 
int opticalBenchGetSerialNumber (long opticalBenchFeatureID, int *errorCode, char *buffer, int bufferLength)
 
int opticalBenchGetCoating (long opticalBenchFeatureID, int *errorCode, char *buffer, int bufferLength)
 
int opticalBenchGetFilter (long opticalBenchFeatureID, int *errorCode, char *buffer, int bufferLength)
 
int opticalBenchGetGrating (long opticalBenchFeatureID, int *errorCode, char *buffer, int bufferLength)
 
int getNumberOfStrayLightCoeffsFeatures ()
 
int getStrayLightCoeffsFeatures (long *buffer, int maxFeatures)
 
int strayLightCoeffsGet (long featureID, int *errorCode, double *buffer, int bufferLength)
 
int getNumberOfDataBufferFeatures ()
 
int getDataBufferFeatures (long *buffer, int maxFeatures)
 
void dataBufferClear (long featureID, int *errorCode)
 
unsigned long dataBufferGetNumberOfElements (long featureID, int *errorCode)
 
unsigned long dataBufferGetBufferCapacity (long featureID, int *errorCode)
 
unsigned long dataBufferGetBufferCapacityMaximum (long featureID, int *errorCode)
 
unsigned long dataBufferGetBufferCapacityMinimum (long featureID, int *errorCode)
 
void dataBufferSetBufferCapacity (long featureID, int *errorCode, unsigned long capacity)
 
int getNumberOfAcquisitionDelayFeatures ()
 
int getAcquisitionDelayFeatures (long *buffer, int maxFeatures)
 
void acquisitionDelaySetDelayMicroseconds (long featureID, int *errorCode, unsigned long delay_usec)
 
unsigned long acquisitionDelayGetDelayMicroseconds (long featureID, int *errorCode)
 
unsigned long acquisitionDelayGetDelayIncrementMicroseconds (long featureID, int *errorCode)
 
unsigned long acquisitionDelayGetDelayMaximumMicroseconds (long featureID, int *errorCode)
 
unsigned long acquisitionDelayGetDelayMinimumMicroseconds (long featureID, int *errorCode)
 

Protected Member Functions

RawUSBBusAccessFeatureAdaptergetRawUSBBusAccessFeatureByID (long featureID)
 
SerialNumberFeatureAdaptergetSerialNumberFeatureByID (long featureID)
 
SpectrometerFeatureAdaptergetSpectrometerFeatureByID (long featureID)
 
ThermoElectricCoolerFeatureAdaptergetTECFeatureByID (long featureID)
 
IrradCalFeatureAdaptergetIrradCalFeatureByID (long featureID)
 
EEPROMFeatureAdaptergetEEPROMFeatureByID (long featureID)
 
LightSourceFeatureAdaptergetLightSourceFeatureByID (long featureID)
 
StrobeLampFeatureAdaptergetStrobeLampFeatureByID (long featureID)
 
ContinuousStrobeFeatureAdaptergetContinuousStrobeFeatureByID (long featureID)
 
ShutterFeatureAdaptergetShutterFeatureByID (long featureID)
 
NonlinearityCoeffsFeatureAdaptergetNonlinearityCoeffsFeatureByID (long featureID)
 
TemperatureFeatureAdaptergetTemperatureFeatureByID (long featureID)
 
RevisionFeatureAdaptergetRevisionFeatureByID (long featureID)
 
OpticalBenchFeatureAdaptergetOpticalBenchFeatureByID (long featureID)
 
SpectrumProcessingFeatureAdaptergetSpectrumProcessingFeatureByID (long featureID)
 
StrayLightCoeffsFeatureAdaptergetStrayLightCoeffsFeatureByID (long featureID)
 
PixelBinningFeatureAdaptergetPixelBinningFeatureByID (long featureID)
 
DataBufferFeatureAdaptergetDataBufferFeatureByID (long featureID)
 
AcquisitionDelayFeatureAdaptergetAcquisitionDelayFeatureByID (long featureID)
 

Protected Attributes

unsigned long instanceID
 
seabreeze::Devicedevice
 
std::vector< RawUSBBusAccessFeatureAdapter * > rawUSBBusAccessFeatures
 
std::vector< SerialNumberFeatureAdapter * > serialNumberFeatures
 
std::vector< SpectrometerFeatureAdapter * > spectrometerFeatures
 
std::vector< ThermoElectricCoolerFeatureAdapter * > tecFeatures
 
std::vector< IrradCalFeatureAdapter * > irradCalFeatures
 
std::vector< EEPROMFeatureAdapter * > eepromFeatures
 
std::vector< LightSourceFeatureAdapter * > lightSourceFeatures
 
std::vector< StrobeLampFeatureAdapter * > strobeLampFeatures
 
std::vector< ContinuousStrobeFeatureAdapter * > continuousStrobeFeatures
 
std::vector< ShutterFeatureAdapter * > shutterFeatures
 
std::vector< NonlinearityCoeffsFeatureAdapter * > nonlinearityFeatures
 
std::vector< TemperatureFeatureAdapter * > temperatureFeatures
 
std::vector< RevisionFeatureAdapter * > revisionFeatures
 
std::vector< OpticalBenchFeatureAdapter * > opticalBenchFeatures
 
std::vector< SpectrumProcessingFeatureAdapter * > spectrumProcessingFeatures
 
std::vector< StrayLightCoeffsFeatureAdapter * > strayLightFeatures
 
std::vector< PixelBinningFeatureAdapter * > pixelBinningFeatures
 
std::vector< DataBufferFeatureAdapter * > dataBufferFeatures
 
std::vector< AcquisitionDelayFeatureAdapter * > acquisitionDelayFeatures
 

The documentation for this class was generated from the following file: