The DriverRootInterface is the foundation for all X2 device drivers. More...

#include <driverrootinterface.h>

Inheritance diagram for DriverRootInterface:

Public Types
enum	DeviceType { DT_UNKNOWN = 0 , DT_MOUNT = 1 , DT_FOCUSER = 2 , DT_CAMERA = 3 , DT_FILTERWHEEL = 4 , DT_DOME = 5 , DT_ROTATOR = 6 , DT_WEATHER = 7 , DT_GPSTFP = 8 , DT_VIDEO = 9 , DT_OTA =10 , DT_AO =11 , DT_POWERCONTROL =12 , DT_PRIVATE_A =13 }

Public Member Functions
virtual DeviceType	deviceType (void)=0
virtual int	queryAbstraction (const char pszName, void *ppVal)=0

Detailed Description

The DriverRootInterface is the foundation for all X2 device drivers.

Each specific DeviceType implementation inherits this interface and adds methods/properties common to all devices in kind, if any. TheSkyX leverages queryAbstraction() as a runtime means of obtaining, optional well-defined interfaces. Tested and works on Windows, Mac, Ubuntu Linux.

Member Enumeration Documentation

◆ DeviceType

enum DriverRootInterface::DeviceType

DeviceType.

Enumerator
DT_UNKNOWN	Unknown device type.
DT_MOUNT	Mount.
DT_FOCUSER	Focuser.
DT_CAMERA	Camera.
DT_FILTERWHEEL	Filter wheel.
DT_DOME	Dome.
DT_ROTATOR	Rotator.
DT_WEATHER	Weather station.
DT_GPSTFP	Accurate timing.
DT_VIDEO	Video camera.
DT_OTA	Optical tube assembly.
DT_AO	Adaptive optics.
DT_POWERCONTROL	Power control.
DT_PRIVATE_A	Private A.

Member Function Documentation

◆ deviceType()

virtual DeviceType DriverRootInterface::deviceType ( void )

pure virtual

Returns the type of device.

Implemented in CameraDriverInterface, DomeDriverInterface, FilterWheelDriverInterface, FocuserDriverInterface, MountDriverInterface, PowerControlDriverInterface, RotatorDriverInterface, X2Dome, X2FilterWheel, X2Mount, and X2Rotator.

◆ queryAbstraction()

virtual int DriverRootInterface::queryAbstraction	(	const char *	pszName,
		void **	ppVal )

pure virtual

Return a pointer to well defined interface.

Implemented in CameraDriverInterface, DomeDriverInterface, FilterWheelDriverInterface, FocuserDriverInterface, MountDriverInterface, PowerControlDriverInterface, RotatorDriverInterface, X2Camera, X2Dome, X2FilterWheel, X2Focuser, X2Mount, X2PowerControl, and X2Rotator.

The documentation for this class was generated from the following file:

licensedinterfaces/driverrootinterface.h