X2 Standard  Version 1.24
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 {
27 public:
28  virtual ~FilterWheelDriverInterface(){}
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
FilterWheelDriverInterface::deviceInfoNameLong
virtual void deviceInfoNameLong(BasicStringInterface &str) const =0
FilterWheelDriverInterface::terminateLink
virtual int terminateLink(void)=0
FilterWheelDriverInterface::defaultFilterName
virtual int defaultFilterName(const int &nIndex, BasicStringInterface &strFilterNameOut)=0
FilterWheelDriverInterface::queryAbstraction
virtual int queryAbstraction(const char *pszName, void **ppVal)=0
FilterWheelDriverInterface::deviceInfoModel
virtual void deviceInfoModel(BasicStringInterface &str)=0
DriverRootInterface
The DriverRootInterface is the foundation for all X2 device drivers.
Definition: driverrootinterface.h:21
FilterWheelDriverInterface::driverInfoDetailedInfo
virtual void driverInfoDetailedInfo(BasicStringInterface &str) const =0
FilterWheelDriverInterface::deviceInfoDetailedDescription
virtual void deviceInfoDetailedDescription(BasicStringInterface &str) const =0
FilterWheelDriverInterface::abortFilterWheelMoveTo
virtual int abortFilterWheelMoveTo(void)=0
FilterWheelDriverInterface::driverInfoVersion
virtual double driverInfoVersion(void) const =0
FilterWheelDriverInterface::startFilterWheelMoveTo
virtual int startFilterWheelMoveTo(const int &nTargetPosition)=0
FilterWheelDriverInterface::isLinked
virtual bool isLinked(void) const =0
DriverInfoInterface
The DriverInfoInterface provides X2 implementors a standarized way to provide driver specific informa...
Definition: driverinfointerface.h:15
FilterWheelDriverInterface::endFilterWheelMoveTo
virtual int endFilterWheelMoveTo(void)=0
FilterWheelDriverInterface
The FilterWheelDriverInterface allows an X2 implementor to a write X2 filter wheel driver.
Definition: filterwheeldriverinterface.h:26
HardwareInfoInterface
The HardwareInfoInterface provides X2 implementors a standarized way to provide hardware specific inf...
Definition: deviceinfointerface.h:15
DriverRootInterface::DeviceType
DeviceType
Definition: driverrootinterface.h:26
DriverRootInterface::DT_FILTERWHEEL
@ DT_FILTERWHEEL
Definition: driverrootinterface.h:31
FilterWheelDriverInterface::deviceInfoNameShort
virtual void deviceInfoNameShort(BasicStringInterface &str) const =0
FilterWheelDriverInterface::deviceInfoFirmwareVersion
virtual void deviceInfoFirmwareVersion(BasicStringInterface &str)=0
FilterWheelMoveToInterface
The FilterWheelMoveToInterface allows moving to a specific filter.
Definition: filterwheelmovetointerface.h:19
FilterWheelDriverInterface::filterCount
virtual int filterCount(int &nCount)=0
BasicStringInterface
The BasicStringInterface allows a string as an output.
Definition: basicstringinterface.h:17
FilterWheelDriverInterface::establishLink
virtual int establishLink(void)=0
FilterWheelDriverInterface::deviceType
virtual DeviceType deviceType(void)
Definition: filterwheeldriverinterface.h:33
FilterWheelDriverInterface::isCompleteFilterWheelMoveTo
virtual int isCompleteFilterWheelMoveTo(bool &bComplete) const =0
X2 Examples
(C) Software Bisque, Inc. All rights reserved.