X2 Standard  Version 1.28
Loading...
Searching...
No Matches
filterwheeldriverinterface.h
1#ifndef _FilterWheelDriverInterface_H
2#define _FilterWheelDriverInterface_H
3
4#ifdef THESKYX_FOLDER_TREE
5#include "imagingsystem/hardware/interfaces/licensed/driverrootinterface.h"
6#include "imagingsystem/hardware/interfaces/licensed/linkinterface.h"
7#include "imagingsystem/hardware/interfaces/licensed/deviceinfointerface.h"
8#include "imagingsystem/hardware/interfaces/licensed/driverinfointerface.h"
9#include "imagingsystem/hardware/interfaces/licensed/filterwheelmovetointerface.h"
10#else
11#include "../../licensedinterfaces/driverrootinterface.h"
12#include "../../licensedinterfaces/linkinterface.h"
13#include "../../licensedinterfaces/deviceinfointerface.h"
14#include "../../licensedinterfaces/driverinfointerface.h"
15#include "../../licensedinterfaces/filterwheelmovetointerface.h"
16#endif
17
26{
27public:
29
34 virtual int queryAbstraction(const char* pszName, void** ppVal) = 0;
36
40 virtual void driverInfoDetailedInfo(BasicStringInterface& str) const = 0;
41 virtual double driverInfoVersion(void) const = 0;
43
47 virtual void deviceInfoNameShort(BasicStringInterface& str) const = 0;
48 virtual void deviceInfoNameLong(BasicStringInterface& str) const = 0;
51 virtual void deviceInfoModel(BasicStringInterface& str) = 0;
53
57 virtual int establishLink(void) = 0;
58 virtual int terminateLink(void) = 0;
59 virtual bool isLinked(void) const = 0;
61
65 virtual int filterCount(int& nCount) = 0;
66 virtual int defaultFilterName(const int& nIndex, BasicStringInterface& strFilterNameOut) = 0;
67 virtual int startFilterWheelMoveTo(const int& nTargetPosition) = 0;
68 virtual int isCompleteFilterWheelMoveTo(bool& bComplete) const = 0;
69 virtual int endFilterWheelMoveTo(void) = 0;
70 virtual int abortFilterWheelMoveTo(void) = 0;
72
73};
74
75#endif
The BasicStringInterface allows a string as an output.
Definition basicstringinterface.h:17
The DriverInfoInterface provides X2 implementors a standardized way to provide driver specific inform...
Definition driverinfointerface.h:15
The DriverRootInterface is the foundation for all X2 device drivers.
Definition driverrootinterface.h:21
DeviceType
Definition driverrootinterface.h:26
@ DT_FILTERWHEEL
Definition driverrootinterface.h:31
The FilterWheelDriverInterface allows an X2 implementor to a write X2 filter wheel driver.
Definition filterwheeldriverinterface.h:26
virtual int establishLink(void)=0
virtual void deviceInfoNameLong(BasicStringInterface &str) const =0
virtual void deviceInfoModel(BasicStringInterface &str)=0
virtual int filterCount(int &nCount)=0
virtual DeviceType deviceType(void)
Definition filterwheeldriverinterface.h:33
virtual double driverInfoVersion(void) const =0
virtual int abortFilterWheelMoveTo(void)=0
virtual int endFilterWheelMoveTo(void)=0
virtual void deviceInfoNameShort(BasicStringInterface &str) const =0
virtual int defaultFilterName(const int &nIndex, BasicStringInterface &strFilterNameOut)=0
virtual void deviceInfoFirmwareVersion(BasicStringInterface &str)=0
virtual int queryAbstraction(const char *pszName, void **ppVal)=0
virtual void driverInfoDetailedInfo(BasicStringInterface &str) const =0
virtual int startFilterWheelMoveTo(const int &nTargetPosition)=0
virtual void deviceInfoDetailedDescription(BasicStringInterface &str) const =0
virtual bool isLinked(void) const =0
virtual int terminateLink(void)=0
virtual int isCompleteFilterWheelMoveTo(bool &bComplete) const =0
The FilterWheelMoveToInterface allows moving to a specific filter.
Definition filterwheelmovetointerface.h:19
The HardwareInfoInterface provides X2 implementors a standardized way to provide hardware specific in...
Definition deviceinfointerface.h:15
X2 Examples
(C) 2026 Software Bisque, Inc. All rights reserved.