OceanDirect  1.30.1-rc.4
OceanDirect C++/C API
oceandirect::api::DeviceAdapter Class Reference
Collaboration diagram for oceandirect::api::DeviceAdapter:

Data Structures

class  DeviceConfiguration
 

Public Member Functions

 DeviceAdapter (Device *dev, unsigned long id)
 
void abortAcquisition (long featureID, int *errorCode)
 
void acquireSpectraToBuffer (long featureID, int *errorCode)
 
unsigned long acquisitionDelayGetDelayIncrementMicroseconds (long featureID, int *errorCode)
 
unsigned long acquisitionDelayGetDelayMaximumMicroseconds (long featureID, int *errorCode)
 
unsigned long acquisitionDelayGetDelayMicroseconds (long featureID, int *errorCode)
 
unsigned long acquisitionDelayGetDelayMinimumMicroseconds (long featureID, int *errorCode)
 
void acquisitionDelaySetDelayMicroseconds (long featureID, int *errorCode, unsigned long delay_usec)
 
void addStaticIpAddress (long featureID, int *errorCode, unsigned char ifNum, unsigned char *ipAddress, int ipAddressLength, unsigned int netmask)
 
double analogInGetMaximumVolts (long featureID, int *errorCode)
 
double analogInGetMinimumVolts (long featureID, int *errorCode)
 
int analogInGetNumberOfInputs (long featureID, int *errorCode)
 
double analogInGetVoltAtPin (long featureID, int *errorCode, int pin)
 
void analogInSetAltPins (long featureID, int *errorCode, int pinNumber, int pinType)
 
double analogOutGetMaximumVolts (long featureID, int *errorCode)
 
double analogOutGetMinimumVolts (long featureID, int *errorCode)
 
int analogOutGetNumberOfOutputs (long featureID, int *errorCode)
 
void analogOutSetAltPins (long featureID, int *errorCode, int pinNumber, int pinType)
 
void analogOutSetDCVoltsAtPin (long featureID, int *errorCode, int pin, double voltage)
 
void ApplyDeviceConfigBoxcarWidth (int *errorCode, double *sample, int sampleSize)
 
int ApplyDeviceConfigElecDarkPixels (int *errorCode, double *sample, int sampleSize)
 
int ApplyDeviceConfigNonlinearityCoeffs (int *errorCode, double *sample, int sampleSize)
 
unsigned long backToBackGetNumScans (long featureID, int *errorCode)
 
void backToBackSetNumScans (long featureID, int *errorCode, unsigned long numScans)
 
unsigned char binningGetDefaultPixelBinningFactor (long spectrometerFeatureID, int *errorCode)
 
unsigned char binningGetMaxPixelBinningFactor (long spectrometerFeatureID, int *errorCode)
 
unsigned char binningGetPixelBinningFactor (long spectrometerFeatureID, int *errorCode)
 
void binningSetDefaultPixelBinningFactor (long spectrometerFeatureID, int *errorCode)
 
void binningSetDefaultPixelBinningFactor (long spectrometerFeatureID, int *errorCode, const unsigned char binningFactor)
 
void binningSetPixelBinningFactor (long spectrometerFeatureID, int *errorCode, const unsigned char binningFactor)
 
int checkArrayForSaturation (std::vector< double > arrayToCheck, int *errorCode)
 
void close ()
 
bool continuousStrobeGetEnable (long featureID, int *errorCode)
 
unsigned long continuousStrobeGetPeriodIncrementMicroseconds (long featureID, int *errorCode)
 
unsigned long continuousStrobeGetPeriodMaximumMicroseconds (long featureID, int *errorCode)
 
unsigned long continuousStrobeGetPeriodMicroseconds (long featureID, int *errorCode)
 
unsigned long continuousStrobeGetPeriodMinimumMicroseconds (long featureID, int *errorCode)
 
unsigned long continuousStrobeGetWidthMicroseconds (long featureID, int *errorCode)
 
void continuousStrobeSetEnable (long featureID, int *errorCode, bool enable)
 
void continuousStrobeSetPeriodMicroseconds (long featureID, int *errorCode, unsigned long period_usec)
 
void continuousStrobeSetWidthMicroseconds (long featureID, int *errorCode, unsigned long strobeWidthMicroseconds)
 
void dataBufferClear (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)
 
bool dataBufferGetBufferEnabled (long featureID, int *errorCode)
 
unsigned long dataBufferGetNumberOfElements (long featureID, int *errorCode)
 
void dataBufferSetBufferCapacity (long featureID, int *errorCode, unsigned long capacity)
 
void dataBufferSetBufferEnabled (long featureID, int *errorCode, bool enabled)
 
void deleteStaticIpAddress (long featureID, int *errorCode, unsigned char ifNum, unsigned char addressIndex)
 
int eepromReadSlot (long featureID, int *errorCode, int slotNumber, unsigned char *buffer, int length)
 
int getAcquisitionDelayFeatures (long *buffer, int maxFeatures)
 
int getActivePixelRange (long deviceID, int *error_code, int *range, int rangeSize)
 
int getActivityFeatures (long *buffer, int maxFeatures)
 
int getAllTemperatures (long temperatureFeatureID, int *errorCode, double *buffer, int max_length)
 
int getAnalogInFeatures (long *buffer, int maxFeatures)
 
int getAnalogOutFeatures (long *buffer, int maxFeatures)
 
int getBackToBackFeatures (long *buffer, int maxFeatures)
 
int getBadPixelIndices (long deviceID, int *error_code, int *baxPixelIndices, int baxPixelSize)
 
int getBaselineLevel (long deviceID, int *error_code)
 
int getBaudRate (long featureID, int *errorCode)
 
int getCommandList (long featureID, int *errorCode, unsigned int *commands, int length)
 
int getContinuousStrobeFeatures (long *buffer, int maxFeatures)
 
int getDataBufferFeatures (long *buffer, int maxFeatures)
 
Device * getDevice ()
 
int getDeviceAlias (long featureID, int *errorCode, char *buffer, int bufferLength)
 
const std::vector< int > & GetDeviceConfigElecDarkPixels ()
 
std::vector< double > GetDeviceConfigIrradCalFile ()
 
double GetDeviceConfigIrradCollectionArea ()
 
unsigned long GetDeviceConfigMaxIntegrationTime ()
 
unsigned long GetDeviceConfigMinIntegrationTime ()
 
const std::vector< double > & GetDeviceConfigNonlinearityCoeffs ()
 
int GetDeviceConfigNumPixels ()
 
int GetDeviceConfigSmoothFactor ()
 
int getDeviceConfiguration (int *errorCode)
 
std::vector< double > GetDeviceConfigWavelengths ()
 
unsigned char getDeviceEndpoint (int *errorCode, usbEndpointType anEndpointType)
 
bool getDeviceIdleState (long featureID, int *errorCode)
 
int getDeviceType (int *errorCode, char *buffer, unsigned int maxLength)
 
void getDHCPServerAddressRange (long featureID, int *errorCode, unsigned char ifNum, unsigned int *outBaseIpAddress, unsigned int ipAddressArraySize, unsigned int *outNetmask)
 
int getDHCPServerFeatures (long *buffer, int maxFeatures)
 
int getEEPROMFeatures (long *buffer, int maxFeatures)
 
int getGpioCount (long featureID, int *errorCode)
 
int getGpioFeatures (long *buffer, int maxFeatures)
 
unsigned long getID ()
 
std::uint32_t getIntegrationTimeStepSize (long featureID, int *errorCode)
 
int getIpv4AddressFeatures (long *buffer, int maxFeatures)
 
int getIrradCalFeatures (long *buffer, int maxFeatures)
 
int getLightSourceFeatures (long *buffer, int maxFeatures)
 
DeviceLocatorInterface * getLocation ()
 
int getManufacturerString (long featureID, int *errorCode, char *buffer, int bufferLength)
 
int getMaximumADCCount (long deviceID, int *error_code)
 
int getModelString (long featureID, int *errorCode, char *buffer, int bufferLength)
 
double getNonlinearityCoeffs (long featureID, int *errorCode, int index)
 
int getNonlinearityCoeffsCount (long featureID, int *errorCode)
 
int getNonlinearityCoeffsFeatures (long *buffer, int maxFeatures)
 
int getNumberOfAcquisitionDelayFeatures ()
 
int getNumberOfActivityFeatures ()
 
int getNumberOfAnalogInFeatures ()
 
int getNumberOfAnalogOutFeatures ()
 
int getNumberOfBackToBackFeatures ()
 
int getNumberOfContinuousStrobeFeatures ()
 
int getNumberOfDataBufferFeatures ()
 
int getNumberOfEEPROMFeatures ()
 
int getNumberOfGpioFeatures ()
 
int getNumberOfIpAddresses (long featureID, int *errorCode, unsigned char ifNum)
 
int getNumberOfIpv4Features ()
 
int getNumberOfIrradCalFeatures ()
 
int getNumberOfLightSourceFeatures ()
 
int getNumberOfNonlinearityCoeffsFeatures ()
 
int getNumberOfOpticalBenchFeatures ()
 
int getNumberOfPixelBinningFeatures ()
 
int getNumberOfRawBusAccessFeatures ()
 
int getNumberOfRevisionFeatures ()
 
int getNumberOfSerialNumberFeatures ()
 
int getNumberOfSpectrometerFeatures ()
 
int getNumberOfStatusFeatures ()
 
int getNumberOfStrayLightCoeffsFeatures ()
 
int getNumberOfStrobeLampFeatures ()
 
int getNumberOfTemperatureFeatures ()
 
int getNumberOfThermoElectricFeatures ()
 
int getOpticalBenchFeatures (long *buffer, int maxFeatures)
 
int getOpticalDarkPixelRange (long deviceID, int *error_code, int *range, int rangeSize)
 
int getOriginalManufacturerString (long featureID, int *errorCode, char *buffer, int bufferLength)
 
int getOriginalModelString (long featureID, int *errorCode, char *buffer, int bufferLength)
 
std::uint16_t getOriginalPID (long featureID, int *errorCode)
 
std::uint16_t getOriginalVID (long featureID, int *errorCode)
 
std::uint16_t getPID (long featureID, int *errorCode)
 
int getPixelBinningFeatures (long *buffer, int maxFeatures)
 
int getPixelCount (long deviceID, int *error_code)
 
int getRawBusAccessFeatures (long *buffer, int maxFeatures)
 
int getRevisionFeatures (long *buffer, int maxFeatures)
 
int getSaturationLevel (long deviceID, int *error_code)
 
int getSerialNumber (long featureID, int *errorCode, char *buffer, int bufferLength)
 
int getSerialNumberFeatures (long *buffer, int maxFeatures)
 
unsigned char getSerialNumberMaximumLength (long featureID, int *errorCode)
 
unsigned long getSingleStrobeCycleMaximumMicroseconds (long featureID, int *errorCode)
 
unsigned long getSingleStrobeDelayIncrementMicroseconds (long featureID, int *errorCode)
 
unsigned long getSingleStrobeDelayMaximumMicroseconds (long featureID, int *errorCode)
 
unsigned long getSingleStrobeDelayMinimumMicroseconds (long featureID, int *errorCode)
 
int getSingleStrobeFeatures (long *buffer, int maxFeatures)
 
unsigned long getSingleStrobeWidthIncrementMicroseconds (long featureID, int *errorCode)
 
unsigned long getSingleStrobeWidthMaximumMicroseconds (long featureID, int *errorCode)
 
unsigned long getSingleStrobeWidthMinimumMicroseconds (long featureID, int *errorCode)
 
int getSpectrometerFeatures (long *buffer, int maxFeatures)
 
int getStatusFeatures (long *buffer, int maxFeatures)
 
int getStrayLightCoeffsFeatures (long *buffer, int maxFeatures)
 
std::string getStringDescriptor (long featureID, int *errorCode, int index)
 
int getStrobeLampFeatures (long *buffer, int maxFeatures)
 
double getTemperatureExtreme (long temperatureFeatureID, int *errorCode)
 
int getTemperatureFeatures (long *buffer, int maxFeatures)
 
int getThermoElectricFeatures (long *buffer, int maxFeatures)
 
long long int getTime (long featureID, int *errorCode)
 
int getTransitionPixelRange (long deviceID, int *error_code, int *range, int rangeSize)
 
int getUserString (long featureID, int *errorCode, char *buffer, int bufferLength)
 
int getUserString (long featureID, int *errorCode, int index, char *buffer, int bufferLength)
 
int getUserStringCount (long featureID, int *errorCode)
 
std::uint16_t getVID (long featureID, int *errorCode)
 
uint32_t gpioGetOutputAlternate (long featureID, int *errorCode)
 
bool gpioGetOutputAlternate (long featureID, int *errorCode, int bit)
 
uint32_t gpioGetOutputEnable (long featureID, int *errorCode)
 
bool gpioGetOutputEnable (long featureID, int *errorCode, int bit)
 
uint32_t gpioGetValue (long featureID, int *errorCode)
 
bool gpioGetValue (long featureID, int *errorCode, int bit)
 
void gpioSetOutputAlternate (long featureID, int *errorCode, int bit, bool isAlternate)
 
void gpioSetOutputAlternate (long featureID, int *errorCode, uint32_t bitMask)
 
void gpioSetOutputEnable (long featureID, int *errorCode, std::uint32_t bitPosition, bool isOutput)
 
void gpioSetOutputEnable (long featureID, int *errorCode, std::uint32_t bits, std::uint32_t bitmask)
 
void gpioSetValue (long featureID, int *errorCode, std::uint32_t bitPosition, bool value)
 
void gpioSetValue (long featureID, int *errorCode, uint32_t bitmask)
 
void gpioSetValue (long featureID, int *errorCode, uint32_t bits, uint32_t bitmask)
 
bool irradCalibrationHasCollectionArea (long featureID, int *errorCode)
 
int irradCalibrationRead (long featureID, int *errorCode, float *buffer, int bufferLength)
 
float irradCalibrationReadCollectionArea (long featureID, int *errorCode)
 
int irradCalibrationSizeRead (long featureID, int *errorCode)
 
int irradCalibrationWrite (long featureID, int *errorCode, float *buffer, int bufferLength)
 
void irradCalibrationWriteCollectionArea (long featureID, int *errorCode, float area)
 
bool isDHCPEnabled (long featureID, int *errorCode, unsigned char ifNum)
 
bool isDHCPServerEnabled (long featureID, int *errorCode, unsigned char ifNum)
 
bool lampGetStrobeEnable (long featureID, int *errorCode)
 
void lampSetStrobeEnable (long featureID, int *errorCode, bool strobeEnable)
 
bool ledActivityGetEnable (long featureID, int *errorCode)
 
void ledActivitySetEnable (long featureID, int *errorCode, bool enable)
 
int lightSourceGetCount (long featureID, int *errorCode)
 
double lightSourceGetIntensity (long featureID, int *errorCode, int lightSourceIndex)
 
bool lightSourceHasEnable (long featureID, int *errorCode, int lightSourceIndex)
 
bool lightSourceHasVariableIntensity (long featureID, int *errorCode, int lightSourceIndex)
 
bool lightSourceIsEnabled (long featureID, int *errorCode, int lightSourceIndex)
 
void lightSourceSetEnable (long featureID, int *errorCode, int lightSourceIndex, bool enable)
 
void lightSourceSetIntensity (long featureID, int *errorCode, int lightSourceIndex, double intensity)
 
int nonlinearityCoeffsGet (long featureID, int *errorCode, double *buffer, int bufferLength)
 
int nonlinearityCoeffsSet (long featureID, int *errorCode, double *buffer, int bufferLength)
 
int open (int *errorCode)
 
int opticalBenchGetArrayWavelength (long opticalBenchFeatureID, int *errorCode, char *buffer, int bufferLength)
 
int opticalBenchGetCoating (long opticalBenchFeatureID, int *errorCode, char *buffer, int bufferLength)
 
unsigned short int opticalBenchGetFiberDiameter (long opticalBenchFeatureID, int *errorCode)
 
int opticalBenchGetFilter (long opticalBenchFeatureID, int *errorCode, char *buffer, int bufferLength)
 
int opticalBenchGetGrating (long opticalBenchFeatureID, int *errorCode, char *buffer, int bufferLength)
 
int opticalBenchGetId (long opticalBenchFeatureID, int *errorCode, char *buffer, int bufferLength)
 
int opticalBenchGetSerialNumber (long opticalBenchFeatureID, int *errorCode, char *buffer, int bufferLength)
 
unsigned short int opticalBenchGetSlitWidthMicrons (long opticalBenchFeatureID, int *errorCode)
 
int opticalBenchLensInstalled (long opticalBenchFeatureID, int *errorCode, char *buffer, int bufferLength)
 
void opticalBenchSetCoating (long opticalBenchFeatureID, int *errorCode, char *buffer, int bufferLength)
 
void opticalBenchSetFiberDiameter (long opticalBenchFeatureID, int *errorCode, unsigned short int diameterMicrons)
 
void opticalBenchSetFilter (long opticalBenchFeatureID, int *errorCode, char *buffer, int bufferLength)
 
void opticalBenchSetGrating (long opticalBenchFeatureID, int *errorCode, char *buffer, int bufferLength)
 
void opticalBenchSetId (long opticalBenchFeatureID, int *errorCode, char *buffer, int bufferLength)
 
void opticalBenchSetSerialNumber (long opticalBenchFeatureID, int *errorCode, char *buffer, int bufferLength)
 
void opticalBenchSetSlitWidthMicrons (long opticalBenchFeatureID, int *errorCode, unsigned short int widthMicrons)
 
int rawBusAccessRead (long featureID, int *errorCode, unsigned char *buffer, unsigned int bufferLength)
 
int rawBusAccessRead (long featureID, int *errorCode, unsigned char *buffer, unsigned int bufferLength, unsigned char endpoint)
 
int rawBusAccessWrite (long featureID, int *errorCode, unsigned char *buffer, unsigned int bufferLength)
 
int rawBusAccessWrite (long featureID, int *errorCode, unsigned char *buffer, unsigned int bufferLength, unsigned char endpoint)
 
void readIpAddress (long featureID, int *errorCode, unsigned char ifNum, unsigned char addressIndex, unsigned char *ipAddress, int ipAddressLength, unsigned int *netmask)
 
void resetDevice (long featureID, int *errorCode)
 
int revisionFirmwareGet (long featureID, int *errorCode, char *buffer, int bufferLength)
 
int revisionFPGAGet (long featureID, int *errorCode, char *buffer, int bufferLength)
 
int revisionHardwareGet (long featureID, int *errorCode, char *buffer, int bufferLength)
 
void saveSettingsToFlash (long featureID, int *errorCode)
 
void setBadPixelIndices (long deviceID, int *error_code, int *baxPixelIndices, int baxPixelSize)
 
void setBaselineLevel (long deviceID, int *error_code, int level)
 
void setBaudRate (long featureID, int *errorCode, int baudRate)
 
void setDeviceAlias (long featureID, int *errorCode, char *buffer, int bufferLength)
 
void setDHCPEnable (long featureID, int *errorCode, unsigned char ifNum, unsigned char enabled)
 
void setDHCPServerAddressRange (long featureID, int *errorCode, unsigned char ifNum, const unsigned int *baseIpAddress, unsigned int ipAddressArraySize, unsigned int netmask)
 
void setDHCPServerEnable (long featureID, int *errorCode, unsigned char ifNum, bool enable)
 
void setManufacturerString (long featureID, int *errorCode, char *buffer, int bufferLength)
 
void setModelString (long featureID, int *errorCode, char *buffer, int bufferLength)
 
void setNonlinearityCoeffs (long featureID, int *errorCode, int index, double coefficient)
 
void setPID (long featureID, int *errorCode, std::uint16_t pid)
 
void setSaturationLevel (long deviceID, int *error_code, int level)
 
void setSerialNumber (long featureID, int *errorCode, char *buffer, int bufferLength)
 
void setTime (long featureID, int *errorCode, long long int timeInMicroseconds)
 
void setUserString (long featureID, int *errorCode, char *buffer, int bufferLength)
 
void setUserString (long featureID, int *errorCode, int index, char *buffer, int bufferLength)
 
void setVID (long featureID, int *errorCode, std::uint16_t vid)
 
unsigned long singleStrobeGetDelayMicroseconds (long featureID, int *errorCode)
 
bool singleStrobeGetEnable (long featureID, int *errorCode)
 
unsigned long singleStrobeGetWidthMicroseconds (long featureID, int *errorCode)
 
void singleStrobeSetDelayMicroseconds (long featureID, int *errorCode, unsigned long period_usec)
 
void singleStrobeSetEnable (long featureID, int *errorCode, bool enable)
 
void singleStrobeSetWidthMicroseconds (long featureID, int *errorCode, unsigned long period_usec)
 
int spectrometerDarkCorrectSpectrum (long spectrometerFeatureID, int *errorCode, double *darkSpectrum, int darkSpectrumLength, double *illuminatedSpectrum, int illuminatedSpectrumLength, double *darkCorrectedSpectrum, int darkCorrectedSpectrumLength)
 
int spectrometerDarkCorrectSpectrum (long spectrometerFeatureID, int *errorCode, double *illuminatedSpectrum, int illuminatedSpectrumLength, double *darkCorrectedSpectrum, int darkCorrectedSpectrumLength)
 
unsigned short int spectrometerGetBoxcarWidth (long spectrometerFeatureID, int *errorCode)
 
int spectrometerGetDarkCorrectedSpectrum (long spectrometerFeatureID, int *errorCode, double *darkCorrectedSpectrum, int darkCorrectedSpectrumLength)
 
int spectrometerGetDarkCorrectedSpectrum (long spectrometerFeatureID, int *errorCode, double *darkSpectrum, int darkSpectrumLength, double *darkCorrectedSpectrum, int darkCorrectedSpectrumLength)
 
unsigned long spectrometerGetDelayIncrementMicroseconds (long featureID, int *errorCode)
 
unsigned long spectrometerGetDelayMaximumMicroseconds (long featureID, int *errorCode)
 
unsigned long spectrometerGetDelayMicroseconds (long featureID, int *errorCode)
 
unsigned long spectrometerGetDelayMinimumMicroseconds (long featureID, int *errorCode)
 
int spectrometerGetElectricDarkPixelCount (long spectrometerFeatureID, int *errorCode)
 
int spectrometerGetElectricDarkPixelIndices (long spectrometerFeatureID, int *errorCode, int *indices, int length)
 
int spectrometerGetFormattedSpectrum (long spectrometerFeatureID, int *errorCode, double *buffer, int bufferLength)
 
int spectrometerGetFormattedSpectrumLength (long spectrometerFeatureID, int *errorCode)
 
int spectrometerGetFormattedSpectrumWithMetadata (long spectrometerFeatureID, int *errorCode, SpectrumWithMetadata *buffer, int bufferLength, bool apply_ec=true)
 
unsigned long spectrometerGetIntegrationTimeMicros (long spectrometerFeatureID, int *errorCode)
 
unsigned long spectrometerGetMaximumIntegrationTimeMicros (long spectrometerFeatureID, int *errorCode)
 
double spectrometerGetMaximumIntensity (long spectrometerFeatureID, int *errorCode)
 
unsigned long spectrometerGetMinimumAveragingIntegrationTimeMicros (long spectrometerFeatureID, int *errorCode)
 
unsigned long spectrometerGetMinimumIntegrationTimeMicros (long spectrometerFeatureID, int *errorCode)
 
int spectrometerGetNonlinearityCorrectedSpectrum (long spectrometerFeatureID, int *errorCode, double *darkSpectrum, int darkSpectrumLength, double *nonlinearityCorrectedSpectrum, int nonlinearityCorrectedSpectrumLength)
 
int spectrometerGetNonlinearityCorrectedSpectrum (long spectrometerFeatureID, int *errorCode, double *nonlinearityCorrectedSpectrum, int nonlinearityCorrectedSpectrumLength)
 
unsigned short int spectrometerGetScansToAverage (long spectrometerFeatureID, int *errorCode)
 
int spectrometerGetStoredDarkSpectrum (long spectrometerFeatureID, int *errorCode, double *darkSpectrum, int darkSpectrumLength)
 
int spectrometerGetTriggerMode (long featureID, int *errorCode)
 
int spectrometerGetUnformattedSpectrum (long spectrometerFeatureID, int *errorCode, unsigned char *buffer, int bufferLength)
 
int spectrometerGetUnformattedSpectrumLength (long spectrometerFeatureID, int *errorCode)
 
int spectrometerGetWavelengthCoefficients (long spectrometerFeatureID, int *errorCode, double *coeff, int length)
 
int spectrometerGetWavelengths (long spectrometerFeatureID, int *errorCode, double *wavelengths, int length)
 
int spectrometerNonlinearityCorrectSpectrum (long spectrometerFeatureID, int *errorCode, double *darkSpectrum, int darkSpectrumLength, double *illuminatedSpectrum, int illuminatedSpectrumLength, double *nonlinearityCorrectedSpectrum, int nonlinearityCorrectedSpectrumLength)
 
int spectrometerNonlinearityCorrectSpectrum (long spectrometerFeatureID, int *errorCode, double *illuminatedSpectrum, int illuminatedSpectrumLength, double *nonlinearityCorrectedSpectrum, int nonlinearityCorrectedSpectrumLength)
 
void spectrometerSetBoxcarWidth (long spectrometerFeatureID, int *errorCode, unsigned short int newBoxcarWidth)
 
void spectrometerSetDelayMicroseconds (long featureID, int *errorCode, unsigned long delayMicroseconds)
 
void spectrometerSetIntegrationTimeMicros (long spectrometerFeatureID, int *errorCode, unsigned long integrationTimeMicros)
 
void spectrometerSetScansToAverage (long spectrometerFeatureID, int *errorCode, unsigned short int newScansToAverage)
 
void spectrometerSetStoredDarkSpectrum (long spectrometerFeatureID, int *errorCode, double *darkSpectrum, int darkSpectrumLength)
 
void spectrometerSetTriggerMode (long featureID, int *errorCode, int mode)
 
void spectrometerSetWavelengthCoefficients (long spectrometerFeatureID, int *errorCode, double *coeff, int length)
 
unsigned long statusGetIntegrationTime (long statusFeatureID, int *errorCode)
 
int statusReadStatus (long statusFeatureId, int *errorCode, unsigned char *buffer, int bufferLength)
 
int strayLightCoeffsGet (long featureID, int *errorCode, double *buffer, int bufferLength)
 
bool tecGetEnable (long featureID, int *errorCode)
 
bool tecGetFanEnable (long featureID, int *errorCode)
 
float tecGetSetpoint (long featureID, int *errorCode)
 
bool tecGetStable (long featureID, int *errorCode)
 
double tecReadTemperatureDegreesC (long featureID, int *errorCode)
 
void tecSetEnable (long featureID, int *errorCode, bool tecEnable)
 
void tecSetFanEnable (long featureID, int *errorCode, bool enable)
 
void tecSetTemperatureSetpointDegreesC (long featureID, int *errorCode, double temperatureDegreesCelsius)
 
int temperatureCountGet (long temperatureFeatureID, int *errorCode)
 
double temperatureGet (long temperatureFeatureID, int *errorCode, int index)
 

Data Fields

class oceandirect::api::DeviceAdapter::DeviceConfiguration deviceConfig
 

Protected Types

enum class  featureId {
  invalid , serNo , spectrm , tec ,
  iirad , eeprom , strobe , wavecal ,
  nonline , stray , raw , contsrtb ,
  light , temper , optic , revise ,
  process , buffer , delay , binn ,
  gpio , singstrb , status , backToBack ,
  activity , time , volt_in , volt_out ,
  dhcp , ipv4_address , pixel , autonulling ,
  userstring , deviceInfo , deviceAlias , serialPort ,
  spectrumAcquisitionControl
}
 

Protected Member Functions

AcquisitionDelayFeatureAdaptergetAcquisitionDelayFeatureByID (long featureID)
 
LedActivityFeatureAdaptergetActivityFeatureByID (long featureID)
 
AnalogInFeatureAdaptergetAnalogInByID (long featureID)
 
AnalogOutFeatureAdaptergetAnalogOutByID (long featureID)
 
AutoNullingFeatureAdaptergetAutoNullingFeatureByID (long featureID)
 
BackToBackFeatureAdaptergetBackToBackFeatureByID (long featureID)
 
ContinuousStrobeFeatureAdaptergetContinuousStrobeFeatureByID (long featureID)
 
DataBufferFeatureAdaptergetDataBufferFeatureByID (long featureID)
 
DeviceAliasFeatureAdaptergetDeviceAliasFeatureByID (long featureID)
 
DeviceInformationFeatureAdaptergetDeviceInformationFeatureByID (long featureID)
 
DHCPServerConfigurationFeatureAdaptergetDHCPFeatureByID (long featureID)
 
EEPROMFeatureAdaptergetEEPROMFeatureByID (long featureID)
 
GpioFeatureAdaptergetGpioFeatureByID (long featureID)
 
Ipv4AddressFeatureAdaptergetIpv4AddressFeatureByID (long featureID)
 
IrradCalFeatureAdaptergetIrradCalFeatureByID (long featureID)
 
LightSourceFeatureAdaptergetLightSourceFeatureByID (long featureID)
 
NonlinearityCoeffsFeatureAdaptergetNonlinearityCoeffsFeatureByID (long featureID)
 
OpticalBenchFeatureAdaptergetOpticalBenchFeatureByID (long featureID)
 
PixelBinningFeatureAdaptergetPixelBinningFeatureByID (long featureID)
 
PixelFeatureAdaptergetPixelFeatureByID (long featureID)
 
QueryStatusFeatureAdaptergetQueryStatusFeatureByID (long featureID)
 
RawBusAccessFeatureAdaptergetRawBusAccessFeatureByID (long featureID)
 
RevisionFeatureAdaptergetRevisionFeatureByID (long featureID)
 
SerialNumberFeatureAdaptergetSerialNumberFeatureByID (long featureID)
 
SerialPortFeatureAdaptergetSerialPortFeatureByID (long featureID)
 
SingleStrobeFeatureAdaptergetSingleStrobeFeatureByID (long featureID)
 
SpectrometerFeatureAdaptergetSpectrometerFeatureByID (long featureID)
 
SpectrumAcquisitionControlFeatureAdaptergetSpectrumAcquisitionControlFeatureByID (long featureID)
 
StrayLightCoeffsFeatureAdaptergetStrayLightCoeffsFeatureByID (long featureID)
 
StrobeLampFeatureAdaptergetStrobeLampFeatureByID (long featureID)
 
ThermoElectricCoolerFeatureAdaptergetTECFeatureByID (long featureID)
 
TemperatureFeatureAdaptergetTemperatureFeatureByID (long featureID)
 
TimeFeatureAdaptergetTimeFeatureByID (long featureID)
 
UserStringFeatureAdaptergetUserStringFeatureByID (long featureID)
 

Protected Attributes

std::vector< AcquisitionDelayFeatureAdapter * > acquisitionDelayFeatures
 
std::vector< AnalogInFeatureAdapter * > analogInFeatures
 
std::vector< AnalogOutFeatureAdapter * > analogOutFeatures
 
std::vector< AutoNullingFeatureAdapter * > autoNullingFeatures
 
std::vector< BackToBackFeatureAdapter * > backToBackFeatures
 
int boxcarWidth
 
std::vector< ContinuousStrobeFeatureAdapter * > continuousStrobeFeatures
 
std::vector< DataBufferFeatureAdapter * > dataBufferFeatures
 
oceandirect::Device * device
 
std::vector< DeviceAliasFeatureAdapter * > deviceAliasFeatures
 
std::vector< DeviceInformationFeatureAdapter * > deviceInformationFeatures
 
std::vector< DHCPServerConfigurationFeatureAdapter * > dhcpFeatures
 
std::vector< EEPROMFeatureAdapter * > eepromFeatures
 
std::vector< GpioFeatureAdapter * > gpioFeatures
 
unsigned long instanceID
 
std::vector< Ipv4AddressFeatureAdapter * > ipv4AddressFeatures
 
std::vector< IrradCalFeatureAdapter * > irradCalFeatures
 
std::vector< LedActivityFeatureAdapter * > ledActivityFeatures
 
std::vector< LightSourceFeatureAdapter * > lightSourceFeatures
 
std::vector< NonlinearityCoeffsFeatureAdapter * > nonlinearityFeatures
 
std::vector< OpticalBenchFeatureAdapter * > opticalBenchFeatures
 
std::vector< PixelBinningFeatureAdapter * > pixelBinningFeatures
 
std::vector< PixelFeatureAdapter * > pixelFeatures
 
std::vector< QueryStatusFeatureAdapter * > queryStatusFeatures
 
std::vector< RawBusAccessFeatureAdapter * > rawBusAccessFeatures
 
std::vector< RevisionFeatureAdapter * > revisionFeatures
 
int scanToAverage
 
std::vector< SerialNumberFeatureAdapter * > serialNumberFeatures
 
std::vector< SerialPortFeatureAdapter * > serialPortFeatures
 
std::vector< SingleStrobeFeatureAdapter * > singleStrobeFeatures
 
std::vector< SpectrometerFeatureAdapter * > spectrometerFeatures
 
std::vector< SpectrumAcquisitionControlFeatureAdapter * > spectrumAcquisitionControlFeatures
 
std::vector< StrayLightCoeffsFeatureAdapter * > strayLightFeatures
 
std::vector< StrobeLampFeatureAdapter * > strobeLampFeatures
 
std::vector< ThermoElectricCoolerFeatureAdapter * > tecFeatures
 
std::vector< TemperatureFeatureAdapter * > temperatureFeatures
 
std::vector< TimeFeatureAdapter * > timeFeatures
 
std::vector< UserStringFeatureAdapter * > userStringFeatures
 

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