Instrument Neutral Distributed Interface INDI  1.5.0
Public Types | Protected Member Functions | Protected Attributes | List of all members
INDI::DustCapInterface Class Reference

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

#include <indidustcapinterface.h>

Inheritance diagram for INDI::DustCapInterface:
FlipFlat

Public Types

Protected Member Functions

 DustCapInterface ()
 
virtual ~DustCapInterface ()
 
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. More...
 

Protected Attributes

ISwitchVectorProperty ParkCapSP
 
ISwitch ParkCapS [2]
 

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 34 of file indidustcapinterface.h.

Member Enumeration Documentation

anonymous enum
Enumerator
CAP_PARK 
CAP_UNPARK 

Definition at line 37 of file indidustcapinterface.h.

Constructor & Destructor Documentation

INDI::DustCapInterface::DustCapInterface ( )
protected

Definition at line 25 of file indidustcapinterface.cpp.

INDI::DustCapInterface::~DustCapInterface ( )
protectedvirtual

Definition at line 29 of file indidustcapinterface.cpp.

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 33 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

Reimplemented in FlipFlat.

Definition at line 71 of file indidustcapinterface.cpp.

bool INDI::DustCapInterface::processDustCapSwitch ( const char *  dev,
const char *  name,
ISState states,
char *  names[],
int  n 
)
protected

Process dust cap switch properties.

Definition at line 44 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

Reimplemented in FlipFlat.

Definition at line 77 of file indidustcapinterface.cpp.

Member Data Documentation

ISwitch INDI::DustCapInterface::ParkCapS[2]
protected

Definition at line 70 of file indidustcapinterface.h.

ISwitchVectorProperty INDI::DustCapInterface::ParkCapSP
protected

Definition at line 69 of file indidustcapinterface.h.


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