INDI::LightBoxInterface Class Reference

#include <indilightboxinterface.h>

Inheritance diagram for INDI::LightBoxInterface:

Public Types
enum	{ FLAT_LIGHT_ON , FLAT_LIGHT_OFF }
enum	{ CAN_DIM = 1 << 0 }

Public Attributes
enum INDI::LightBoxInterface:: { ... }	LightBoxCapability

Protected Member Functions
	LightBoxInterface (DefaultDevice *device)
virtual	~LightBoxInterface ()
void	initProperties (const char *group, uint32_t capabilities)
	Initialize light box properties. It is recommended to call this function within initProperties() of your primary device.
void	ISGetProperties (const char *deviceName)
	isGetLightBoxProperties Get light box properties
bool	processSwitch (const char *dev, const char *name, ISState *states, char *names[], int n)
	Process light box switch properties.
bool	processNumber (const char *dev, const char *name, double values[], char *names[], int n)
	Process light box number properties.
bool	processText (const char *dev, const char *name, char *texts[], char *names[], int n)
	Process light box text properties.
bool	updateProperties ()
bool	saveConfigItems (FILE *fp)
bool	snoop (XMLEle *root)
virtual bool	SetLightBoxBrightness (uint16_t value)
	setBrightness Set light level. Must be implemented in the child class, if supported.
virtual bool	EnableLightBox (bool enable)
	EnableLightBox Turn on/off on a light box. Must be implemented in the child class.

Protected Attributes
INDI::PropertySwitch	LightSP {2}
INDI::PropertyNumber	LightIntensityNP {1}
INDI::PropertyText	ActiveDeviceTP {1}
INDI::PropertyNumber	FilterIntensityNP {0}

Detailed Description

Definition at line 53 of file indilightboxinterface.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
FLAT_LIGHT_ON
FLAT_LIGHT_OFF

Definition at line 56 of file indilightboxinterface.h.

anonymous enum

anonymous enum

Enumerator
CAN_DIM

Definition at line 62 of file indilightboxinterface.h.

Constructor & Destructor Documentation

LightBoxInterface()

LightBoxInterface::LightBoxInterface ( DefaultDevice *  device )

protected

Definition at line 33 of file indilightboxinterface.cpp.

~LightBoxInterface()

LightBoxInterface::~LightBoxInterface ( )

protectedvirtual

Definition at line 40 of file indilightboxinterface.cpp.

Member Function Documentation

EnableLightBox()

bool LightBoxInterface::EnableLightBox ( bool  enable )

protectedvirtual

EnableLightBox Turn on/off on a light box. Must be implemented in the child class.

Parameters

enable

If true, turn on the light, otherwise turn off the light.

Returns

True if successful, false otherwise.

Reimplemented in DeepSkyDadFP, DragonLIGHT, Excalibur, FlipFlat, GeminiFlatpanel, GIOTTO, LightPanelSimulator, PegasusFlatMaster, PegasusFlatMasterNeo, PegasusFlatMasterWifi, SnapCap, WandererCover, WandererCoverV4EC, and WandererCoverV4ProEC.

Definition at line 227 of file indilightboxinterface.cpp.

initProperties()

void LightBoxInterface::initProperties ( const char *  group, uint32_t  capabilities  )

protected

Initialize light box properties. It is recommended to call this function within initProperties() of your primary device.

Parameters

group	Group or tab name to be used to define light box properties.
capabilities	Light box capabilities

Definition at line 47 of file indilightboxinterface.cpp.

ISGetProperties()

void LightBoxInterface::ISGetProperties ( const char *  deviceName )

protected

isGetLightBoxProperties Get light box properties

Parameters

deviceName

parent device name

Definition at line 78 of file indilightboxinterface.cpp.

processNumber()

bool LightBoxInterface::processNumber ( const char *  dev, const char *  name, double  values[], char *  names[], int  n  )

protected

Process light box number properties.

Definition at line 142 of file indilightboxinterface.cpp.

processSwitch()

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

protected

Process light box switch properties.

Definition at line 113 of file indilightboxinterface.cpp.

processText()

bool LightBoxInterface::processText ( const char *  dev, const char *  name, char *  texts[], char *  names[], int  n  )

protected

Process light box text properties.

Definition at line 194 of file indilightboxinterface.cpp.

saveConfigItems()

bool LightBoxInterface::saveConfigItems ( FILE *  fp )

protected

Definition at line 369 of file indilightboxinterface.cpp.

SetLightBoxBrightness()

bool LightBoxInterface::SetLightBoxBrightness ( uint16_t  value )

protectedvirtual

setBrightness Set light level. Must be implemented in the child class, if supported.

Parameters

value

level of light box

Returns

True if successful, false otherwise.

Reimplemented in DeepSkyDadFP, DragonLIGHT, Excalibur, FlipFlat, GeminiFlatpanel, GIOTTO, LightPanelSimulator, PegasusFlatMaster, PegasusFlatMasterNeo, PegasusFlatMasterWifi, SnapCap, WandererCover, WandererCoverV4EC, and WandererCoverV4ProEC.

Definition at line 237 of file indilightboxinterface.cpp.

snoop()

bool LightBoxInterface::snoop ( XMLEle *  root )

protected

Definition at line 247 of file indilightboxinterface.cpp.

updateProperties()

bool LightBoxInterface::updateProperties ( )

protected

Definition at line 87 of file indilightboxinterface.cpp.

Member Data Documentation

ActiveDeviceTP

INDI::PropertyText INDI::LightBoxInterface::ActiveDeviceTP {1}

protected

Definition at line 117 of file indilightboxinterface.h.

FilterIntensityNP

INDI::PropertyNumber INDI::LightBoxInterface::FilterIntensityNP {0}

protected

Definition at line 119 of file indilightboxinterface.h.

[]

enum { ... } INDI::LightBoxInterface::LightBoxCapability

LightIntensityNP

INDI::PropertyNumber INDI::LightBoxInterface::LightIntensityNP {1}

protected

Definition at line 114 of file indilightboxinterface.h.

LightSP

INDI::PropertySwitch INDI::LightBoxInterface::LightSP {2}

protected

Definition at line 111 of file indilightboxinterface.h.

---

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

• indilightboxinterface.h
• indilightboxinterface.cpp