#include <indifilterwheel.h>

Inheritance diagram for INDI::FilterWheel:

Collaboration diagram for INDI::FilterWheel:

Public Types
enum	{ CONNECTION_NONE = 1 << 0, CONNECTION_SERIAL = 1 << 1, CONNECTION_TCP = 1 << 2 }

enum	{ CONNECTION_NONE = 1 << 0, CONNECTION_SERIAL = 1 << 1, CONNECTION_TCP = 1 << 2 }

Public Types inherited from INDI::BaseDevice
enum	INDI_ERROR { INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4, INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4 }

enum	DRIVER_INTERFACE { GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2), FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6), WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10), DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15), GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2), FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6), WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10), DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15) }
	The DRIVER_INTERFACE enum defines the class of devices the driver implements. More...

enum	INDI_ERROR { INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4, INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4 }

enum	DRIVER_INTERFACE { GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2), FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6), WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10), DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15), GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2), FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6), WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10), DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15) }
	The DRIVER_INTERFACE enum defines the class of devices the driver implements. More...

Public Member Functions
virtual bool	initProperties ()
	Initilize properties initial state and value. More...

virtual bool	updateProperties ()
	updateProperties is called whenever there is a change in the CONNECTION status of the driver. More...

virtual void	ISGetProperties (const char *dev)
	define the driver's properties to the client. More...

virtual bool	ISSnoopDevice (XMLEle *root)
	Process a snoop event from INDI server. More...

virtual bool	ISNewSwitch (const char dev, const char name, ISState states, char names[], int n)
	Process the client newSwitch command. More...

virtual bool	ISNewNumber (const char dev, const char name, double values[], char *names[], int n)
	Process the client newNumber command. More...

virtual bool	ISNewText (const char dev, const char name, char texts[], char names[], int n)
	Process the client newSwitch command. More...

void	setFilterConnection (const uint8_t &value)
	setFilterConnection Set Filter connection mode. More...

uint8_t	getFilterConnection () const

virtual bool	initProperties ()
	Initilize properties initial state and value. More...

virtual bool	updateProperties ()
	updateProperties is called whenever there is a change in the CONNECTION status of the driver. More...

virtual void	ISGetProperties (const char *dev)
	define the driver's properties to the client. More...

virtual bool	ISSnoopDevice (XMLEle *root)
	Process a snoop event from INDI server. More...

virtual bool	ISNewSwitch (const char dev, const char name, ISState states, char names[], int n)
	Process the client newSwitch command. More...

virtual bool	ISNewNumber (const char dev, const char name, double values[], char *names[], int n)
	Process the client newNumber command. More...

virtual bool	ISNewText (const char dev, const char name, char texts[], char names[], int n)
	Process the client newSwitch command. More...

void	setFilterConnection (const uint8_t &value)
	setFilterConnection Set Filter connection mode. More...

uint8_t	getFilterConnection () const

Public Member Functions inherited from INDI::DefaultDevice
	DefaultDevice ()

virtual	~DefaultDevice ()

void	addAuxControls ()
	Add Debug, Simulation, and Configuration options to the driver. More...

void	addDebugControl ()
	Add Debug control to the driver. More...

void	addSimulationControl ()
	Add Simulation control to the driver. More...

void	addConfigurationControl ()
	Add Configuration control to the driver. More...

void	addPollPeriodControl ()
	Add Polling period control to the driver. More...

void	resetProperties ()
	Set all properties to IDLE state. More...

void	defineNumber (INumberVectorProperty *nvp)
	Define number vector to client & register it. More...

void	defineText (ITextVectorProperty *tvp)
	Define text vector to client & register it. More...

void	defineSwitch (ISwitchVectorProperty *svp)
	Define switch vector to client & register it. More...

void	defineLight (ILightVectorProperty *lvp)
	Define light vector to client & register it. More...

void	defineBLOB (IBLOBVectorProperty *bvp)
	Define BLOB vector to client & register it. More...

virtual bool	deleteProperty (const char *propertyName)
	Delete a property and unregister it. More...

virtual void	setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr)
	Set connection switch status in the client. More...

int	SetTimer (uint32_t ms)
	Set a timer to call the function TimerHit after ms milliseconds. More...

void	RemoveTimer (int id)
	Remove timer added with SetTimer. More...

virtual void	TimerHit ()
	Callback function to be called once SetTimer duration elapses. More...

virtual const char *	getDriverExec ()

virtual const char *	getDriverName ()

void	setVersion (uint16_t vMajor, uint16_t vMinor)
	Set driver version information to be defined in DRIVER_INFO property as vMajor.vMinor. More...

uint16_t	getMajorVersion ()

uint16_t	getMinorVersion ()

virtual bool	ISNewBLOB (const char dev, const char name, int sizes[], int blobsizes[], char blobs[], char formats[], char *names[], int n)
	Process the client newBLOB command. More...

virtual uint16_t	getDriverInterface ()

void	setDriverInterface (uint16_t value)
	setInterface Set driver interface. More...

	DefaultDevice ()

virtual	~DefaultDevice ()

void	addAuxControls ()
	Add Debug, Simulation, and Configuration options to the driver. More...

void	addDebugControl ()
	Add Debug control to the driver. More...

void	addSimulationControl ()
	Add Simulation control to the driver. More...

void	addConfigurationControl ()
	Add Configuration control to the driver. More...

void	addPollPeriodControl ()
	Add Polling period control to the driver. More...

void	resetProperties ()
	Set all properties to IDLE state. More...

void	defineNumber (INumberVectorProperty *nvp)
	Define number vector to client & register it. More...

void	defineText (ITextVectorProperty *tvp)
	Define text vector to client & register it. More...

void	defineSwitch (ISwitchVectorProperty *svp)
	Define switch vector to client & register it. More...

void	defineLight (ILightVectorProperty *lvp)
	Define light vector to client & register it. More...

void	defineBLOB (IBLOBVectorProperty *bvp)
	Define BLOB vector to client & register it. More...

virtual bool	deleteProperty (const char *propertyName)
	Delete a property and unregister it. More...

virtual void	setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr)
	Set connection switch status in the client. More...

int	SetTimer (uint32_t ms)
	Set a timer to call the function TimerHit after ms milliseconds. More...

void	RemoveTimer (int id)
	Remove timer added with SetTimer. More...

virtual void	TimerHit ()
	Callback function to be called once SetTimer duration elapses. More...

virtual const char *	getDriverExec ()

virtual const char *	getDriverName ()

void	setVersion (uint16_t vMajor, uint16_t vMinor)
	Set driver version information to be defined in DRIVER_INFO property as vMajor.vMinor. More...

uint16_t	getMajorVersion ()

uint16_t	getMinorVersion ()

virtual bool	ISNewBLOB (const char dev, const char name, int sizes[], int blobsizes[], char blobs[], char formats[], char *names[], int n)
	Process the client newBLOB command. More...

virtual uint16_t	getDriverInterface ()

void	setDriverInterface (uint16_t value)
	setInterface Set driver interface. More...

Public Member Functions inherited from INDI::BaseDevice
	BaseDevice ()

virtual	~BaseDevice ()

INumberVectorProperty *	getNumber (const char *name)

ITextVectorProperty *	getText (const char *name)

ISwitchVectorProperty *	getSwitch (const char *name)

ILightVectorProperty *	getLight (const char *name)

IBLOBVectorProperty *	getBLOB (const char *name)

IPState	getPropertyState (const char *name)

IPerm	getPropertyPermission (const char *name)

void	registerProperty (void *p, INDI_PROPERTY_TYPE type)

int	removeProperty (const char name, char errmsg)
	Remove a property. More...

void *	getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
	Return a property and its type given its name. More...

INDI::Property *	getProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
	Return a property and its type given its name. More...

std::vector< INDI::Property * > *	getProperties ()
	Return a list of all properties in the device. More...

bool	buildSkeleton (const char *filename)
	Build driver properties from a skeleton file. More...

bool	isConnected ()

void	setDeviceName (const char *dev)
	Set the device name. More...

const char *	getDeviceName ()

void	addMessage (const std::string &msg)
	Add message to the driver's message queue. More...

void	checkMessage (XMLEle *root)

void	doMessage (XMLEle *msg)

std::string	messageQueue (int index) const

std::string	lastMessage ()

void	setMediator (INDI::BaseMediator *med)
	Set the driver's mediator to receive notification of news devices and updated property values. More...

INDI::BaseMediator *	getMediator ()

const char *	getDriverName ()

const char *	getDriverExec ()

const char *	getDriverVersion ()

	BaseDevice ()

virtual	~BaseDevice ()

INumberVectorProperty *	getNumber (const char *name)

ITextVectorProperty *	getText (const char *name)

ISwitchVectorProperty *	getSwitch (const char *name)

ILightVectorProperty *	getLight (const char *name)

IBLOBVectorProperty *	getBLOB (const char *name)

IPState	getPropertyState (const char *name)

IPerm	getPropertyPermission (const char *name)

void	registerProperty (void *p, INDI_PROPERTY_TYPE type)

int	removeProperty (const char name, char errmsg)
	Remove a property. More...

void *	getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
	Return a property and its type given its name. More...

INDI::Property *	getProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
	Return a property and its type given its name. More...

std::vector< INDI::Property * > *	getProperties ()
	Return a list of all properties in the device. More...

bool	buildSkeleton (const char *filename)
	Build driver properties from a skeleton file. More...

bool	isConnected ()

void	setDeviceName (const char *dev)
	Set the device name. More...

const char *	getDeviceName ()

void	addMessage (const std::string &msg)
	Add message to the driver's message queue. More...

void	checkMessage (XMLEle *root)

void	doMessage (XMLEle *msg)

std::string	messageQueue (int index) const

std::string	lastMessage ()

void	setMediator (INDI::BaseMediator *med)
	Set the driver's mediator to receive notification of news devices and updated property values. More...

INDI::BaseMediator *	getMediator ()

const char *	getDriverName ()

const char *	getDriverExec ()

const char *	getDriverVersion ()

Public Member Functions inherited from INDI::FilterInterface
virtual bool	SetFilterNames ()
	Set filter names as defined by the client for each filter position. More...

virtual bool	GetFilterNames ()
	Obtains a list of filter names from the hardware and initializes the FilterNameTP property. More...

void	SelectFilterDone (int newpos)
	The child class calls this function when the hardware successfully finished selecting a new filter wheel position. More...

virtual bool	SetFilterNames ()
	Set filter names as defined by the client for each filter position. More...

virtual bool	GetFilterNames ()
	Obtains a list of filter names from the hardware and initializes the FilterNameTP property. More...

void	SelectFilterDone (int newpos)
	The child class calls this function when the hardware successfully finished selecting a new filter wheel position. More...

Static Public Member Functions
static void	joystickHelper (const char joystick_n, double mag, double angle, void context)

static void	buttonHelper (const char button_n, ISState state, void context)

static void	joystickHelper (const char joystick_n, double mag, double angle, void context)

static void	buttonHelper (const char button_n, ISState state, void context)

Public Attributes
enum INDI::FilterWheel:: { ... }	FilterConnection

enum INDI::FilterWheel:: { ... }	FilterConnection

Protected Member Functions
	FilterWheel ()

virtual	~FilterWheel ()=default

virtual bool	saveConfigItems (FILE *fp)
	saveConfigItems Save specific properties in the provide config file handler. More...

virtual int	QueryFilter ()
	Return current filter position. More...

virtual bool	SelectFilter (int)
	Select a new filter position. More...

virtual bool	Handshake ()
	perform handshake with device to check communication More...

void	processJoystick (const char *joystick_n, double mag, double angle)

void	processButton (const char *button_n, ISState state)

	FilterWheel ()

virtual	~FilterWheel ()=default

virtual bool	saveConfigItems (FILE *fp)
	saveConfigItems Save specific properties in the provide config file handler. More...

virtual int	QueryFilter ()
	Return current filter position. More...

virtual bool	SelectFilter (int)
	Select a new filter position. More...

virtual bool	Handshake ()
	perform handshake with device to check communication More...

void	processJoystick (const char *joystick_n, double mag, double angle)

void	processButton (const char *button_n, ISState state)

Protected Member Functions inherited from INDI::DefaultDevice
void	setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled)
	setDynamicPropertiesBehavior controls handling of dynamic properties. More...

virtual bool	loadConfig (bool silent=false, const char *property=nullptr)
	Load the last saved configuration file. More...

virtual bool	saveConfig (bool silent=false, const char *property=nullptr)
	Save the current properties in a configuration file. More...

virtual bool	saveAllConfigItems (FILE *fp)
	saveAllConfigItems Save all the drivers' properties in the configuration file More...

virtual bool	loadDefaultConfig ()
	Load the default configuration file. More...

void	setDebug (bool enable)
	Toggle driver debug status A driver can be more verbose if Debug option is enabled by the client. More...

void	setSimulation (bool enable)
	Toggle driver simulation status A driver can run in simulation mode if Simulation option is enabled by the client. More...

virtual void	debugTriggered (bool enable)
	Inform driver that the debug option was triggered. More...

virtual void	simulationTriggered (bool enable)
	Inform driver that the simulation option was triggered. More...

bool	isDebug ()

bool	isSimulation ()

virtual bool	Connect ()
	Connect to the device. More...

virtual bool	Disconnect ()
	Disconnect from device. More...

void	registerConnection (Connection::Interface *newConnection)
	registerConnection Add new connection plugin to the existing connection pool. More...

bool	unRegisterConnection (Connection::Interface *existingConnection)
	unRegisterConnection Remove connection from existing pool More...

Connection::Interface *	getActiveConnection ()

void	setDefaultPollingPeriod (uint32_t period)

uint32_t	getPollingPeriod ()

virtual const char *	getDefaultName ()=0

void	setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled)
	setDynamicPropertiesBehavior controls handling of dynamic properties. More...

virtual bool	loadConfig (bool silent=false, const char *property=nullptr)
	Load the last saved configuration file. More...

virtual bool	saveConfig (bool silent=false, const char *property=nullptr)
	Save the current properties in a configuration file. More...

virtual bool	saveAllConfigItems (FILE *fp)
	saveAllConfigItems Save all the drivers' properties in the configuration file More...

virtual bool	loadDefaultConfig ()
	Load the default configuration file. More...

void	setDebug (bool enable)
	Toggle driver debug status A driver can be more verbose if Debug option is enabled by the client. More...

void	setSimulation (bool enable)
	Toggle driver simulation status A driver can run in simulation mode if Simulation option is enabled by the client. More...

virtual void	debugTriggered (bool enable)
	Inform driver that the debug option was triggered. More...

virtual void	simulationTriggered (bool enable)
	Inform driver that the simulation option was triggered. More...

bool	isDebug ()

bool	isSimulation ()

virtual bool	Connect ()
	Connect to the device. More...

virtual bool	Disconnect ()
	Disconnect from device. More...

void	registerConnection (Connection::Interface *newConnection)
	registerConnection Add new connection plugin to the existing connection pool. More...

bool	unRegisterConnection (Connection::Interface *existingConnection)
	unRegisterConnection Remove connection from existing pool More...

Connection::Interface *	getActiveConnection ()

void	setDefaultPollingPeriod (uint32_t period)

uint32_t	getPollingPeriod ()

virtual const char *	getDefaultName ()=0

Protected Member Functions inherited from INDI::BaseDevice
int	buildProp (XMLEle root, char errmsg)
	Build a property given the supplied XML element (defXXX) More...

int	setValue (XMLEle root, char errmsg)
	handle SetXXX commands from client More...

int	setBLOB (IBLOBVectorProperty pp, XMLEle root, char *errmsg)
	Parse and store BLOB in the respective vector. More...

int	buildProp (XMLEle root, char errmsg)
	Build a property given the supplied XML element (defXXX) More...

int	setValue (XMLEle root, char errmsg)
	handle SetXXX commands from client More...

int	setBLOB (IBLOBVectorProperty pp, XMLEle root, char *errmsg)
	Parse and store BLOB in the respective vector. More...

Protected Member Functions inherited from INDI::FilterInterface
	FilterInterface (DefaultDevice *defaultDevice)
	FilterInterface Initiailize Filter Interface. More...

	~FilterInterface ()

void	initProperties (const char *groupName)
	Initilize filter wheel properties. More...

bool	updateProperties ()
	updateProperties Defines or Delete proprties based on default device connection status More...

bool	processNumber (const char dev, const char name, double values[], char *names[], int n)
	Process number properties. More...

bool	processText (const char dev, const char name, char texts[], char names[], int n)
	Process text properties. More...

void	generateSampleFilters ()
	generateSampleFilters Generate sample 8-filter wheel and fill it sample filters More...

bool	saveConfigItems (FILE *fp)
	saveConfigItems save Filter Names in config file More...

	FilterInterface (DefaultDevice *defaultDevice)
	FilterInterface Initiailize Filter Interface. More...

	~FilterInterface ()

void	initProperties (const char *groupName)
	Initilize filter wheel properties. More...

bool	updateProperties ()
	updateProperties Defines or Delete proprties based on default device connection status More...

bool	processNumber (const char dev, const char name, double values[], char *names[], int n)
	Process number properties. More...

bool	processText (const char dev, const char name, char texts[], char names[], int n)
	Process text properties. More...

void	generateSampleFilters ()
	generateSampleFilters Generate sample 8-filter wheel and fill it sample filters More...

bool	saveConfigItems (FILE *fp)
	saveConfigItems save Filter Names in config file More...

Protected Attributes
Controller *	controller

Connection::Serial *	serialConnection = NULL

Connection::TCP *	tcpConnection = NULL

int	PortFD = -1
	For Serial & TCP connections. More...

Protected Attributes inherited from INDI::DefaultDevice
uint32_t	POLLMS = 1000
	Period in milliseconds to call TimerHit(). Default 1000 ms. More...

Protected Attributes inherited from INDI::FilterInterface
INumberVectorProperty	FilterSlotNP

INumber	FilterSlotN [1]

ITextVectorProperty *	FilterNameTP { nullptr }

IText *	FilterNameT

int	CurrentFilter

int	TargetFilter

bool	loadingFromConfig = false

DefaultDevice *	m_defaultDevice { nullptr }

Private Member Functions
bool	callHandshake ()

bool	callHandshake ()

Private Attributes
uint8_t	filterConnection = CONNECTION_NONE

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
CONNECTION_NONE
CONNECTION_SERIAL	Do not use any connection plugin.
CONNECTION_TCP	For regular serial and bluetooth connections.

◆ anonymous enum

anonymous enum

Enumerator
CONNECTION_NONE
CONNECTION_SERIAL	Do not use any connection plugin.
CONNECTION_TCP	For regular serial and bluetooth connections.

Constructor & Destructor Documentation

◆ FilterWheel() [1/2]

FilterWheel::FilterWheel ( )

protected

◆ ~FilterWheel() [1/2]

virtual INDI::FilterWheel::~FilterWheel ( )

protectedvirtualdefault

◆ FilterWheel() [2/2]

INDI::FilterWheel::FilterWheel ( )

protected

◆ ~FilterWheel() [2/2]

virtual INDI::FilterWheel::~FilterWheel ( )

protectedvirtualdefault

Member Function Documentation

◆ buttonHelper() [1/2]

void FilterWheel::buttonHelper	(	const char *	button_n,
		ISState	state,
		void *	context
	)

static

◆ buttonHelper() [2/2]

static void INDI::FilterWheel::buttonHelper	(	const char *	button_n,
		ISState	state,
		void *	context
	)

static

◆ callHandshake() [1/2]

bool FilterWheel::callHandshake ( )

private

◆ callHandshake() [2/2]

bool INDI::FilterWheel::callHandshake ( )

private

◆ getFilterConnection() [1/2]

uint8_t INDI::FilterWheel::getFilterConnection ( ) const

Returns: Get current Filter connection mode

◆ getFilterConnection() [2/2]

uint8_t INDI::FilterWheel::getFilterConnection ( ) const

Returns: Get current Filter connection mode

◆ Handshake() [1/2]

virtual bool INDI::FilterWheel::Handshake ( )

protectedvirtual

perform handshake with device to check communication

Reimplemented in FilterIFW, XAGYLWheel, TruTech, and QFW.

◆ Handshake() [2/2]

bool FilterWheel::Handshake ( )

protectedvirtual

perform handshake with device to check communication

Reimplemented in FilterIFW, XAGYLWheel, TruTech, and QFW.

◆ initProperties() [1/2]

virtual bool INDI::FilterWheel::initProperties ( )

virtual

Initilize properties initial state and value.

The child class must implement this function.

Returns: True if initilization is successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

Reimplemented in FilterIFW, XAGYLWheel, SXWHEEL, ASIWHEEL, FLICFW, TruTech, and QFW.

◆ initProperties() [2/2]

bool FilterWheel::initProperties ( )

virtual

Initilize properties initial state and value.

The child class must implement this function.

Returns: True if initilization is successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

Reimplemented in FilterIFW, XAGYLWheel, SXWHEEL, ASIWHEEL, FLICFW, TruTech, and QFW.

◆ ISGetProperties() [1/2]

virtual void INDI::FilterWheel::ISGetProperties ( const char * dev )

virtual

define the driver's properties to the client.

Usually, only a minimum set of properties are defined to the client in this function if the device is in disconnected state. Those properties should be enough to enable the client to establish a connection to the device. In addition to CONNECT/DISCONNECT, such properties may include port name, IP address, etc. You should check if the device is already connected, and if this is true, then you must define the remainder of the the properties to the client in this function. Otherwise, the remainder of the driver's properties are defined to the client in updateProperties() function which is called when a client connects/disconnects from a device.

Parameters

dev	name of the device

Note: This function is called by the INDI framework, do not call it directly. See LX200 Generic driver for an example implementation

Reimplemented from INDI::DefaultDevice.

Reimplemented in FLICFW, QFW, and TruTech.

◆ ISGetProperties() [2/2]

void FilterWheel::ISGetProperties ( const char * dev )

virtual

define the driver's properties to the client.

Usually, only a minimum set of properties are defined to the client in this function if the device is in disconnected state. Those properties should be enough to enable the client to establish a connection to the device. In addition to CONNECT/DISCONNECT, such properties may include port name, IP address, etc. You should check if the device is already connected, and if this is true, then you must define the remainder of the the properties to the client in this function. Otherwise, the remainder of the driver's properties are defined to the client in updateProperties() function which is called when a client connects/disconnects from a device.

Parameters

dev	name of the device

Note: This function is called by the INDI framework, do not call it directly. See LX200 Generic driver for an example implementation

Reimplemented from INDI::DefaultDevice.

Reimplemented in FLICFW, QFW, and TruTech.

◆ ISNewNumber() [1/2]

virtual bool INDI::FilterWheel::ISNewNumber	(	const char *	dev,
		const char *	name,
		double	values[],
		char *	names[],
		int	n
	)

virtual

Process the client newNumber command.

Note: This function is called by the INDI framework, do not call it directly.

Returns: True if any property was successfully processed, false otherwise.

Reimplemented from INDI::DefaultDevice.

Reimplemented in XAGYLWheel, and TruTech.

◆ ISNewNumber() [2/2]

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

virtual

Process the client newNumber command.

Note: This function is called by the INDI framework, do not call it directly.

Returns: True if any property was successfully processed, false otherwise.

Reimplemented from INDI::DefaultDevice.

Reimplemented in XAGYLWheel, and TruTech.

◆ ISNewSwitch() [1/2]

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

virtual

Process the client newSwitch command.

Note: This function is called by the INDI framework, do not call it directly.

Returns: True if any property was successfully processed, false otherwise.

Reimplemented from INDI::DefaultDevice.

Reimplemented in FilterIFW, XAGYLWheel, FLICFW, and TruTech.

◆ ISNewSwitch() [2/2]

virtual bool INDI::FilterWheel::ISNewSwitch	(	const char *	dev,
		const char *	name,
		ISState *	states,
		char *	names[],
		int	n
	)

virtual

Process the client newSwitch command.

Note: This function is called by the INDI framework, do not call it directly.

Returns: True if any property was successfully processed, false otherwise.

Reimplemented from INDI::DefaultDevice.

Reimplemented in FilterIFW, XAGYLWheel, FLICFW, and TruTech.

◆ ISNewText() [1/2]

virtual bool INDI::FilterWheel::ISNewText	(	const char *	dev,
		const char *	name,
		char *	texts[],
		char *	names[],
		int	n
	)

virtual

Process the client newSwitch command.

Note: This function is called by the INDI framework, do not call it directly.

Returns: True if any property was successfully processed, false otherwise.

Reimplemented from INDI::DefaultDevice.

Reimplemented in FilterIFW.

◆ ISNewText() [2/2]

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

virtual

Process the client newSwitch command.

Note: This function is called by the INDI framework, do not call it directly.

Returns: True if any property was successfully processed, false otherwise.

Reimplemented from INDI::DefaultDevice.

Reimplemented in FilterIFW.

◆ ISSnoopDevice() [1/2]

bool FilterWheel::ISSnoopDevice ( XMLEle * root )

virtual

Process a snoop event from INDI server.

This function is called when a snooped property is updated in a snooped driver.

Note: This function is called by the INDI framework, do not call it directly.

Returns: True if any property was successfully processed, false otherwise.

Reimplemented from INDI::DefaultDevice.

◆ ISSnoopDevice() [2/2]

virtual bool INDI::FilterWheel::ISSnoopDevice ( XMLEle * root )

virtual

Process a snoop event from INDI server.

This function is called when a snooped property is updated in a snooped driver.

Note: This function is called by the INDI framework, do not call it directly.

Returns: True if any property was successfully processed, false otherwise.

Reimplemented from INDI::DefaultDevice.

◆ joystickHelper() [1/2]

static void INDI::FilterWheel::joystickHelper	(	const char *	joystick_n,
		double	mag,
		double	angle,
		void *	context
	)

static

◆ joystickHelper() [2/2]

void FilterWheel::joystickHelper	(	const char *	joystick_n,
		double	mag,
		double	angle,
		void *	context
	)

static

◆ processButton() [1/2]

void FilterWheel::processButton	(	const char *	button_n,
		ISState	state
	)

protected

◆ processButton() [2/2]

void INDI::FilterWheel::processButton	(	const char *	button_n,
		ISState	state
	)

protected

◆ processJoystick() [1/2]

void INDI::FilterWheel::processJoystick	(	const char *	joystick_n,
		double	mag,
		double	angle
	)

protected

◆ processJoystick() [2/2]

void FilterWheel::processJoystick	(	const char *	joystick_n,
		double	mag,
		double	angle
	)

protected

◆ QueryFilter() [1/2]

virtual int INDI::FilterWheel::QueryFilter ( )

protectedvirtual

Return current filter position.

Implements INDI::FilterInterface.

Reimplemented in FLICFW, SXWHEEL, ASIWHEEL, and QFW.

◆ QueryFilter() [2/2]

int FilterWheel::QueryFilter ( )

protectedvirtual

Return current filter position.

Implements INDI::FilterInterface.

Reimplemented in FLICFW, SXWHEEL, ASIWHEEL, and QFW.

◆ saveConfigItems() [1/2]

bool FilterWheel::saveConfigItems ( FILE * fp )

protectedvirtual

saveConfigItems Save specific properties in the provide config file handler.

Child class usually override this function to save their own properties and the base class saveConfigItems(fp) must be explicitly called by each child class. The Default Device saveConfigItems(fp) only save Debug properties options in the config file.

Parameters

fp	Pointer to config file handler

Returns: True if successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

Reimplemented in FilterIFW, and XAGYLWheel.

◆ saveConfigItems() [2/2]

virtual bool INDI::FilterWheel::saveConfigItems ( FILE * fp )

protectedvirtual

saveConfigItems Save specific properties in the provide config file handler.

Child class usually override this function to save their own properties and the base class saveConfigItems(fp) must be explicitly called by each child class. The Default Device saveConfigItems(fp) only save Debug properties options in the config file.

Parameters

fp	Pointer to config file handler

Returns: True if successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

Reimplemented in FilterIFW, and XAGYLWheel.

◆ SelectFilter() [1/2]

virtual bool INDI::FilterWheel::SelectFilter ( int position )

protectedvirtual

Select a new filter position.

Returns: True if operation is successful, false otherwise

Implements INDI::FilterInterface.

Reimplemented in FilterIFW, XAGYLWheel, SXWHEEL, FLICFW, ASIWHEEL, QFW, TruTech, and FilterSim.

◆ SelectFilter() [2/2]

bool FilterWheel::SelectFilter ( int position )

protectedvirtual

Select a new filter position.

Returns: True if operation is successful, false otherwise

Implements INDI::FilterInterface.

Reimplemented in FilterIFW, XAGYLWheel, SXWHEEL, FLICFW, ASIWHEEL, QFW, TruTech, and FilterSim.

◆ setFilterConnection() [1/2]

void FilterWheel::setFilterConnection ( const uint8_t & value )

setFilterConnection Set Filter connection mode.

Child class should call this in the constructor before Filter registers any connection interfaces

Parameters

value ORed combination of FilterConnection values.

◆ setFilterConnection() [2/2]

void INDI::FilterWheel::setFilterConnection ( const uint8_t & value )

setFilterConnection Set Filter connection mode.

Child class should call this in the constructor before Filter registers any connection interfaces

Parameters

value ORed combination of FilterConnection values.

◆ updateProperties() [1/2]

virtual bool INDI::FilterWheel::updateProperties ( )

virtual

updateProperties is called whenever there is a change in the CONNECTION status of the driver.

This will enable the driver to react to changes of switching ON/OFF a device. For example, a driver may only define a set of properties after a device is connected, but not before.

Returns: True if update is successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

Reimplemented in FilterIFW, XAGYLWheel, FLICFW, and TruTech.

◆ updateProperties() [2/2]

bool FilterWheel::updateProperties ( )

virtual

updateProperties is called whenever there is a change in the CONNECTION status of the driver.

This will enable the driver to react to changes of switching ON/OFF a device. For example, a driver may only define a set of properties after a device is connected, but not before.

Returns: True if update is successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

Reimplemented in FilterIFW, XAGYLWheel, FLICFW, and TruTech.

Member Data Documentation

◆ controller

Controller * FilterWheel::controller

protected

◆ FilterConnection [1/2]

enum { ... } INDI::FilterWheel::FilterConnection

◆ FilterConnection [2/2]

enum { ... } INDI::FilterWheel::FilterConnection

◆ filterConnection

uint8_t FilterWheel::filterConnection = CONNECTION_NONE

private

◆ PortFD

int FilterWheel::PortFD = -1

protected

For Serial & TCP connections.

◆ serialConnection

Connection::Serial * FilterWheel::serialConnection = NULL

protected

◆ tcpConnection

Connection::TCP * FilterWheel::tcpConnection = NULL

protected

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

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ FilterWheel() [1/2]

◆ ~FilterWheel() [1/2]

◆ FilterWheel() [2/2]

◆ ~FilterWheel() [2/2]

Member Function Documentation

◆ buttonHelper() [1/2]

◆ buttonHelper() [2/2]

◆ callHandshake() [1/2]

◆ callHandshake() [2/2]

◆ getFilterConnection() [1/2]

◆ getFilterConnection() [2/2]

◆ Handshake() [1/2]

◆ Handshake() [2/2]

◆ initProperties() [1/2]

◆ initProperties() [2/2]

◆ ISGetProperties() [1/2]

◆ ISGetProperties() [2/2]

◆ ISNewNumber() [1/2]

◆ ISNewNumber() [2/2]

◆ ISNewSwitch() [1/2]

◆ ISNewSwitch() [2/2]

◆ ISNewText() [1/2]

◆ ISNewText() [2/2]

◆ ISSnoopDevice() [1/2]

◆ ISSnoopDevice() [2/2]

◆ joystickHelper() [1/2]

◆ joystickHelper() [2/2]

◆ processButton() [1/2]

◆ processButton() [2/2]

◆ processJoystick() [1/2]

◆ processJoystick() [2/2]

◆ QueryFilter() [1/2]

◆ QueryFilter() [2/2]

◆ saveConfigItems() [1/2]

◆ saveConfigItems() [2/2]

◆ SelectFilter() [1/2]

◆ SelectFilter() [2/2]

◆ setFilterConnection() [1/2]

◆ setFilterConnection() [2/2]

◆ updateProperties() [1/2]

◆ updateProperties() [2/2]

Member Data Documentation

◆ controller

◆ FilterConnection [1/2]

◆ FilterConnection [2/2]

◆ filterConnection

◆ PortFD

◆ serialConnection

◆ tcpConnection