ApogeeFilterWheel Class Reference
class for apogee's usb filter wheel
More...
#include <ApogeeFilterWheel.h>
List of all members.
Detailed Description
class for apogee's usb filter wheel
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
Copyright(c) 2011 Apogee Imaging Systems, Inc.
Member Enumeration Documentation
Current filter wheel state
- Enumerator:
UNKNOWN_STATUS |
Error status
|
NOT_CONNECTED |
Filter wheel is not connected either physically or the ApogeeFilterWheel::Init function has not been called
|
READY |
Filter wheel is at the desired position
|
ACTIVE |
Filter wheel is moving to desired postion
|
- Enumerator:
UNKNOWN_TYPE |
|
FW50_9R |
|
FW50_7S |
|
AFW50_10S |
|
Member Function Documentation
void ApogeeFilterWheel::Close |
( |
|
) |
|
Closes the USB connection to the filter wheel
- Exceptions:
-
uint16_t ApogeeFilterWheel::GetDeviceId |
( |
|
) |
|
Returns USB device id
- Exceptions:
-
uint16_t ApogeeFilterWheel::GetMaxPositions |
( |
|
) |
|
Returns The maximum number of filter wheel position
- Exceptions:
-
std::string ApogeeFilterWheel::GetName |
( |
|
) |
|
Returns Current filter wheel name
- Exceptions:
-
uint16_t ApogeeFilterWheel::GetPosition |
( |
|
) |
|
Returns the current filter wheel position
- Exceptions:
-
uint16_t ApogeeFilterWheel::GetProductId |
( |
|
) |
|
Returns USB product id
- Exceptions:
-
Returns the current status of the filter wheel
- Exceptions:
-
Returns Current filter wheel type
std::string ApogeeFilterWheel::GetUsbFirmwareRev |
( |
|
) |
|
Returns USB firmware version
- Exceptions:
-
uint16_t ApogeeFilterWheel::GetVendorId |
( |
|
) |
|
Returns USB vendor id
- Exceptions:
-
Initizes the USB connection from the PC to the filter wheel. The results strings from the FindDeviceUsb::Find() provide the input into this function.
- Parameters:
-
[in] | User | supplied ApogeeFilterWheel::Type |
[in] | DeviceAddr | specifies the address of the filter wheel on the USB buss |
- Exceptions:
-
void ApogeeFilterWheel::SetPosition |
( |
uint16_t |
Position |
) |
|
Sets filter wheel positon
- Parameters:
-
- Exceptions:
-
The documentation for this class was generated from the following file: