ISD::GenericDevice

Search for usage in LXR

Properties | Signals | Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
ISD::GenericDevice Class Reference

#include <indistd.h>

Inheritance diagram for ISD::GenericDevice:
Inheritance graph
[legend]

Properties

bool connected
 
uint32_t driverInterface
 
QString driverVersion
 
QString name
 
- Properties inherited from QObject
 objectName
 

Signals

void Connected ()
 
void Disconnected ()
 
void interfaceDefined ()
 
void messageUpdated (int messageID)
 
void newAdaptiveOptics (AdaptiveOptics *device)
 
void newAuxiliary (Auxiliary *device)
 
void newCamera (Camera *device)
 
void newCorrelator (Correlator *device)
 
void newDetector (Detector *device)
 
void newDome (Dome *device)
 
void newDustCap (DustCap *device)
 
void newFilterWheel (FilterWheel *device)
 
void newFocuser (Focuser *device)
 
void newGPS (GPS *device)
 
void newGuider (Guider *device)
 
void newLightBox (LightBox *device)
 
void newMount (Mount *device)
 
void newRotator (Rotator *device)
 
void newSpectrograph (Spectrograph *device)
 
void newWeather (Weather *device)
 
void propertyDefined (INDI::Property prop)
 
void propertyDeleted (INDI::Property prop)
 
void propertyUpdated (INDI::Property prop)
 
void ready ()
 
void systemPortDetected ()
 

Public Member Functions

 GenericDevice (DeviceInfo &idv, ClientManager *cm, QObject *parent=nullptr)
 
Q_SCRIPTABLE Q_NOREPLY void Connect ()
 
Q_SCRIPTABLE Q_NOREPLY void Disconnect ()
 
bool findConcreteDevice (uint32_t interface, QSharedPointer< ConcreteDevice > &device)
 
ISD::AdaptiveOptics * getAdaptiveOptics ()
 
ISD::Auxiliary * getAuxiliary ()
 
virtual INDI::BaseDevice getBaseDevice () const
 
ISD::Camera * getCamera ()
 
ClientManager * getClientManager () const
 
ISD::Correlator * getCorrelator ()
 
ISD::Detector * getDetector ()
 
virtual DeviceInfo * getDeviceInfo () const
 
virtual const QString & getDeviceName () const
 
ISD::Dome * getDome ()
 
virtual const QSharedPointer< DriverInfo > & getDriverInfo () const
 
virtual uint32_t getDriverInterface ()
 
virtual QString getDriverVersion ()
 
ISD::DustCap * getDustCap ()
 
ISD::FilterWheel * getFilterWheel ()
 
ISD::Focuser * getFocuser ()
 
ISD::GPS * getGPS ()
 
ISD::Guider * getGuider ()
 
virtual bool getJSONBLOB (const QString &propName, const QString &elementName, QJsonObject &blobObject)
 
virtual bool getJSONProperty (const QString &propName, QJsonObject &propObject, bool compact)
 
ISD::LightBox * getLightBox ()
 
virtual bool getMinMaxStep (const QString &propName, const QString &elementName, double *min, double *max, double *step)
 
ISD::Mount * getMount ()
 
virtual IPerm getPermission (const QString &propName)
 
virtual Properties getProperties ()
 
virtual INDI::Property getProperty (const QString &propName)
 
ISD::Rotator * getRotator ()
 
ISD::Spectrograph * getSpectrograph ()
 
virtual IPState getState (const QString &propName)
 
ISD::Weather * getWeather ()
 
virtual bool isConnected () const
 
virtual bool isReady () const
 
virtual bool processBLOB (INDI::Property prop) override
 
virtual void processLight (INDI::Property prop) override
 
virtual void processMessage (int messageID) override
 
virtual void processNumber (INDI::Property prop) override
 
virtual void processSwitch (INDI::Property prop) override
 
virtual void processText (INDI::Property prop) override
 
virtual void registerProperty (INDI::Property prop) override
 
virtual void removeProperty (INDI::Property prop) override
 
void sendNewNumber (INDI::Property prop)
 
void sendNewProperty (INDI::Property prop)
 
void sendNewSwitch (INDI::Property prop)
 
void sendNewText (INDI::Property prop)
 
virtual bool setConfig (INDIConfig tConfig)
 
virtual bool setJSONProperty (const QString &propName, const QJsonArray &propElements)
 
bool setProperty (QObject *)
 
virtual void updateProperty (INDI::Property prop) override
 
- Public Member Functions inherited from ISD::GDInterface
 GDInterface (QObject *parent)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
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 ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
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 QRegExp &regExp, 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
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
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_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 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 qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
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 setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThread * thread () const const
 

Protected Slots

virtual void resetWatchdog ()
 

Protected Member Functions

void checkLocationUpdate ()
 
void checkTimeUpdate ()
 
void createDeviceInit ()
 
bool generateDevices ()
 
void handleTimeout ()
 
void updateLocation ()
 
void updateTime ()
 
- 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)
 

Protected Attributes

QMap< uint32_t, QSharedPointer< ConcreteDevice > > m_ConcreteDevices
 
uint32_t m_DriverInterface { 0 }
 
QString m_DriverVersion
 

Additional Inherited Members

- 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)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 

Detailed Description

GenericDevice is the Generic Device for INDI devices. When a new INDI device is created in INDIListener, it gets created as a GenericDevice initially. If the device registers a standard property that is a key property to a device type family (e.g. Number property EQUATORIAL_EOD_COORD signifies a Telescope device), then the specialized version of the device is extended via the Decorator Pattern.

GenericDevice handles common functions shared across many devices such as time and location handling, configuration processing, retrieving information about properties, driver info..etc.

Author
Jasem Mutlaq

Definition at line 116 of file indistd.h.

Member Function Documentation

◆ generateDevices()

bool ISD::GenericDevice::generateDevices ( )
protected

generateDevices Generate concrete devices based on DRIVER_INTERFACE

Returns
True if at least one device is generated, false otherwise.

Definition at line 1153 of file indistd.cpp.

◆ processBLOB()

bool ISD::GenericDevice::processBLOB ( INDI::Property  prop)
overridevirtual

processBLOB Process Binary BLOB

Parameters
bppointer to binary blob.
Returns
Return true of BLOB was successfully processed. If a concrete device does not process the blob, it should return false to allow sibling or parent devices to process the blob.

Implements ISD::GDInterface.

Definition at line 534 of file indistd.cpp.

◆ sendNewNumber()

void ISD::GenericDevice::sendNewNumber ( INDI::Property  prop)

Send new Number command to server.

◆ sendNewSwitch()

void ISD::GenericDevice::sendNewSwitch ( INDI::Property  prop)

Send new Switch command to server.

◆ sendNewText()

void ISD::GenericDevice::sendNewText ( INDI::Property  prop)

Send new Text command to server.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Tue Sep 26 2023 03:55:56 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.