#include <raindetector.h>
Inheritance diagram for RainDetector:
Public Member Functions | |
| RainDetector ()=default | |
 Public Member Functions inherited from INDI::DefaultDevice | |
| DefaultDevice () | |
| virtual | ~DefaultDevice () override=default |
| void | addAuxControls () |
| Add Debug, Simulation, and Configuration options to the driver. More... | |
| void | addDebugControl () |
| Add Debug control to the driver. More... | |
| void | addSimulationControl () |
| Add Simulation control to the driver. More... | |
| void | addConfigurationControl () |
| Add Configuration control to the driver. More... | |
| void | addPollPeriodControl () |
| Add Polling period control to the driver. More... | |
| void | resetProperties () |
| Set all properties to IDLE state. More... | |
| void | defineNumber (INumberVectorProperty *nvp) |
| Define number vector to client & register it. Alternatively, IDDefNumber can be used but the property will not get registered and the driver will not be able to save configuration files. More... | |
| void | defineProperty (INumberVectorProperty *property) |
| void | defineText (ITextVectorProperty *tvp) |
| Define text vector to client & register it. Alternatively, IDDefText can be used but the property will not get registered and the driver will not be able to save configuration files. More... | |
| void | defineProperty (ITextVectorProperty *property) |
| void | defineSwitch (ISwitchVectorProperty *svp) |
| Define switch vector to client & register it. Alternatively, IDDefswitch can be used but the property will not get registered and the driver will not be able to save configuration files. More... | |
| void | defineProperty (ISwitchVectorProperty *property) |
| void | defineLight (ILightVectorProperty *lvp) |
| Define light vector to client & register it. Alternatively, IDDeflight can be used but the property will not get registered and the driver will not be able to save configuration files. More... | |
| void | defineProperty (ILightVectorProperty *property) |
| void | defineBLOB (IBLOBVectorProperty *bvp) |
| Define BLOB vector to client & register it. Alternatively, IDDefBLOB can be used but the property will not get registered and the driver will not be able to save configuration files. More... | |
| void | defineProperty (IBLOBVectorProperty *property) |
| void | defineProperty (INDI::Property &property) |
| virtual bool | deleteProperty (const char *propertyName) |
| Delete a property and unregister it. It will also be deleted from all clients. More... | |
| bool | deleteProperty (INDI::Property &property) |
| deleteProperty Delete a property and unregister it. It will also be deleted from all clients. More... | |
| virtual void | setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr) |
| Set connection switch status in the client. More... | |
| int | SetTimer (uint32_t ms) |
| Set a timer to call the function TimerHit after ms milliseconds. More... | |
| void | RemoveTimer (int id) |
| Remove timer added with SetTimer. More... | |
| virtual void | TimerHit () |
| Callback function to be called once SetTimer duration elapses. More... | |
| virtual const char * | getDriverExec () |
| virtual const char * | getDriverName () |
| void | setVersion (uint16_t vMajor, uint16_t vMinor) |
| Set driver version information to be defined in DRIVER_INFO property as vMajor.vMinor. More... | |
| uint16_t | getMajorVersion () const |
| uint16_t | getMinorVersion () const |
| virtual void | ISGetProperties (const char *dev) |
| define the driver's properties to the client. Usually, only a minimum set of properties are defined to the client in this function if the device is in disconnected state. Those properties should be enough to enable the client to establish a connection to the device. In addition to CONNECT/DISCONNECT, such properties may include port name, IP address, etc. You should check if the device is already connected, and if this is true, then you must define the remainder of the the properties to the client in this function. Otherwise, the remainder of the driver's properties are defined to the client in updateProperties() function which is called when a client connects/disconnects from a device. More... | |
| virtual bool | ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n) |
| Process the client newSwitch command. More... | |
| virtual bool | ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n) |
| Process the client newNumber command. More... | |
| virtual bool | ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n) |
| Process the client newSwitch command. More... | |
| virtual bool | ISNewBLOB (const char *dev, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n) |
| Process the client newBLOB command. More... | |
| virtual bool | ISSnoopDevice (XMLEle *root) |
| Process a snoop event from INDI server. This function is called when a snooped property is updated in a snooped driver. More... | |
| uint16_t | getDriverInterface () const |
| void | setDriverInterface (uint16_t value) |
| setInterface Set driver interface. By default the driver interface is set to GENERAL_DEVICE. You may send an ORed list of DeviceInterface values. More... | |
| void | watchDevice (const char *deviceName, const std::function< void(INDI::BaseDevice)> &callback) |
| Add a device to the watch list. More... | |
| Public Member Functions inherited from INDI::ParentDevice | |
| ParentDevice (Type type) | |
| ~ParentDevice () | |
| ParentDevice (ParentDevice &&other)=default | |
| ParentDevice & | operator= (ParentDevice &&other)=default |
| Public Member Functions inherited from INDI::BaseDevice | |
| BaseDevice () | |
| virtual | ~BaseDevice () |
| void | registerProperty (const INDI::Property &property) |
| Register the property to be able to observe and update. More... | |
| void | registerProperty (const INDI::Property &property, INDI_PROPERTY_TYPE type) |
| int | removeProperty (const char *name, char *errmsg) |
| Remove a property. More... | |
| void | watchProperty (const char *name, const std::function< void(INDI::Property)> &callback, WATCH watch=WATCH_NEW) |
| Call the callback function if property is available. More... | |
| Property | getProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const |
| Return a property and its type given its name. More... | |
| Properties | getProperties () |
| Return a list of all properties in the device. More... | |
| const Properties | getProperties () const |
| INDI::PropertyNumber | getNumber (const char *name) const |
| INDI::PropertyText | getText (const char *name) const |
| INDI::PropertySwitch | getSwitch (const char *name) const |
| INDI::PropertyLight | getLight (const char *name) const |
| INDI::PropertyBlob | getBLOB (const char *name) const |
| IPState | getPropertyState (const char *name) const |
| IPerm | getPropertyPermission (const char *name) const |
| void * | getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const |
| Return a property and its type given its name. More... | |
| void | addMessage (const std::string &msg) |
| Add message to the driver's message queue. More... | |
| void | checkMessage (XMLEle *root) |
| void | doMessage (XMLEle *msg) |
| const std::string & | messageQueue (size_t index) const |
| const std::string & | lastMessage () const |
| bool | isValid () const |
| bool | isConnected () const |
| void | attach () |
| indicates that the device is ready More... | |
| void | detach () |
| indicates that the device is being removed More... | |
| void | setMediator (INDI::BaseMediator *mediator) |
| Set the driver's mediator to receive notification of news devices and updated property values. More... | |
| INDI::BaseMediator * | getMediator () const |
| void | setDeviceName (const char *dev) |
| Set the device name. More... | |
| const char * | getDeviceName () const |
| bool | isDeviceNameMatch (const char *otherName) const |
| Check that the device name matches the argument. More... | |
| bool | isDeviceNameMatch (const std::string &otherName) const |
| Check that the device name matches the argument. More... | |
| const char * | getDriverName () const |
| const char * | getDriverExec () const |
| const char * | getDriverVersion () const |
| uint16_t | getDriverInterface () const |
| getDriverInterface returns ORed values of DRIVER_INTERFACE. It presents the device classes supported by the driver. More... | |
| bool | buildSkeleton (const char *filename) |
| Build driver properties from a skeleton file. More... | |
| int | buildProp (const INDI::LilXmlElement &root, char *errmsg, bool isDynamic=false) |
| Build a property given the supplied XML element (defXXX) More... | |
| int | setValue (const INDI::LilXmlElement &root, char *errmsg) |
| handle SetXXX commands from client More... | |
| operator BaseDevice * () | |
| BaseDevice * | operator-> () |
| bool | operator!= (std::nullptr_t) const |
| bool | operator== (std::nullptr_t) const |
| operator bool () const | |
| operator bool () | |
Protected Member Functions | |
| bool | Connect () override |
| Connect to the device. INDI::DefaultDevice implementation connects to appropriate connection interface (Serial or TCP) governed by connectionMode. If connection is successful, it proceed to call Handshake() function to ensure communication with device is successful. For other communication interface, override the method in the child class implementation. More... | |
| bool | Disconnect () override |
| Disconnect from device. More... | |
| const char * | getDefaultName () override |
| bool | initProperties () override |
| Initilize properties initial state and value. The child class must implement this function. More... | |
| bool | updateProperties () override |
| updateProperties is called whenever there is a change in the CONNECTION status of the driver. This will enable the driver to react to changes of switching ON/OFF a device. For example, a driver may only define a set of properties after a device is connected, but not before. More... | |
| Protected Member Functions inherited from INDI::DefaultDevice | |
| void | setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled) |
| setDynamicPropertiesBehavior controls handling of dynamic properties. Dyanmic properties are those generated from an external skeleton XML file. By default all properties, including dynamic properties, are defined to the client in ISGetProperties(). Furthermore, when űdeleteProperty(properyName) is called, the dynamic property is deleted by default, and can only be restored by calling buildSkeleton(filename) again. However, it is sometimes desirable to skip the definition of the dynamic properties on startup and delegate this task to the child class. To control this behavior, set enabled to false. More... | |
| virtual bool | loadConfig (bool silent=false, const char *property=nullptr) |
| Load the last saved configuration file. More... | |
| bool | loadConfig (INDI::Property &property) |
| Load property config from the configuration file. If the property configuration is successfully parsed, the corresponding ISNewXXX is called with the values parsed from the config file. More... | |
| virtual bool | saveConfig (bool silent=false, const char *property=nullptr) |
| Save the current properties in a configuration file. More... | |
| bool | saveConfig (INDI::Property &property) |
| Save a property in the configuration file. More... | |
| virtual bool | purgeConfig () |
| purgeConfig Remove config file from disk. More... | |
| virtual bool | saveConfigItems (FILE *fp) |
| saveConfigItems Save specific properties in the provide config file handler. Child class usually override this function to save their own properties and the base class saveConfigItems(fp) must be explicitly called by each child class. The Default Device saveConfigItems(fp) only save Debug properties options in the config file. More... | |
| virtual bool | saveAllConfigItems (FILE *fp) |
| saveAllConfigItems Save all the drivers' properties in the configuration file More... | |
| virtual bool | loadDefaultConfig () |
| Load the default configuration file. More... | |
| void | setDebug (bool enable) |
| Toggle driver debug status A driver can be more verbose if Debug option is enabled by the client. More... | |
| void | setSimulation (bool enable) |
| Toggle driver simulation status A driver can run in simulation mode if Simulation option is enabled by the client. More... | |
| virtual void | debugTriggered (bool enable) |
| Inform driver that the debug option was triggered. This function is called after setDebug is triggered by the client. Reimplement this function if your driver needs to take specific action after debug is enabled/disabled. Otherwise, you can use isDebug() to check if simulation is enabled or disabled. More... | |
| virtual void | simulationTriggered (bool enable) |
| Inform driver that the simulation option was triggered. This function is called after setSimulation is triggered by the client. Reimplement this function if your driver needs to take specific action after simulation is enabled/disabled. Otherwise, you can use isSimulation() to check if simulation is enabled or disabled. More... | |
| bool | isDebug () const |
| bool | isSimulation () const |
| void | registerConnection (Connection::Interface *newConnection) |
| registerConnection Add new connection plugin to the existing connection pool. The connection type shall be defined to the client in ISGetProperties() More... | |
| bool | unRegisterConnection (Connection::Interface *existingConnection) |
| unRegisterConnection Remove connection from existing pool More... | |
| Connection::Interface * | getActiveConnection () |
| void | setActiveConnection (Connection::Interface *existingConnection) |
| setActiveConnection Switch the active connection to the passed connection plugin More... | |
| void | setDefaultPollingPeriod (uint32_t msec) |
| setDefaultPollingPeriod Change the default polling period to call TimerHit() function in the driver. More... | |
| void | setPollingPeriodRange (uint32_t minimum, uint32_t maximum) |
| setPollingPeriodRange Set the range permitted by the polling range in milliseconds More... | |
| uint32_t | getPollingPeriod () const |
| getPollingPeriod Return the polling period. More... | |
| void | setCurrentPollingPeriod (uint32_t msec) |
| setCurrentPollingPeriod Change the current polling period to call TimerHit() function in the driver. More... | |
| uint32_t | getCurrentPollingPeriod () const |
| getCurrentPollingPeriod Return the current polling period. More... | |
| uint32_t & | refCurrentPollingPeriod () __attribute__((deprecated)) |
| uint32_t | refCurrentPollingPeriod () const __attribute__((deprecated)) |
| bool | isConfigLoading () const |
| isConfigLoading Check if driver configuration is currently in the process of getting loaded. More... | |
| bool | isInitializationComplete () const |
| isInitializationComplete Check if driver initialization is complete. More... | |
| void | syncDriverInfo () |
| syncDriverInfo sends the current driver information to the client. More... | |
| DefaultDevice (const std::shared_ptr< DefaultDevicePrivate > &dd) | |
| Protected Member Functions inherited from INDI::ParentDevice | |
| ParentDevice (const std::shared_ptr< ParentDevicePrivate > &dd) | |
| Protected Member Functions inherited from INDI::BaseDevice | |
| BaseDevice (BaseDevicePrivate &dd) | |
| BaseDevice (const std::shared_ptr< BaseDevicePrivate > &dd) | |
Additional Inherited Members | |
| Public Types inherited from INDI::ParentDevice | |
| enum | Type { Valid , Invalid } |
| Public Types inherited from INDI::BaseDevice | |
| enum | INDI_ERROR { INDI_DEVICE_NOT_FOUND = -1 , INDI_PROPERTY_INVALID = -2 , INDI_PROPERTY_DUPLICATED = -3 , INDI_DISPATCH_ERROR = -4 } |
| enum | { INDI_ENABLED , INDI_DISABLED } |
| enum | WATCH { WATCH_NEW = 0 , WATCH_UPDATE , WATCH_NEW_OR_UPDATE } |
| enum | DRIVER_INTERFACE { GENERAL_INTERFACE = 0 , TELESCOPE_INTERFACE = (1 << 0) , CCD_INTERFACE = (1 << 1) , GUIDER_INTERFACE = (1 << 2) , FOCUSER_INTERFACE = (1 << 3) , FILTER_INTERFACE = (1 << 4) , DOME_INTERFACE = (1 << 5) , GPS_INTERFACE = (1 << 6) , WEATHER_INTERFACE = (1 << 7) , AO_INTERFACE = (1 << 8) , DUSTCAP_INTERFACE = (1 << 9) , LIGHTBOX_INTERFACE = (1 << 10) , DETECTOR_INTERFACE = (1 << 11) , ROTATOR_INTERFACE = (1 << 12) , SPECTROGRAPH_INTERFACE = (1 << 13) , CORRELATOR_INTERFACE = (1 << 14) , AUX_INTERFACE = (1 << 15) , SENSOR_INTERFACE = SPECTROGRAPH_INTERFACE | DETECTOR_INTERFACE | CORRELATOR_INTERFACE } |
| The DRIVER_INTERFACE enum defines the class of devices the driver implements. A driver may implement one or more interfaces. More... | |
| typedef INDI::Properties | Properties |
| Static Public Member Functions inherited from INDI::BaseDevice | |
| static std::string | getSharedFilePath (std::string fileName) |
| Protected Attributes inherited from INDI::BaseDevice | |
| std::shared_ptr< BaseDevicePrivate > | d_ptr |
Detailed Description
- Examples
- raindetector.h.
Definition at line 27 of file raindetector.h.
Constructor & Destructor Documentation
◆ RainDetector()
|
default |
- Examples
- raindetector.h.
Member Function Documentation
◆ Connect()
|
overrideprotectedvirtual |
Connect to the device. INDI::DefaultDevice implementation connects to appropriate connection interface (Serial or TCP) governed by connectionMode. If connection is successful, it proceed to call Handshake() function to ensure communication with device is successful. For other communication interface, override the method in the child class implementation.
- Returns
- True if connection is successful, false otherwise
Reimplemented from INDI::DefaultDevice.
- Examples
- raindetector.h.
Definition at line 28 of file raindetector.cpp.
◆ Disconnect()
|
overrideprotectedvirtual |
Disconnect from device.
- Returns
- True if successful, false otherwise
Reimplemented from INDI::DefaultDevice.
- Examples
- raindetector.h.
Definition at line 37 of file raindetector.cpp.
◆ getDefaultName()
|
overrideprotectedvirtual |
- Returns
- Default name of the device.
Implements INDI::DefaultDevice.
- Examples
- raindetector.h.
Definition at line 46 of file raindetector.cpp.
◆ initProperties()
|
overrideprotectedvirtual |
Initilize properties initial state and value. The child class must implement this function.
- Returns
- True if initilization is successful, false otherwise.
Reimplemented from INDI::DefaultDevice.
- Examples
- raindetector.h.
Definition at line 54 of file raindetector.cpp.
◆ updateProperties()
|
overrideprotectedvirtual |
updateProperties is called whenever there is a change in the CONNECTION status of the driver. This will enable the driver to react to changes of switching ON/OFF a device. For example, a driver may only define a set of properties after a device is connected, but not before.
- Returns
- True if update is successful, false otherwise.
Reimplemented from INDI::DefaultDevice.
- Examples
- raindetector.h.
Definition at line 89 of file raindetector.cpp.
The documentation for this class was generated from the following files:
