FW Interface Class. More...
#include <dlapi.h>
Public Types | |
enum | Model { UnknownFWModel = 0, CFW2, CFW5, CFW8, CFWL, CFW402, CFW6A, CFW10, CFW10_SERIAL, CFW9, CFWL8, CFWL8G, CFW1603, FW5_STX, FW5_8300, FW8_8300, FW7_STX, FW8_STT, FW5_STF_DETENT, Internal, AFW16, AFW15, AFW14, AFW13, AFW12, AFW11, AFW10, AFW9, AFW8, AFW7, AFW6, AFW5, AFW4, AFW3, AFW2, InvalidFWModel = 0xFF } |
enum | Status { FWIdle, FWBusy, FWError, InvalidFWStatus = 0xff } |
Public Member Functions | |
virtual IPromisePtr | initialize ()=0 |
Initialize the filter wheel, and obtain basic model information. More... | |
virtual IPromisePtr | queryStatus ()=0 |
Queries the status of the filter wheel. More... | |
virtual int | getPosition () const =0 |
Returns the buffered position of the filter wheel. More... | |
virtual IFW::Status | getStatus () const =0 |
Returns the buffered status of the filter wheel. More... | |
virtual IFW::Model | getModel () const =0 |
Returns the model number of the attached filter wheel. More... | |
virtual unsigned int | getSlots () const =0 |
returns the number of slots the filter wheel has available. More... | |
virtual IPromisePtr | setPosition (int position)=0 |
Send a goto command to the filter wheel. More... | |
Detailed Description
FW Interface Class.
An interface to Filter Wheel peripherals connected to DLAPI cameras.
Member Enumeration Documentation
◆ Model
enum dl::IFW::Model |
◆ Status
enum dl::IFW::Status |
Member Function Documentation
◆ getModel()
|
pure virtual |
Returns the model number of the attached filter wheel.
- Returns
- IFW::Model the model number of the filter wheel.
- See also
- IFW::Status, IFW::initialize()
Returns the buffered model of the filter wheel, refreshed by IFW::initialize().
◆ getPosition()
|
pure virtual |
Returns the buffered position of the filter wheel.
- Returns
- int buffered filter wheel position.
- See also
- IFW::queryStatus()
Returns the buffered position of the filter wheel, refreshed by IFW::queryStatus().
◆ getSlots()
|
pure virtual |
returns the number of slots the filter wheel has available.
- Returns
- unsigned int number of filter slots in the filter wheel.
Returns the number of slots available in the filter wheel.
◆ getStatus()
|
pure virtual |
Returns the buffered status of the filter wheel.
- Returns
- IFW::Status buffered filter wheel status.
- See also
- IFW::queryStatus()
Returns the buffered status of the filter wheel, refreshed by IFW::queryStatus(). Index is base-zero.
◆ initialize()
|
pure virtual |
Initialize the filter wheel, and obtain basic model information.
- Returns
- IPromisePtr pointer to promise for monitoring the status of the asynchronous operation.
- See also
- IPromisePtr
Initializes the Filter Wheel, and obtains the filter wheel model.
◆ queryStatus()
|
pure virtual |
Queries the status of the filter wheel.
- Returns
- IPromisePtr pointer to promise for monitoring the status of the asynchronous operation.
- See also
- IPromisePtr, IFW::getPosition(), IFW::getStatus()
Requests the status and position of the filter wheel from the camera, and updates the buffered values.
◆ setPosition()
|
pure virtual |
Send a goto command to the filter wheel.
- Parameters
-
position the desired slot to move to.
- Returns
- IPromisePtr pointer to promise for monitoring the status of the asynchronous operation.
- See also
- IPromisePtr
Sets the position of the filter wheel. Will return EStatusCode::InvalidParameter if position is below 0, or above the slot count of the filter wheel when the IPromise completes. Index is base-zero.
The documentation for this class was generated from the following file:
- C:/NightlyBuild/DL_Imaging/Aluma_Software/dlapi/src/dlapi.h