|
DexelaDetector API
|
This class is used to scan the different interfaces and give information about devices found. More...
#include <BusScanner.h>
Public Member Functions | |
| BusScanner (void) | |
| Constructor for BusScanner. More... | |
| ~BusScanner (void) | |
| Destructor for BusScanner. More... | |
| int | EnumerateDevices () |
| This method will enumerate all devices (regardless of interface) currently connected to the system. More... | |
| int | EnumerateGEDevices () |
| This method will enumerate all GigE devices currently connected to the system. More... | |
| int | EnumerateCLDevices () |
| This method will enumerate all CameraLink devices currently connected to the system. More... | |
| DevInfo | GetDevice (int index) |
| This method will return a DevInfo object for the device at the specified index. This object contains all necessary information for establishing a connection with the detector (DexelaDetector(DevInfo &defInfo)). Note: To determine how many devices are currently connected to the system you can call EnumerateDevices Note2: This method will call EnumerateDevices automatically if it has not previously been called More... | |
| DevInfo | GetDeviceGE (int index) |
| This method will return a DevInfo object for the GigE device at the specified index. This object contains all necessary information for establishing a connection with the detector (DexelaDetector(DevInfo &defInfo)). Note: To determine how many GigE devices are currently connected to the system you can call EnumerateGEDevices Note2: This method will call EnumerateGEDevices automatically if it has not previously been called More... | |
| DevInfo | GetDeviceCL (int index) |
| This method will return a DevInfo object for the CameraLink device at the specified index. This object contains all necessary information for establishing a connection with the detector (DexelaDetector(DevInfo &defInfo)). Note: To determine how many CL devices are currently connected to the system you can call EnumerateCLDevices Note2: This method will call EnumerateCLDevices automatically if it has not previously been called More... | |
Friends | |
| class | ScanMockSetter |
Detailed Description
This class is used to scan the different interfaces and give information about devices found.
Constructor & Destructor Documentation
| BusScanner::BusScanner | ( | void | ) |
Constructor for BusScanner.
| BusScanner::~BusScanner | ( | void | ) |
Destructor for BusScanner.
Member Function Documentation
| int BusScanner::EnumerateCLDevices | ( | ) |
This method will enumerate all CameraLink devices currently connected to the system.
- Returns
- The count of the number of CL devices found
- Exceptions
-
DexelaException
| int BusScanner::EnumerateDevices | ( | ) |
This method will enumerate all devices (regardless of interface) currently connected to the system.
- Returns
- The count of the number of devices found
- Exceptions
-
DexelaException
| int BusScanner::EnumerateGEDevices | ( | ) |
This method will enumerate all GigE devices currently connected to the system.
- Returns
- The count of the number of GigE devices found
- Exceptions
-
DexelaException
| DevInfo BusScanner::GetDevice | ( | int | index | ) |
This method will return a DevInfo object for the device at the specified index. This object contains all necessary information for establishing a connection with the detector (DexelaDetector(DevInfo &defInfo)).
Note: To determine how many devices are currently connected to the system you can call EnumerateDevices
Note2: This method will call EnumerateDevices automatically if it has not previously been called
- Parameters
-
index The index of the device to access. If this index is out of bounds an exception will be thrown.
- Returns
- The DevInfo object with the detector at the desired index
- Exceptions
-
DexelaException
| DevInfo BusScanner::GetDeviceCL | ( | int | index | ) |
This method will return a DevInfo object for the CameraLink device at the specified index. This object contains all necessary information for establishing a connection with the detector (DexelaDetector(DevInfo &defInfo)).
Note: To determine how many CL devices are currently connected to the system you can call EnumerateCLDevices
Note2: This method will call EnumerateCLDevices automatically if it has not previously been called
- Parameters
-
index The index of the device to access. If this index is out of bounds an exception will be thrown.
- Returns
- The DevInfo object with the detecotr at the desired index
- Exceptions
-
DexelaException
| DevInfo BusScanner::GetDeviceGE | ( | int | index | ) |
This method will return a DevInfo object for the GigE device at the specified index. This object contains all necessary information for establishing a connection with the detector (DexelaDetector(DevInfo &defInfo)).
Note: To determine how many GigE devices are currently connected to the system you can call EnumerateGEDevices
Note2: This method will call EnumerateGEDevices automatically if it has not previously been called
- Parameters
-
index The index of the device to access. If this index is out of bounds an exception will be thrown.
- Returns
- The DevInfo object with the detecotr at the desired index
- Exceptions
-
DexelaException
The documentation for this class was generated from the following files:
- BusScanner.h
- BusScanner.cpp
Generated on Tue Nov 25 2014 10:22:44 for DexelaDetector API by
1.8.7