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

#include <indidustcapinterface.h>

Inheritance diagram for INDI::DustCapInterface:
FlipFlat SnapCap

Public Types

Protected Member Functions

 DustCapInterface ()=default
 
virtual ~DustCapInterface ()=default
 
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

Definition at line 37 of file indidustcapinterface.h.

Member Enumeration Documentation

anonymous enum
Enumerator
CAP_PARK 
CAP_UNPARK 

Definition at line 40 of file indidustcapinterface.h.

Constructor & Destructor Documentation

INDI::DustCapInterface::DustCapInterface ( )
protecteddefault
virtual INDI::DustCapInterface::~DustCapInterface ( )
protectedvirtualdefault

Member Function Documentation

void 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 28 of file indidustcapinterface.cpp.

IPState 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 SnapCap, and FlipFlat.

Definition at line 66 of file indidustcapinterface.cpp.

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

Process dust cap switch properties.

Definition at line 39 of file indidustcapinterface.cpp.

IPState 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 SnapCap, and FlipFlat.

Definition at line 72 of file indidustcapinterface.cpp.

Member Data Documentation

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

Definition at line 73 of file indidustcapinterface.h.

ISwitchVectorProperty INDI::DustCapInterface::ParkCapSP
protected

Definition at line 72 of file indidustcapinterface.h.


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