ISD::Dome

Search for usage in LXR

Public Types | Properties | Signals | Public Member Functions | Static Public Member Functions | List of all members
ISD::Dome Class Reference

#include <indidome.h>

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

Public Types

enum  DomeDirection { DOME_CW , DOME_CCW }
 
enum  DomeMotionCommand { MOTION_START , MOTION_STOP }
 
enum  ShutterStatus {
  SHUTTER_UNKNOWN , SHUTTER_OPEN , SHUTTER_CLOSED , SHUTTER_OPENING ,
  SHUTTER_CLOSING , SHUTTER_ERROR
}
 
enum  Status {
  DOME_IDLE , DOME_MOVING_CW , DOME_MOVING_CCW , DOME_TRACKING ,
  DOME_PARKING , DOME_UNPARKING , DOME_PARKED , DOME_ERROR
}
 

Properties

bool canAbort
 
bool canAbsoluteMove
 
bool canPark
 
bool canRelativeMove
 
bool isMoving
 
ISD::ParkStatus parkStatus
 
double position
 
ISD::Dome::ShutterStatus shutterStatus
 
ISD::Dome::Status status
 
- Properties inherited from ISD::ConcreteDevice
bool connected
 
QString name
 
- Properties inherited from QObject
 objectName
 

Signals

void newAutoSyncStatus (bool enabled)
 
void newParkStatus (ISD::ParkStatus status)
 
void newShutterStatus (ISD::Dome::ShutterStatus status)
 
void newStatus (ISD::Dome::Status status)
 
void positionChanged (double degrees)
 
- Signals inherited from ISD::ConcreteDevice
void Connected ()
 
void Disconnected ()
 
void propertyDefined (INDI::Property prop)
 
void propertyDeleted (INDI::Property prop)
 
void propertyUpdated (INDI::Property prop)
 
void ready ()
 

Public Member Functions

 Dome (GenericDevice *parent)
 
Q_SCRIPTABLE bool abort ()
 
Q_SCRIPTABLE bool canAbort () const
 
Q_SCRIPTABLE bool canAbsoluteMove () const
 
Q_SCRIPTABLE bool canPark () const
 
Q_SCRIPTABLE bool canRelativeMove () const
 
bool closeShutter ()
 
bool connected ()
 
Q_SCRIPTABLE bool controlShutter (bool open)
 
double getDomeRadius () const
 
double getEastDisplacement () const
 
double getNorthDisplacement () const
 
double getOTAOffset () const
 
double getShutterWidth () const
 
double getUpDisplacement () const
 
Q_SCRIPTABLE bool hasShutter () const
 
bool isAutoSync ()
 
bool isMoving () const
 
Q_SCRIPTABLE bool isParked () const
 
bool isRolloffRoof ()
 
Q_SCRIPTABLE bool moveCCW ()
 
Q_SCRIPTABLE bool moveCW ()
 
bool moveDome (DomeDirection dir, DomeMotionCommand operation)
 
const QString & name ()
 
bool openShutter ()
 
Q_SCRIPTABLE bool park ()
 
ISD::ParkStatus parkStatus () const
 
ShutterStatus parseShutterStatus (INDI::Property prop)
 
Q_SCRIPTABLE double position () const
 
void processNumber (INDI::Property prop) override
 
void processSwitch (INDI::Property prop) override
 
void registerProperty (INDI::Property prop) override
 
bool setAutoSync (bool activate)
 
Q_SCRIPTABLE bool setPosition (double position)
 
bool setRelativePosition (double position)
 
ShutterStatus shutterStatus ()
 
Status status () const
 
Q_SCRIPTABLE bool unpark ()
 
- Public Member Functions inherited from ISD::ConcreteDevice
 ConcreteDevice (GenericDevice *parent)
 
void Connect ()
 
void Disconnect ()
 
GenericDevice * genericDevice () const
 
INDI::PropertyBlob getBLOB (const QString &name) const
 
const QString & getDeviceName () const
 
const QSharedPointer< DriverInfo > & getDriverInfo () const
 
uint32_t getDriverInterface ()
 
const QString & getDUBSObjectPath () const
 
INDI::PropertyLight getLight (const QString &name) const
 
QString getMessage (int id) const
 
bool getMinMaxStep (const QString &propName, const QString &elementName, double *min, double *max, double *step) const
 
INDI::PropertyNumber getNumber (const QString &name) const
 
IPerm getPermission (const QString &propName) const
 
Properties getProperties () const
 
INDI::Property getProperty (const QString &name) const
 
IPState getState (const QString &propName) const
 
INDI::PropertySwitch getSwitch (const QString &name) const
 
INDI::PropertyText getText (const QString &name) const
 
bool isConnected () const
 
bool isReady () const
 
virtual bool processBLOB (INDI::Property) override
 
virtual void processLight (INDI::Property) override
 
virtual void processMessage (int) override
 
void processProperties ()
 
virtual void processText (INDI::Property) override
 
void registeProperties ()
 
virtual void removeProperty (INDI::Property) override
 
void sendNewProperty (INDI::Property prop)
 
bool setConfig (INDIConfig tConfig)
 
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)
 
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
 

Static Public Member Functions

static const QString getStatusString (Status status, bool translated=true)
 
- 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)
 

Additional Inherited Members

- Public Attributes inherited from QObject
typedef QObjectList
 
- 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)
 
- Static Protected Member Functions inherited from ISD::ConcreteDevice
static uint8_t getID ()
 
- Protected Attributes inherited from ISD::ConcreteDevice
QString m_DBusObjectPath
 
QString m_Name
 
GenericDevice * m_Parent
 
QScopedPointer< QTimer > m_ReadyTimer
 
- Static Protected Attributes inherited from ISD::ConcreteDevice
static uint8_t m_ID = 1
 

Detailed Description

Class handles control of INDI dome devices.

Both open and closed loop (sensor feedback) domes are supported.

Author
Jasem Mutlaq

Definition at line 24 of file indidome.h.

Member Enumeration Documentation

◆ DomeDirection

enum ISD::Dome::DomeDirection

Definition at line 74 of file indidome.h.

◆ DomeMotionCommand

enum ISD::Dome::DomeMotionCommand

Definition at line 80 of file indidome.h.

◆ ShutterStatus

enum ISD::Dome::ShutterStatus

Definition at line 64 of file indidome.h.

◆ Status

enum ISD::Dome::Status

Definition at line 52 of file indidome.h.

Property Documentation

◆ canAbort

bool ISD::Dome::canAbort
read

Definition at line 31 of file indidome.h.

◆ canAbsoluteMove

bool ISD::Dome::canAbsoluteMove
read

Definition at line 29 of file indidome.h.

◆ canPark

bool ISD::Dome::canPark
read

Definition at line 28 of file indidome.h.

◆ canRelativeMove

bool ISD::Dome::canRelativeMove
read

Definition at line 30 of file indidome.h.

◆ isMoving

bool ISD::Dome::isMoving
read

Definition at line 32 of file indidome.h.

◆ parkStatus

ISD::ParkStatus ISD::Dome::parkStatus
read

Definition at line 35 of file indidome.h.

◆ position

double ISD::Dome::position
readwrite

Definition at line 36 of file indidome.h.

◆ shutterStatus

Dome::ShutterStatus ISD::Dome::shutterStatus
read

Definition at line 34 of file indidome.h.

◆ status

ISD::Dome::Status ISD::Dome::status
read

Definition at line 33 of file indidome.h.

Constructor & Destructor Documentation

◆ Dome()

ISD::Dome::Dome ( GenericDevice * parent)
explicit

Definition at line 26 of file indidome.cpp.

Member Function Documentation

◆ abort()

bool ISD::Dome::abort ( )

Definition at line 293 of file indidome.cpp.

◆ canAbort()

Q_SCRIPTABLE bool ISD::Dome::canAbort ( ) const
inline

Definition at line 103 of file indidome.h.

◆ canAbsoluteMove()

Q_SCRIPTABLE bool ISD::Dome::canAbsoluteMove ( ) const
inline

Definition at line 95 of file indidome.h.

◆ canPark()

Q_SCRIPTABLE bool ISD::Dome::canPark ( ) const
inline

Definition at line 91 of file indidome.h.

◆ canRelativeMove()

Q_SCRIPTABLE bool ISD::Dome::canRelativeMove ( ) const
inline

Definition at line 99 of file indidome.h.

◆ closeShutter()

bool ISD::Dome::closeShutter ( )
inline

Definition at line 186 of file indidome.h.

◆ connected()

bool ISD::Dome::connected ( )
inline

Definition at line 47 of file indidome.h.

◆ controlShutter()

bool ISD::Dome::controlShutter ( bool open)

Definition at line 441 of file indidome.cpp.

◆ getDomeRadius()

double ISD::Dome::getDomeRadius ( ) const

getDomeRadius Get the dome radius in meters

Returns
Dome radius value, or 0 if not available

Definition at line 530 of file indidome.cpp.

◆ getEastDisplacement()

double ISD::Dome::getEastDisplacement ( ) const

getEastDisplacement Get the east displacement in meters

Returns
East displacement value, or 0 if not available

Definition at line 566 of file indidome.cpp.

◆ getNorthDisplacement()

double ISD::Dome::getNorthDisplacement ( ) const

getNorthDisplacement Get the north displacement in meters

Returns
North displacement value, or 0 if not available

Definition at line 554 of file indidome.cpp.

◆ getOTAOffset()

double ISD::Dome::getOTAOffset ( ) const

getOTAOffset Get the OTA offset in meters

Returns
OTA offset value, or 0 if not available

Definition at line 590 of file indidome.cpp.

◆ getShutterWidth()

double ISD::Dome::getShutterWidth ( ) const

getShutterWidth Get the shutter width in meters

Returns
Shutter width value, or 0 if not available

Definition at line 542 of file indidome.cpp.

◆ getStatusString()

const QString ISD::Dome::getStatusString ( Dome::Status status,
bool translated = true )
static

Definition at line 487 of file indidome.cpp.

◆ getUpDisplacement()

double ISD::Dome::getUpDisplacement ( ) const

getUpDisplacement Get the up displacement in meters

Returns
Up displacement value, or 0 if not available

Definition at line 578 of file indidome.cpp.

◆ hasShutter()

Q_SCRIPTABLE bool ISD::Dome::hasShutter ( ) const
inline

Definition at line 146 of file indidome.h.

◆ isAutoSync()

bool ISD::Dome::isAutoSync ( )

Definition at line 395 of file indidome.cpp.

◆ isMoving()

bool ISD::Dome::isMoving ( ) const

Definition at line 352 of file indidome.cpp.

◆ isParked()

Q_SCRIPTABLE bool ISD::Dome::isParked ( ) const
inline

Definition at line 107 of file indidome.h.

◆ isRolloffRoof()

bool ISD::Dome::isRolloffRoof ( )
inline

isRolloffRoof Do we have a roll off structure?

Returns
True if we do, false otherwise.

Definition at line 155 of file indidome.h.

◆ moveCCW()

Q_SCRIPTABLE bool ISD::Dome::moveCCW ( )
inline

DBus Interface Function.

moveCCW Start motion in counter-clock-wise direction.

Returns
True if command is successful, false otherwise.

Definition at line 141 of file indidome.h.

◆ moveCW()

Q_SCRIPTABLE bool ISD::Dome::moveCW ( )
inline

DBus Interface Function.

moveCW Start motion in clock-wise direction.

Returns
True if command is successful, false otherwise.

Definition at line 132 of file indidome.h.

◆ moveDome()

bool ISD::Dome::moveDome ( DomeDirection dir,
DomeMotionCommand operation )

Definition at line 425 of file indidome.cpp.

◆ name()

const QString & ISD::Dome::name ( )
inline

Definition at line 42 of file indidome.h.

◆ openShutter()

bool ISD::Dome::openShutter ( )
inline

Definition at line 182 of file indidome.h.

◆ park()

bool ISD::Dome::park ( )

Definition at line 314 of file indidome.cpp.

◆ parkStatus()

ISD::ParkStatus ISD::Dome::parkStatus ( ) const
inline

Definition at line 168 of file indidome.h.

◆ parseShutterStatus()

Dome::ShutterStatus ISD::Dome::parseShutterStatus ( INDI::Property prop)

Definition at line 465 of file indidome.cpp.

◆ position()

double ISD::Dome::position ( ) const
Returns
position Dome Azimuth position in degrees

Definition at line 362 of file indidome.cpp.

◆ processNumber()

void ISD::Dome::processNumber ( INDI::Property prop)
overridevirtual

Reimplemented from ISD::ConcreteDevice.

Definition at line 68 of file indidome.cpp.

◆ processSwitch()

void ISD::Dome::processSwitch ( INDI::Property prop)
overridevirtual

Reimplemented from ISD::ConcreteDevice.

Definition at line 77 of file indidome.cpp.

◆ registerProperty()

void ISD::Dome::registerProperty ( INDI::Property prop)
overridevirtual

Reimplemented from ISD::ConcreteDevice.

Definition at line 39 of file indidome.cpp.

◆ setAutoSync()

bool ISD::Dome::setAutoSync ( bool activate)

Definition at line 408 of file indidome.cpp.

◆ setPosition()

bool ISD::Dome::setPosition ( double position)

setPosition Set azimuth absolute position.

Parameters
positionPosition in degrees 0 to +360
Returns
true if successful, false otherwise

Definition at line 372 of file indidome.cpp.

◆ setRelativePosition()

bool ISD::Dome::setRelativePosition ( double position)

Definition at line 384 of file indidome.cpp.

◆ status()

Status ISD::Dome::status ( ) const
inline

Definition at line 164 of file indidome.h.

◆ unpark()

bool ISD::Dome::unpark ( )

Definition at line 333 of file indidome.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri May 2 2025 12:02:41 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.