Instrument Neutral Distributed Interface INDI  1.4.1
Protected Member Functions | List of all members
INDI::DustCapInterface Class Reference

Provides interface to implement remotely controlled dust cover. More...

#include <indidustcapinterface.h>

Protected Member Functions

virtual IPState ParkCap ()
 Park dust cap (close cover). Must be implemented by child. More...
 
virtual IPState UnParkCap ()
 unPark dust cap (open cover). Must be implemented by child. More...
 
void initDustCapProperties (const char *deviceName, const char *groupName)
 Initilize dust cap properties. It is recommended to call this function within initProperties() of your primary device. More...
 
bool processDustCapSwitch (const char *dev, const char *name, ISState *states, char *names[], int n)
 Process dust cap switch properties.
 

Detailed Description

Provides interface to implement remotely controlled dust cover.

IMPORTANT: initDustCapProperties() must be called before any other function to initilize the Dust Cap properties.

IMPORTANT: processDustCapSwitch() must be called in your driver ISNewSwitch function.

Author
Jasem Mutlaq

Definition at line 36 of file indidustcapinterface.h.

Member Function Documentation

void INDI::DustCapInterface::initDustCapProperties ( const char *  deviceName,
const char *  groupName 
)
protected

Initilize dust cap properties. It is recommended to call this function within initProperties() of your primary device.

Parameters
deviceNameName of the primary device
groupNameGroup or tab name to be used to define focuser properties.

Definition at line 34 of file indidustcapinterface.cpp.

IPState INDI::DustCapInterface::ParkCap ( )
protectedvirtual

Park dust cap (close cover). Must be implemented by child.

Returns
If command completed immediatly, return IPS_OK. If command is in progress, return IPS_BUSY. If there is an error, return IPS_ALERT

Definition at line 69 of file indidustcapinterface.cpp.

IPState INDI::DustCapInterface::UnParkCap ( )
protectedvirtual

unPark dust cap (open cover). Must be implemented by child.

Returns
If command completed immediatly, return IPS_OK. If command is in progress, return IPS_BUSY. If there is an error, return IPS_ALERT

Definition at line 75 of file indidustcapinterface.cpp.


The documentation for this class was generated from the following files: