LinkInterface Class Reference

The LinkInterface allows connect and related device operations. More...

#include <linkinterface.h>

Inheritance diagram for LinkInterface:

Public Member Functions
virtual int	establishLink (void)=0
virtual int	terminateLink (void)=0
virtual bool	isLinked (void) const =0
virtual bool	isEstablishLinkAbortable (void)

Detailed Description

The LinkInterface allows connect and related device operations.

The word Link is used to describe the connection state to a device simply because the word connect (and disconnet) are used frequently in source code for other things.

Member Function Documentation

establishLink()

virtual int LinkInterface::establishLink ( void )

pure virtual

Connect (link) to the device.

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

isEstablishLinkAbortable()

virtual bool LinkInterface::isEstablishLinkAbortable ( void )

inlinevirtual

Software Bisque implementations only. For those devices where the above establishLink can take more than say 2 seconds, it's nice to allow users the ability to abort the operation, especially if/when there is no actual device connected and establishLink has to time out.

isLinked()

virtual bool LinkInterface::isLinked ( void ) const

pure virtual

Return true if there is a connection, otherwise return false.

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

terminateLink()

virtual int LinkInterface::terminateLink ( void )

pure virtual

Disconnect from the device.

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

---

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

• licensedinterfaces/linkinterface.h