DriverInfo

Search for usage in LXR

Properties | Signals | Public Member Functions | List of all members
DriverInfo Class Reference

#include <driverinfo.h>

Inheritance diagram for DriverInfo:
Inheritance graph
[legend]

Properties

QString manufacturer
 
- Properties inherited from QObject
 objectName
 

Signals

void deviceStateChanged ()
 

Public Member Functions

 DriverInfo (const QString &inName)
 
 DriverInfo (DriverInfo *driver)
 
void addAuxInfo (const QString &key, const QVariant &value)
 
void addDevice (DeviceInfo *idv)
 
QSharedPointer< DriverInfo > clone (bool resetClone=true)
 
QVariantMap getAuxInfo () const
 
ClientManager * getClientManager () const
 
bool getClientState () const
 
DeviceInfo * getDevice (const QString &deviceName) const
 
QList< DeviceInfo * > getDevices () const
 
DriverSource getDriverSource () const
 
const QString & getExecutable () const
 
const QString & getHost () const
 
const QString & getLabel () const
 
const QString & getName () const
 
int getPort () const
 
const QString & getRemoteHost () const
 
const QString & getRemotePort () const
 
QString getServerBuffer () const
 
ServerManager * getServerManager () const
 
bool getServerState () const
 
const QString & getSkeletonFile () const
 
DeviceFamily getType () const
 
const QString & getUniqueLabel () const
 
int getUserPort () const
 
const QString & getVersion () const
 
bool isEmpty () const
 
QString manufacturer () const
 
void removeDevice (DeviceInfo *idv)
 
void reset ()
 
void resetDevices ()
 
void setAuxInfo (const QVariantMap &value)
 
void setClientManager (ClientManager *newClientManager)
 
void setClientState (bool inState)
 
void setDriverSource (DriverSource newDriverSource)
 
void setExecutable (const QString &newDriver)
 
void setHost (const QString &inHost)
 
void setHostParameters (const QString &inHost, int inPort)
 
void setLabel (const QString &inlabel)
 
void setManufacturer (const QString &Manufacturer)
 
void setName (const QString &newName)
 
void setPort (int inPort)
 
void setRemoteHost (const QString &inHost)
 
void setRemotePort (const QString &inPort)
 
void setServerManager (ServerManager *newServerManager)
 
void setServerState (bool inState)
 
void setSkeletonFile (const QString &inSkeleton)
 
void setStartupRule (const QJsonObject &value)
 
void setType (DeviceFamily newType)
 
void setUniqueLabel (const QString &inUniqueLabel)
 
void setUserPort (int inUserPort)
 
void setVersion (const QString &newVersion)
 
QJsonObject startupRule () const
 
QJsonObject toJson () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
QBindable< QString > bindableObjectName ()
 
bool blockSignals (bool block)
 
const QObjectList & children () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo () const const
 
void dumpObjectTree () const const
 
QList< QByteArray > dynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isQuickItemType () const const
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObject * parent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_GADGET_EXPORT (EXPORT_MACRO)
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_MOC_INCLUDE Q_MOC_INCLUDE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
T qobject_cast (const QObject *object)
 
T qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setObjectName (QAnyStringView name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool setProperty (const char *name, QVariant &&value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
 
QThread * thread () const const
 

Additional Inherited Members

- Public Types inherited from QObject
typedef  QObjectList
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObject * sender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

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:

  1. 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.
  2. 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.
  3. 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.
Author
Jasem Mutlaq

Definition at line 45 of file driverinfo.h.

Property Documentation

◆ manufacturer

QString DriverInfo::manufacturer
readwrite

Definition at line 47 of file driverinfo.h.

Constructor & Destructor Documentation

◆ DriverInfo() [1/2]

DriverInfo::DriverInfo ( const QString & inName)
explicit

Definition at line 16 of file driverinfo.cpp.

◆ DriverInfo() [2/2]

DriverInfo::DriverInfo ( DriverInfo * driver)
explicit

Definition at line 27 of file driverinfo.cpp.

◆ ~DriverInfo()

DriverInfo::~DriverInfo ( )
override

Definition at line 62 of file driverinfo.cpp.

Member Function Documentation

◆ addAuxInfo()

void DriverInfo::addAuxInfo ( const QString & key,
const QVariant & value )

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()

ClientManager * DriverInfo::getClientManager ( ) const
inline

Definition at line 162 of file driverinfo.h.

◆ getClientState()

bool DriverInfo::getClientState ( ) const
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()

QList< DeviceInfo * > DriverInfo::getDevices ( ) const
inline

Definition at line 242 of file driverinfo.h.

◆ getDriverSource()

DriverSource DriverInfo::getDriverSource ( ) const
inline

Definition at line 144 of file driverinfo.h.

◆ getExecutable()

const QString & DriverInfo::getExecutable ( ) const
inline

Definition at line 99 of file driverinfo.h.

◆ getHost()

const QString & DriverInfo::getHost ( ) const
inline

Definition at line 210 of file driverinfo.h.

◆ getLabel()

const QString & DriverInfo::getLabel ( ) const
inline

Definition at line 111 of file driverinfo.h.

◆ getName()

const QString & DriverInfo::getName ( ) const
inline

Definition at line 85 of file driverinfo.h.

◆ getPort()

int DriverInfo::getPort ( ) const
inline

Definition at line 214 of file driverinfo.h.

◆ getRemoteHost()

const QString & DriverInfo::getRemoteHost ( ) const
inline

Definition at line 227 of file driverinfo.h.

◆ getRemotePort()

const QString & DriverInfo::getRemotePort ( ) const
inline

Definition at line 231 of file driverinfo.h.

◆ getServerBuffer()

QString DriverInfo::getServerBuffer ( ) const

Definition at line 75 of file driverinfo.cpp.

◆ getServerManager()

ServerManager * DriverInfo::getServerManager ( ) const
inline

Definition at line 153 of file driverinfo.h.

◆ getServerState()

bool DriverInfo::getServerState ( ) const
inline

Definition at line 186 of file driverinfo.h.

◆ getSkeletonFile()

const QString & DriverInfo::getSkeletonFile ( ) const
inline

Definition at line 180 of file driverinfo.h.

◆ getType()

DeviceFamily DriverInfo::getType ( ) const
inline

Definition at line 135 of file driverinfo.h.

◆ getUniqueLabel()

const QString & DriverInfo::getUniqueLabel ( ) const
inline

Definition at line 117 of file driverinfo.h.

◆ getUserPort()

int DriverInfo::getUserPort ( ) const
inline

Definition at line 171 of file driverinfo.h.

◆ getVersion()

const QString & DriverInfo::getVersion ( ) const
inline

Definition at line 126 of file driverinfo.h.

◆ isEmpty()

bool DriverInfo::isEmpty ( ) const
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()

void DriverInfo::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()

void DriverInfo::setClientManager ( ClientManager * newClientManager)
inline

Definition at line 158 of file driverinfo.h.

◆ setClientState()

void DriverInfo::setClientState ( bool inState)

Definition at line 96 of file driverinfo.cpp.

◆ setDriverSource()

void DriverInfo::setDriverSource ( DriverSource newDriverSource)
inline

Definition at line 140 of file driverinfo.h.

◆ setExecutable()

void DriverInfo::setExecutable ( const QString & newDriver)
inline

Definition at line 95 of file driverinfo.h.

◆ setHost()

void DriverInfo::setHost ( const QString & inHost)
inline

Definition at line 206 of file driverinfo.h.

◆ setHostParameters()

void DriverInfo::setHostParameters ( const QString & inHost,
int inPort )
inline

Definition at line 197 of file driverinfo.h.

◆ setLabel()

void DriverInfo::setLabel ( const QString & inlabel)
inline

Definition at line 107 of file driverinfo.h.

◆ setManufacturer()

void DriverInfo::setManufacturer ( const QString & Manufacturer)

Definition at line 150 of file driverinfo.cpp.

◆ setName()

void DriverInfo::setName ( const QString & newName)
inline

Definition at line 89 of file driverinfo.h.

◆ setPort()

void DriverInfo::setPort ( int inPort)
inline

Definition at line 202 of file driverinfo.h.

◆ setRemoteHost()

void DriverInfo::setRemoteHost ( const QString & inHost)
inline

Definition at line 223 of file driverinfo.h.

◆ setRemotePort()

void DriverInfo::setRemotePort ( const QString & inPort)
inline

Definition at line 219 of file driverinfo.h.

◆ setServerManager()

void DriverInfo::setServerManager ( ServerManager * newServerManager)
inline

Definition at line 149 of file driverinfo.h.

◆ setServerState()

void DriverInfo::setServerState ( bool inState)

Definition at line 83 of file driverinfo.cpp.

◆ setSkeletonFile()

void DriverInfo::setSkeletonFile ( const QString & inSkeleton)
inline

Definition at line 176 of file driverinfo.h.

◆ setStartupRule()

void DriverInfo::setStartupRule ( const QJsonObject & value)

Definition at line 169 of file driverinfo.cpp.

◆ setType()

void DriverInfo::setType ( DeviceFamily newType)
inline

Definition at line 131 of file driverinfo.h.

◆ setUniqueLabel()

void DriverInfo::setUniqueLabel ( const QString & inUniqueLabel)

Definition at line 155 of file driverinfo.cpp.

◆ setUserPort()

void DriverInfo::setUserPort ( int inUserPort)
inline

Definition at line 167 of file driverinfo.h.

◆ setVersion()

void DriverInfo::setVersion ( const QString & newVersion)
inline

Definition at line 122 of file driverinfo.h.

◆ startupRule()

QJsonObject DriverInfo::startupRule ( ) const

Definition at line 164 of file driverinfo.cpp.

◆ toJson()

QJsonObject DriverInfo::toJson ( ) const
inline

Definition at line 57 of file driverinfo.h.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Nov 29 2024 11:57:49 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.