#include <ifwoptec.h>

Inheritance diagram for FilterIFW:

Collaboration diagram for FilterIFW:

Public Member Functions
	FilterIFW ()

virtual	~FilterIFW ()=default

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

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

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

Public Member Functions inherited from INDI::FilterWheel
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	ISNewNumber (const char dev, const char name, double values[], char *names[], int n)
	Process the client newNumber command. More...

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

uint8_t	getFilterConnection () const

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	ISNewNumber (const char dev, const char name, double values[], char *names[], int n)
	Process the client newNumber 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 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 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
void	SelectFilterDone (int newpos)
	The child class calls this function when the hardware successfully finished selecting a new filter wheel position. More...

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

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

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

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

bool	WriteTTY (char *command)

bool	ReadTTY (char resp, char simulation, int timeout)

virtual const char *	getDefaultName () override

bool	moveHome ()

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

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

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

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

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

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

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

bool	GetWheelID ()

int	GetFilterPos ()

bool	GetFirmware ()

Protected Member Functions inherited from INDI::FilterWheel
	FilterWheel ()

virtual	~FilterWheel ()=default

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

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

void	processButton (const char *button_n, ISState state)

	FilterWheel ()

virtual	~FilterWheel ()=default

virtual int	QueryFilter ()
	Return current filter position. 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	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...

bool	isDebug ()

bool	isSimulation ()

virtual bool	Connect ()
	Connect to the 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 ()

void	setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled)
	setDynamicPropertiesBehavior controls handling of dynamic properties. 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...

bool	isDebug ()

bool	isSimulation ()

virtual bool	Connect ()
	Connect to the 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 ()

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
ITextVectorProperty	WheelIDTP

IText	WheelIDT [1] {}

ISwitchVectorProperty	HomeSP

ISwitch	HomeS [1]

ISwitchVectorProperty	FilterNbrSP

ISwitch	FilterNbrS [4]

ISwitchVectorProperty	CharSetSP

ISwitch	CharSetS [2]

ITextVectorProperty	FirmwareTP

IText	FirmwareT [1] {}

int	actualSimFilter { 1 }

char	filterSim [OPTEC_MAXLEN_NAMES+1]

Protected Attributes inherited from INDI::FilterWheel
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 }

Additional Inherited Members
Public Types inherited from INDI::FilterWheel
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...

Static Public Member Functions inherited from INDI::FilterWheel
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 inherited from INDI::FilterWheel
enum INDI::FilterWheel:: { ... }	FilterConnection

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

Constructor & Destructor Documentation

◆ FilterIFW()

FilterIFW::FilterIFW ( )

◆ ~FilterIFW()

virtual FilterIFW::~FilterIFW ( )

virtualdefault

Member Function Documentation

◆ Disconnect()

bool FilterIFW::Disconnect ( )

overrideprotectedvirtual

Disconnect from device.

Returns: True if successful, false otherwise

Reimplemented from INDI::DefaultDevice.

◆ getDefaultName()

const char * FilterIFW::getDefaultName ( )

overrideprotectedvirtual

Returns: Default name of the device.

Implements INDI::DefaultDevice.

◆ GetFilterNames()

bool FilterIFW::GetFilterNames ( )

overrideprotectedvirtual

Obtains a list of filter names from the hardware and initializes the FilterNameTP property.

The function should check for the number of filters available in the filter wheel and build the FilterNameTP property accordingly. The default implementation loads the filter names from configuration file.

Returns: True if successful, false if unsupported or failed operation

Reimplemented from INDI::FilterInterface.

◆ GetFilterPos()

int FilterIFW::GetFilterPos ( )

protected

◆ GetFirmware()

bool FilterIFW::GetFirmware ( )

protected

◆ GetWheelID()

bool FilterIFW::GetWheelID ( )

protected

◆ Handshake()

bool FilterIFW::Handshake ( )

overrideprotectedvirtual

perform handshake with device to check communication

Reimplemented from INDI::FilterWheel.

◆ initProperties()

bool FilterIFW::initProperties ( )

overridevirtual

Initilize properties initial state and value.

The child class must implement this function.

Returns: True if initilization is successful, false otherwise.

Reimplemented from INDI::FilterWheel.

◆ ISNewSwitch()

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

overridevirtual

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::FilterWheel.

◆ ISNewText()

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

overridevirtual

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::FilterWheel.

◆ loadConfig()

bool FilterIFW::loadConfig	(	bool	silent = `false`,
		const char *	property = `nullptr`
	)

overrideprotectedvirtual

Load the last saved configuration file.

Parameters

silent	if true, don't report any error or notification messages.
property	Name of property to load configuration for. If nullptr, all properties in the configuration file are loaded which is the default behavior.

Returns: True if successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

◆ moveHome()

bool FilterIFW::moveHome ( )

protected

◆ ReadTTY()

bool FilterIFW::ReadTTY	(	char *	resp,
		char *	simulation,
		int	timeout
	)

protected

◆ saveConfigItems()

bool FilterIFW::saveConfigItems ( FILE * fp )

overrideprotectedvirtual

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::FilterWheel.

◆ SelectFilter()

bool FilterIFW::SelectFilter ( int position )

overrideprotectedvirtual

Select a new filter position.

Returns: True if operation is successful, false otherwise

Reimplemented from INDI::FilterWheel.

◆ SetFilterNames()

bool FilterIFW::SetFilterNames ( )

overrideprotectedvirtual

Set filter names as defined by the client for each filter position.

The desired filter names are stored in FilterNameTP property. Filter names should be saved in hardware if possible. The default implementation saves them in the configuration file.

Returns: True if successful, false if supported or failed operation

Reimplemented from INDI::FilterInterface.

◆ simulationTriggered()

void FilterIFW::simulationTriggered ( bool enable )

overrideprotectedvirtual

Inform driver that the simulation option was triggered.

This function is called after setSimulation is triggered by the client. Reimplement this function if your driver needs to take specific action after simulation is enabled/disabled. Otherwise, you can use isSimulation() to check if simulation is enabled or disabled.

Parameters

enable If true, the simulation option is set to ON.

Reimplemented from INDI::DefaultDevice.

◆ TimerHit()

void FilterIFW::TimerHit ( )

overrideprotectedvirtual

Callback function to be called once SetTimer duration elapses.

Reimplemented from INDI::DefaultDevice.

◆ updateProperties()

bool FilterIFW::updateProperties ( )

overrideprotectedvirtual

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::FilterWheel.

◆ WriteTTY()

bool FilterIFW::WriteTTY ( char * command )

protected

Member Data Documentation

◆ actualSimFilter

int FilterIFW::actualSimFilter { 1 }

protected

◆ CharSetS

ISwitch FilterIFW::CharSetS[2]

protected

◆ CharSetSP

ISwitchVectorProperty FilterIFW::CharSetSP

protected

◆ FilterNbrS

ISwitch FilterIFW::FilterNbrS[4]

protected

◆ FilterNbrSP

ISwitchVectorProperty FilterIFW::FilterNbrSP

protected

◆ filterSim

char FilterIFW::filterSim[OPTEC_MAXLEN_NAMES+1]

protected

◆ FirmwareT

IText FilterIFW::FirmwareT[1] {}

protected

◆ FirmwareTP

ITextVectorProperty FilterIFW::FirmwareTP

protected

◆ HomeS

ISwitch FilterIFW::HomeS[1]

protected

◆ HomeSP

ISwitchVectorProperty FilterIFW::HomeSP

protected

◆ WheelIDT

IText FilterIFW::WheelIDT[1] {}

protected

◆ WheelIDTP

ITextVectorProperty FilterIFW::WheelIDTP

protected

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

ln/3rdparty/src/indilib/indi-1.7.4/libindi/drivers/filter_wheel/ifwoptec.h
ln/3rdparty/src/indilib/indi-1.7.4/libindi/drivers/filter_wheel/ifwoptec.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ FilterIFW()

◆ ~FilterIFW()

Member Function Documentation

◆ Disconnect()

◆ getDefaultName()

◆ GetFilterNames()

◆ GetFilterPos()

◆ GetFirmware()

◆ GetWheelID()

◆ Handshake()

◆ initProperties()

◆ ISNewSwitch()

◆ ISNewText()

◆ loadConfig()

◆ moveHome()

◆ ReadTTY()

◆ saveConfigItems()

◆ SelectFilter()

◆ SetFilterNames()

◆ simulationTriggered()

◆ TimerHit()

◆ updateProperties()

◆ WriteTTY()

Member Data Documentation

◆ actualSimFilter

◆ CharSetS

◆ CharSetSP

◆ FilterNbrS

◆ FilterNbrSP

◆ filterSim

◆ FirmwareT

◆ FirmwareTP

◆ HomeS

◆ HomeSP

◆ WheelIDT

◆ WheelIDTP