DriverInfo
#include <driverinfo.h>
Properties | |
QString | manufacturer |
Properties inherited from QObject | |
objectName | |
Signals | |
void | deviceStateChanged () |
Detailed Description
DriverInfo holds all metadata associated with a particular INDI driver.
An INDI drivers holds both static and dynamic information. Example for static information:
- Device name.
- Device label.
- Driver version.
- Device Family: Telescope, CCD, Focuser...etc
Dynamic information include associated Server and Client managers, port in use, associated devices...etc. Most INDI drivers operate only one device, but some driver can present multiple devices simultaneously.
Driver information are obtained from multiple sources:
- INDI driver XML file: All INDI driver install an XML file (usually to /usr/share/indi) that contains information on the driver and device or devices it is capabale of running.
- Client DriverInfos: Users can add a new host/port combo in the Device Manager in order to connect to to local or remote INDI servers.
- Generated DriverInfos: DriverInfo can be created programatically to connect to local or remote INDI server with unknown number of actual drivers/devices at the server side.
Definition at line 45 of file driverinfo.h.
Property Documentation
◆ manufacturer
|
readwrite |
Definition at line 47 of file driverinfo.h.
Constructor & Destructor Documentation
◆ DriverInfo() [1/2]
Definition at line 16 of file driverinfo.cpp.
◆ DriverInfo() [2/2]
|
explicit |
Definition at line 27 of file driverinfo.cpp.
◆ ~DriverInfo()
|
override |
Definition at line 62 of file driverinfo.cpp.
Member Function Documentation
◆ addAuxInfo()
Definition at line 140 of file driverinfo.cpp.
◆ addDevice()
void DriverInfo::addDevice | ( | DeviceInfo * | idv | ) |
Definition at line 109 of file driverinfo.cpp.
◆ clone()
QSharedPointer< DriverInfo > DriverInfo::clone | ( | bool | resetClone = true | ) |
Definition at line 51 of file driverinfo.cpp.
◆ getAuxInfo()
QVariantMap DriverInfo::getAuxInfo | ( | ) | const |
Definition at line 130 of file driverinfo.cpp.
◆ getClientManager()
|
inline |
Definition at line 162 of file driverinfo.h.
◆ getClientState()
|
inline |
Definition at line 192 of file driverinfo.h.
◆ getDevice()
DeviceInfo * DriverInfo::getDevice | ( | const QString & | deviceName | ) | const |
Definition at line 120 of file driverinfo.cpp.
◆ getDevices()
|
inline |
Definition at line 242 of file driverinfo.h.
◆ getDriverSource()
|
inline |
Definition at line 144 of file driverinfo.h.
◆ getExecutable()
Definition at line 99 of file driverinfo.h.
◆ getHost()
Definition at line 210 of file driverinfo.h.
◆ getLabel()
Definition at line 111 of file driverinfo.h.
◆ getName()
Definition at line 85 of file driverinfo.h.
◆ getPort()
|
inline |
Definition at line 214 of file driverinfo.h.
◆ getRemoteHost()
Definition at line 227 of file driverinfo.h.
◆ getRemotePort()
Definition at line 231 of file driverinfo.h.
◆ getServerBuffer()
QString DriverInfo::getServerBuffer | ( | ) | const |
Definition at line 75 of file driverinfo.cpp.
◆ getServerManager()
|
inline |
Definition at line 153 of file driverinfo.h.
◆ getServerState()
|
inline |
Definition at line 186 of file driverinfo.h.
◆ getSkeletonFile()
Definition at line 180 of file driverinfo.h.
◆ getType()
|
inline |
Definition at line 135 of file driverinfo.h.
◆ getUniqueLabel()
Definition at line 117 of file driverinfo.h.
◆ getUserPort()
|
inline |
Definition at line 171 of file driverinfo.h.
◆ getVersion()
Definition at line 126 of file driverinfo.h.
◆ isEmpty()
|
inline |
Definition at line 78 of file driverinfo.h.
◆ manufacturer()
QString DriverInfo::manufacturer | ( | ) | const |
Definition at line 145 of file driverinfo.cpp.
◆ removeDevice()
void DriverInfo::removeDevice | ( | DeviceInfo * | idv | ) |
Definition at line 114 of file driverinfo.cpp.
◆ reset()
void DriverInfo::reset | ( | ) |
Definition at line 67 of file driverinfo.cpp.
◆ resetDevices()
|
inline |
Definition at line 72 of file driverinfo.h.
◆ setAuxInfo()
void DriverInfo::setAuxInfo | ( | const QVariantMap & | value | ) |
Definition at line 135 of file driverinfo.cpp.
◆ setClientManager()
|
inline |
Definition at line 158 of file driverinfo.h.
◆ setClientState()
void DriverInfo::setClientState | ( | bool | inState | ) |
Definition at line 96 of file driverinfo.cpp.
◆ setDriverSource()
|
inline |
Definition at line 140 of file driverinfo.h.
◆ setExecutable()
Definition at line 95 of file driverinfo.h.
◆ setHost()
Definition at line 206 of file driverinfo.h.
◆ setHostParameters()
Definition at line 197 of file driverinfo.h.
◆ setLabel()
Definition at line 107 of file driverinfo.h.
◆ setManufacturer()
Definition at line 150 of file driverinfo.cpp.
◆ setName()
Definition at line 89 of file driverinfo.h.
◆ setPort()
|
inline |
Definition at line 202 of file driverinfo.h.
◆ setRemoteHost()
Definition at line 223 of file driverinfo.h.
◆ setRemotePort()
Definition at line 219 of file driverinfo.h.
◆ setServerManager()
|
inline |
Definition at line 149 of file driverinfo.h.
◆ setServerState()
void DriverInfo::setServerState | ( | bool | inState | ) |
Definition at line 83 of file driverinfo.cpp.
◆ setSkeletonFile()
Definition at line 176 of file driverinfo.h.
◆ setStartupRule()
void DriverInfo::setStartupRule | ( | const QJsonObject & | value | ) |
Definition at line 169 of file driverinfo.cpp.
◆ setType()
|
inline |
Definition at line 131 of file driverinfo.h.
◆ setUniqueLabel()
Definition at line 155 of file driverinfo.cpp.
◆ setUserPort()
|
inline |
Definition at line 167 of file driverinfo.h.
◆ setVersion()
Definition at line 122 of file driverinfo.h.
◆ startupRule()
QJsonObject DriverInfo::startupRule | ( | ) | const |
Definition at line 164 of file driverinfo.cpp.
◆ toJson()
|
inline |
Definition at line 57 of file driverinfo.h.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:19:04 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.