SIDX 7
SIDXDevice.h
Go to the documentation of this file.
1 
6 #include "SIDXConstants.h"
7 
8 #ifndef SIDXXOPDevice_H
9 #define SIDXXOPDevice_H
10 
11 
21 SIDXDeviceActionDo(integer SIDXdevice, integer setting, string command, integer status);
33 SIDXDeviceActionGetByItem(integer SIDXdevice, integer index, integer setting, integer status);
45  (integer SIDXdevice, string name, integer setting, integer status);
54 SIDXDeviceActionGetCount(integer SIDXdevice, integer count, integer status);
67  (integer SIDXdevice, integer index, string name, integer status);
68 
80  (integer SIDXdevice, string description, integer status);
90 SIDXDeviceDriverGetName(integer SIDXdevice, string name, integer status);
98 SIDXDeviceDriverGetType(integer SIDXdevice, integer type, integer status);
99 
109 SIDXDeviceExtraBooleanGet(integer SIDXdevice, integer setting, integer value, integer status);
119 SIDXDeviceExtraBooleanSet(integer SIDXdevice, integer setting, integer value, integer status);
120 
131 SIDXDeviceExtraGetByItem(integer SIDXdevice, integer item, integer setting, integer status);
143  (integer SIDXdevice, string name, integer setting, integer status);
152 SIDXDeviceExtraGetCount(integer SIDXdevice, integer count, integer status);
164  (integer SIDXdevice, integer setting, string label, integer status);
177  (integer SIDXdevice, integer item, string name, integer status);
187 SIDXDeviceExtraGetType(integer SIDXdevice, integer setting, integer type, integer status);
202  (integer SIDXdevice, integer setting, string unit, integer status);
212  (integer SIDXdevice, integer setting, string description, integer status);
213 
223 SIDXDeviceExtraIntegerGet(integer SIDXdevice, integer setting, integer value, integer status);
235  (integer SIDXdevice, integer setting, integer minimum, integer maximum, integer status);
246  (integer SIDXdevice, integer setting, integer value, integer status);
256 SIDXDeviceExtraIntegerSet(integer SIDXdevice, integer setting, integer value, integer status);
257 
267 SIDXDeviceExtraIsSettable(integer SIDXdevice, integer setting, integer settable, integer status);
268 
279 SIDXDeviceExtraListGet(integer SIDXdevice, integer setting, integer index, integer status);
292  (integer SIDXdevice, integer setting, integer count, integer status);
305  (integer SIDXdevice, integer setting, integer index, double entry, integer status);
318  (integer SIDXdevice, integer setting, integer index, string description, integer status);
331 SIDXDeviceExtraListGetValue(integer SIDXdevice, integer setting, double value, integer status);
342 SIDXDeviceExtraListSet(integer SIDXdevice, integer setting, integer index, integer status);
353 SIDXDeviceExtraListSetValue(integer SIDXdevice, integer setting, double value, integer status);
354 
364 SIDXDeviceExtraRealGet(integer SIDXdevice, integer setting, double value, integer status);
376  (integer SIDXdevice, integer setting, double minimum, double maximum, integer status);
387 SIDXDeviceExtraRealGetValue(integer SIDXdevice, integer setting, double value, integer status);
397 SIDXDeviceExtraRealSet(integer SIDXdevice, integer setting, double value, integer status);
398 
412  integer SIDXdevice,
413  integer setting,
414  integer* value,
415  integer length,
416  integer return_length
417 , integer status);
428 SIDXDeviceExtraSequenceGetSize(integer SIDXdevice, integer setting, integer size, integer status);
441  (integer SIDXdevice, integer setting, integer* value, integer length, integer status);
442 
453  (integer SIDXdevice, integer setting, string value, integer status);
464  (integer SIDXdevice, integer setting, string value, integer status);
465 
474 SIDXDeviceGetDescription(integer SIDXdevice, string description, integer status);
482 SIDXDeviceGetLabel(integer SIDXdevice, string label, integer status);
490 SIDXDeviceGetName(integer SIDXdevice, string name, integer status);
491 
501 SIDXDevicePortAnalogGetRange(integer SIDXdevice, integer port, double minimum, double maximum, integer status);
510 SIDXDevicePortAnalogRead(integer SIDXdevice, integer port, double voltage, integer status);
519 SIDXDevicePortAnalogWrite(integer SIDXdevice, integer port, double voltage, integer status);
529 SIDXDevicePortBitRead(integer SIDXdevice, integer port, integer asserted, integer status);
540 SIDXDevicePortBitWrite(integer SIDXdevice, integer port, integer asserted, integer status);
549 SIDXDevicePortDigitalRead(integer SIDXdevice, integer port, integer value, integer status);
558 SIDXDevicePortDigitalWrite(integer SIDXdevice, integer port, integer value, integer status);
566 SIDXDevicePortGetCount(integer SIDXdevice, integer count, integer status);
576 SIDXDevicePortGetType(integer SIDXdevice, integer port, integer type, integer status);
577 
583 SIDXDeviceGetLastError(integer SIDXdevice, string message);
584 
585 #endif
SIDXDevicePortAnalogWrite(integer SIDXdevice, integer port, double voltage, integer status)
Sets the voltage as a fraction of maximum possible on the specified port.
SIDXDeviceExtraListGetEntry(integer SIDXdevice, integer setting, integer index, double entry, integer status)
Obtain the value associated with a specific device-specific setting index.
SIDXDeviceExtraListSetValue(integer SIDXdevice, integer setting, double value, integer status)
Set the device-specific setting to the specified real (floating-point) value.
SIDXDeviceExtraGetCount(integer SIDXdevice, integer count, integer status)
Obtain the total count of device-specific settings.
SIDXDeviceExtraIntegerSet(integer SIDXdevice, integer setting, integer value, integer status)
Set the device-specific setting to the specified integer value.
SIDXDevicePortDigitalWrite(integer SIDXdevice, integer port, integer value, integer status)
Sets the digital output bits to the values specified by the data parameter.
SIDXDeviceExtraStringSet(integer SIDXdevice, integer setting, string value, integer status)
Set the device-specific setting to the specified text string value.
File containing SIDX constants for reference.
SIDXDeviceExtraStringGet(integer SIDXdevice, integer setting, string value, integer status)
Obtain the value of a device-specific setting.
SIDXDeviceExtraListGetValue(integer SIDXdevice, integer setting, double value, integer status)
Obtain the value of a device-specific setting.
SIDXDeviceDriverGetType(integer SIDXdevice, integer type, integer status)
Obtain the device vendor and device driver.
SIDXDeviceGetDescription(integer SIDXdevice, string description, integer status)
Obtain a description of the device.
SIDXDeviceExtraGetValueLocal(integer SIDXdevice, integer setting, string description, integer status)
Obtain the current value of a device-specific setting as a text string.
SIDXDeviceExtraIntegerGet(integer SIDXdevice, integer setting, integer value, integer status)
Obtain the value of a device-specific setting.
SIDXDeviceExtraSequenceGet(integer SIDXdevice, integer setting, integer *value, integer length, integer return_length, integer status)
Obtain the value of a device-specific setting.
SIDXDeviceExtraSequenceGetSize(integer SIDXdevice, integer setting, integer size, integer status)
Obtain the array size for a device-specific setting.
SIDXDeviceGetLastError(integer SIDXdevice, string message)
The function translates the error code into a text string.
SIDXDeviceExtraGetUnit(integer SIDXdevice, integer setting, string unit, integer status)
Obtain the unit for the device-specific setting as a text string.
SIDXDevicePortAnalogGetRange(integer SIDXdevice, integer port, double minimum, double maximum, integer status)
Obtain the minimum and maximum analogue output voltage values.
SIDXDeviceDriverGetDescription(integer SIDXdevice, string description, integer status)
Obtain the driver description.
SIDXDeviceExtraListGetLocal(integer SIDXdevice, integer setting, integer index, string description, integer status)
Obtain a description of a specific entry for a device-specific setting.
SIDXDeviceExtraBooleanSet(integer SIDXdevice, integer setting, integer value, integer status)
Set the device-specific setting to the specified boolean value.
SIDXDeviceActionGetByName(integer SIDXdevice, string name, integer setting, integer status)
Obtain a handle for a device-specific action, based on the name of the action.
SIDXDeviceExtraGetByName(integer SIDXdevice, string name, integer setting, integer status)
Obtain a handle for a device-specific setting, based on the name of the setting.
SIDXDeviceExtraGetLabel(integer SIDXdevice, integer setting, string label, integer status)
Obtain a label for the device-specific setting as a text string.
SIDXDeviceGetName(integer SIDXdevice, string name, integer status)
Obtain the name of the device.
SIDXDevicePortBitWrite(integer SIDXdevice, integer port, integer asserted, integer status)
Sets the digital output bit specified by the index parameter to the value specified by the asserted p...
SIDXDevicePortGetType(integer SIDXdevice, integer port, integer type, integer status)
Obtains the available port type for a given port index.
SIDXDeviceExtraIntegerGetRange(integer SIDXdevice, integer setting, integer minimum, integer maximum, integer status)
Obtain the minimum and maximum value for a device-specific setting.
SIDXDeviceActionDo(integer SIDXdevice, integer setting, string command, integer status)
Perform a device-specific action.
SIDXDeviceExtraSequenceSet(integer SIDXdevice, integer setting, integer *value, integer length, integer status)
Set the device-specific setting to the specified array of integer value.
SIDXDevicePortBitRead(integer SIDXdevice, integer port, integer asserted, integer status)
Gets the status of the digital input bit specified by the index parameter, as retrieved by the most r...
SIDXDeviceActionGetByItem(integer SIDXdevice, integer index, integer setting, integer status)
Obtain a handle for a device-specific action, based on the index of the action.
SIDXDevicePortAnalogRead(integer SIDXdevice, integer port, double voltage, integer status)
Obtains the voltage on the specified port.
SIDXDeviceExtraGetType(integer SIDXdevice, integer setting, integer type, integer status)
Obtain the type of a device-specific setting.
SIDXDeviceActionGetName(integer SIDXdevice, integer index, string name, integer status)
Obtain the name of a device-specific action, based on the index of the action.
SIDXDeviceExtraIsSettable(integer SIDXdevice, integer setting, integer settable, integer status)
Determine is the camera specific setting can be set, based on the returned setting handle...
SIDXDeviceExtraRealGetValue(integer SIDXdevice, integer setting, double value, integer status)
Obtain the value used by the device for a device-specific setting.
SIDXDevicePortGetCount(integer SIDXdevice, integer count, integer status)
Obtains the I/O port count.
SIDXDeviceExtraRealGet(integer SIDXdevice, integer setting, double value, integer status)
Obtain the value of a device-specific setting.
SIDXDeviceActionGetCount(integer SIDXdevice, integer count, integer status)
Obtain the total count of device-specific actions.
SIDXDeviceExtraListSet(integer SIDXdevice, integer setting, integer index, integer status)
Set the device-specific setting to the specified list index.
SIDXDeviceExtraListGetCount(integer SIDXdevice, integer setting, integer count, integer status)
Obtain the count of available values for a given device-specific setting.
SIDXDeviceExtraGetByItem(integer SIDXdevice, integer item, integer setting, integer status)
Obtain a handle for a device-specific setting, based on the item of the setting.
SIDXDeviceExtraGetName(integer SIDXdevice, integer item, string name, integer status)
Obtain the name of a device-specific setting, based on the item of the setting.
SIDXDeviceExtraRealGetRange(integer SIDXdevice, integer setting, double minimum, double maximum, integer status)
Obtain the minimum and maximum value for a device-specific setting.
SIDXDeviceExtraListGet(integer SIDXdevice, integer setting, integer index, integer status)
Obtain the current index value of the device-specific setting.
SIDXDeviceGetLabel(integer SIDXdevice, string label, integer status)
Obtain a human readable label representing the device.
SIDXDevicePortDigitalRead(integer SIDXdevice, integer port, integer value, integer status)
Gets the digital input value.
SIDXDeviceExtraRealSet(integer SIDXdevice, integer setting, double value, integer status)
Set the device-specific setting to the specified real value.
SIDXDeviceExtraIntegerGetValue(integer SIDXdevice, integer setting, integer value, integer status)
Obtain the value used by the camera for a device-specific setting.
SIDXDeviceExtraBooleanGet(integer SIDXdevice, integer setting, integer value, integer status)
Obtain the value of a device-specific setting.
SIDXDeviceDriverGetName(integer SIDXdevice, string name, integer status)
Obtain the driver name.