X2 Standard  Version 1.24
rotatordriverinterface.h
1 #ifndef _RotatorDriverInterface_H
2 #define _RotatorDriverInterface_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 #else
10 #include "../../licensedinterfaces/driverrootinterface.h"
11 #include "../../licensedinterfaces/linkinterface.h"
12 #include "../../licensedinterfaces/deviceinfointerface.h"
13 #include "../../licensedinterfaces/driverinfointerface.h"
14 #endif
15 
17 
26 {
27 public:
28  virtual ~RotatorDriverInterface(){}
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 
44  //
48  virtual void deviceInfoNameShort(BasicStringInterface& str) const = 0;
49  virtual void deviceInfoNameLong(BasicStringInterface& str) const = 0;
52  virtual void deviceInfoModel(BasicStringInterface& str) = 0;
54 
58  virtual int establishLink(void) = 0;
59  virtual int terminateLink(void) = 0;
60  virtual bool isLinked(void) const = 0;
61  virtual bool isEstablishLinkAbortable(void) const {return false;}
63 
65  virtual int position(double& dPosition) = 0;
67  virtual int abort(void) = 0;
68 
70  virtual int startRotatorGoto(const double& dTargetPosition) = 0;
72  virtual int isCompleteRotatorGoto(bool& bComplete) const = 0;
74  virtual int endRotatorGoto(void) = 0;
75 
76 
77 };
78 
79 
80 #endif
RotatorDriverInterface::deviceInfoNameShort
virtual void deviceInfoNameShort(BasicStringInterface &str) const =0
RotatorDriverInterface::establishLink
virtual int establishLink(void)=0
RotatorDriverInterface
The RotatorDriverInterface allows an X2 implementor to a write X2 rotator driver.
Definition: rotatordriverinterface.h:26
DriverRootInterface
The DriverRootInterface is the foundation for all X2 device drivers.
Definition: driverrootinterface.h:21
RotatorDriverInterface::deviceInfoDetailedDescription
virtual void deviceInfoDetailedDescription(BasicStringInterface &str) const =0
RotatorDriverInterface::deviceInfoNameLong
virtual void deviceInfoNameLong(BasicStringInterface &str) const =0
RotatorDriverInterface::driverInfoDetailedInfo
virtual void driverInfoDetailedInfo(BasicStringInterface &str) const =0
RotatorDriverInterface::position
virtual int position(double &dPosition)=0
RotatorDriverInterface::startRotatorGoto
virtual int startRotatorGoto(const double &dTargetPosition)=0
RotatorDriverInterface::queryAbstraction
virtual int queryAbstraction(const char *pszName, void **ppVal)=0
RotatorDriverInterface::deviceInfoModel
virtual void deviceInfoModel(BasicStringInterface &str)=0
RotatorDriverInterface::isCompleteRotatorGoto
virtual int isCompleteRotatorGoto(bool &bComplete) const =0
RotatorDriverInterface::abort
virtual int abort(void)=0
RotatorDriverInterface::deviceType
virtual DeviceType deviceType(void)
Definition: rotatordriverinterface.h:33
RotatorDriverInterface::endRotatorGoto
virtual int endRotatorGoto(void)=0
DriverInfoInterface
The DriverInfoInterface provides X2 implementors a standarized way to provide driver specific informa...
Definition: driverinfointerface.h:15
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_ROTATOR
@ DT_ROTATOR
Definition: driverrootinterface.h:33
RotatorDriverInterface::driverInfoVersion
virtual double driverInfoVersion(void) const =0
RotatorDriverInterface::isLinked
virtual bool isLinked(void) const =0
RotatorDriverInterface::deviceInfoFirmwareVersion
virtual void deviceInfoFirmwareVersion(BasicStringInterface &str)=0
BasicStringInterface
The BasicStringInterface allows a string as an output.
Definition: basicstringinterface.h:17
RotatorDriverInterface::terminateLink
virtual int terminateLink(void)=0
X2 Examples
(C) Software Bisque, Inc. All rights reserved.