INDI::DustCapInterface Class Reference

#include <indidustcapinterface.h>

Inheritance diagram for INDI::DustCapInterface:

Collaboration diagram for INDI::DustCapInterface:

Public Types
enum	{ CAP_PARK, CAP_UNPARK }
enum	{ CAP_PARK, CAP_UNPARK }

Protected Member Functions
	DustCapInterface ()=default
virtual	~DustCapInterface ()=default
virtual IPState	ParkCap ()
	Park dust cap (close cover). More...
virtual IPState	UnParkCap ()
	unPark dust cap (open cover). More...
void	initDustCapProperties (const char *deviceName, const char *groupName)
	Initilize dust cap properties. More...
bool	processDustCapSwitch (const char *dev, const char *name, ISState *states, char *names[], int n)
	Process dust cap switch properties. More...
	DustCapInterface ()=default
virtual	~DustCapInterface ()=default
virtual IPState	ParkCap ()
	Park dust cap (close cover). More...
virtual IPState	UnParkCap ()
	unPark dust cap (open cover). More...
void	initDustCapProperties (const char *deviceName, const char *groupName)
	Initilize dust cap properties. 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]

Private Attributes
char	dustCapName [MAXINDIDEVICE]

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
CAP_PARK
CAP_UNPARK

anonymous enum

anonymous enum

Enumerator
CAP_PARK
CAP_UNPARK

Constructor & Destructor Documentation

DustCapInterface() [1/2]

INDI::DustCapInterface::DustCapInterface ( )

protecteddefault

~DustCapInterface() [1/2]

virtual INDI::DustCapInterface::~DustCapInterface ( )

protectedvirtualdefault

DustCapInterface() [2/2]

INDI::DustCapInterface::DustCapInterface ( )

protecteddefault

~DustCapInterface() [2/2]

virtual INDI::DustCapInterface::~DustCapInterface ( )

protectedvirtualdefault

Member Function Documentation

initDustCapProperties() [1/2]

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

deviceName	Name of the primary device
groupName	Group or tab name to be used to define focuser properties.

initDustCapProperties() [2/2]

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

deviceName	Name of the primary device
groupName	Group or tab name to be used to define focuser properties.

ParkCap() [1/2]

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

ParkCap() [2/2]

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.

processDustCapSwitch() [1/2]

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

protected

Process dust cap switch properties.

processDustCapSwitch() [2/2]

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

protected

Process dust cap switch properties.

UnParkCap() [1/2]

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

UnParkCap() [2/2]

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.

Member Data Documentation

dustCapName

char DustCapInterface::dustCapName

private

ParkCapS

ISwitch DustCapInterface::ParkCapS

protected

ParkCapSP

ISwitchVectorProperty DustCapInterface::ParkCapSP

protected

---

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

• /home/nirva/insroot/include/libindi/indidustcapinterface.h
• ln/3rdparty/src/indilib/indi-1.7.4/libindi/libs/indibase/indidustcapinterface.cpp