Instrument Neutral Distributed Interface INDI  1.5.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
INDI::FilterWheel Class Reference

Class to provide general functionality of a filter wheel device. More...

#include <indifilterwheel.h>

Inheritance diagram for INDI::FilterWheel:
INDI::DefaultDevice INDI::FilterInterface INDI::BaseDevice FilterIFW FilterSim QFW TruTech XAGYLWheel

Public Types

- Public Types inherited from INDI::BaseDevice

Public Member Functions

virtual bool initProperties ()
 Initilize properties initial state and value. The child class must implement this function. More...
 
virtual bool updateProperties ()
 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. More...
 
virtual void ISGetProperties (const char *dev)
 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. More...
 
virtual bool ISSnoopDevice (XMLEle *root)
 Process a snoop event from INDI server. This function is called when a snooped property is updated in a snooped driver. 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. Child class should call this in the constructor before INDI::Filter registers any connection interfaces 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 resetProperties ()
 Set all properties to IDLE state. More...
 
void defineNumber (INumberVectorProperty *nvp)
 Define number vector to client & register it. Alternatively, IDDefNumber can be used but the property will not get registered and the driver will not be able to save configuration files. More...
 
void defineText (ITextVectorProperty *tvp)
 Define text vector to client & register it. Alternatively, IDDefText can be used but the property will not get registered and the driver will not be able to save configuration files. More...
 
void defineSwitch (ISwitchVectorProperty *svp)
 Define switch vector to client & register it. Alternatively, IDDefswitch can be used but the property will not get registered and the driver will not be able to save configuration files. More...
 
void defineLight (ILightVectorProperty *lvp)
 Define light vector to client & register it. Alternatively, IDDeflight can be used but the property will not get registered and the driver will not be able to save configuration files. More...
 
void defineBLOB (IBLOBVectorProperty *bvp)
 Define BLOB vector to client & register it. Alternatively, IDDefBLOB can be used but the property will not get registered and the driver will not be able to save configuration files. More...
 
virtual bool deleteProperty (const char *propertyName)
 Delete a property and unregister it. It will also be deleted from all clients. More...
 
virtual void setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr)
 Set connection switch status in the client. More...
 
int SetTimer (int 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. By default the driver interface is set to GENERAL_DEVICE. You may send an ORed list of DeviceInterface values. More...
 
- Public Member Functions inherited from INDI::BaseDevice
 BaseDevice ()
 
virtual ~BaseDevice ()
 
INumberVectorPropertygetNumber (const char *name)
 
ITextVectorPropertygetText (const char *name)
 
ISwitchVectorPropertygetSwitch (const char *name)
 
ILightVectorPropertygetLight (const char *name)
 
IBLOBVectorPropertygetBLOB (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::PropertygetProperty (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::BaseMediatorgetMediator ()
 
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...
 

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)
 

Public Attributes

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

Protected Member Functions

 FilterWheel ()
 
virtual ~FilterWheel ()
 
virtual bool saveConfigItems (FILE *fp)
 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. More...
 
virtual int QueryFilter ()
 Return current filter position. More...
 
virtual bool SelectFilter (int)
 Select a new filter position. More...
 
virtual bool SetFilterNames ()
 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. More...
 
virtual bool GetFilterNames (const char *groupName)
 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. 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. Dyanmic properties are those generated from an external skeleton XML file. By default all properties, including dynamic properties, are defined to the client in ISGetProperties(). Furthermore, when ┼▒deleteProperty(properyName) is called, the dynamic property is deleted by default, and can only be restored by calling buildSkeleton(filename) again. However, it is sometimes desirable to skip the definition of the dynamic properties on startup and delegate this task to the child class. To control this behavior, set enabled to false. 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. This function is called after setDebug is triggered by the client. Reimplement this function if your driver needs to take specific action after debug is enabled/disabled. Otherwise, you can use isDebug() to check if simulation is enabled or disabled. More...
 
virtual void simulationTriggered (bool enable)
 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. More...
 
bool isDebug ()
 
bool isSimulation ()
 
virtual bool Connect ()
 Connect to the device. INDI::DefaultDevice implementation connects to appropriate connection interface (Serial or TCP) governed by connectionMode. If connection is successful, it proceed to call Handshake() function to ensure communication with device is successful. For other communication interface, override the method in the child class implementation. More...
 
virtual bool Disconnect ()
 Disconnect from device. More...
 
void registerConnection (Connection::Interface *newConnection)
 registerConnection Add new connection plugin to the existing connection pool. The connection type shall be defined to the client in ISGetProperties() More...
 
bool unRegisterConnection (Connection::Interface *existingConnection)
 unRegisterConnection Remove connection from existing pool More...
 
Connection::InterfacegetActiveConnection ()
 
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...
 
- Protected Member Functions inherited from INDI::FilterInterface
 FilterInterface ()
 
 ~FilterInterface ()
 
void initFilterProperties (const char *deviceName, const char *groupName)
 Initilize filter wheel properties. It is recommended to call this function within initProperties() of your primary device. More...
 
void processFilterSlot (const char *deviceName, double values[], char *names[])
 Process client request to change filter position. Call this function in the filter wheel implementation class ISNewNumber function. More...
 
void processFilterName (const char *deviceName, char *texts[], char *names[], int n)
 Process client request to change filter name(s). Call this function in the filter wheel implementation class ISNewText() function. More...
 

Protected Attributes

INDI::Controllercontroller
 
Connection::SerialserialConnection = NULL
 
Connection::TCPtcpConnection = NULL
 
int PortFD = -1
 For Serial & TCP connections. More...
 
- Protected Attributes inherited from INDI::DefaultDevice
uint32_t updatePeriodMS = 1000
 Period in milliseconds to call TimerHit(). Default 1000 ms. More...
 
- Protected Attributes inherited from INDI::FilterInterface
INumberVectorProperty FilterSlotNP
 
INumber FilterSlotN [1]
 
ITextVectorPropertyFilterNameTP
 
ITextFilterNameT
 
int CurrentFilter
 
int TargetFilter
 

Detailed Description

Class to provide general functionality of a filter wheel device.

Developers need to subclass INDI::FilterWheel to implement any driver for filter wheels within INDI.

Author
Gerry Rozema, Jasem Mutlaq
See also
INDI::FilterInterface

Definition at line 33 of file indifilterwheel.h.

Member Enumeration Documentation

anonymous enum
Enumerator
CONNECTION_NONE 
CONNECTION_SERIAL 

Do not use any connection plugin

CONNECTION_TCP 

For regular serial and bluetooth connections

Definition at line 44 of file indifilterwheel.h.

Constructor & Destructor Documentation

INDI::FilterWheel::FilterWheel ( )
protected

Definition at line 27 of file indifilterwheel.cpp.

INDI::FilterWheel::~FilterWheel ( )
protectedvirtual

Definition at line 35 of file indifilterwheel.cpp.

Member Function Documentation

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

Definition at line 208 of file indifilterwheel.cpp.

uint8_t INDI::FilterWheel::getFilterConnection ( ) const
Returns
Get current Filter connection mode
bool INDI::FilterWheel::GetFilterNames ( const char *  groupName)
protectedvirtual

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.

Parameters
groupNamegroup name for FilterNameTP property to be created.
Returns
True if successful, false if unsupported or failed operation
See also
QSI CCD implementation of the FilterInterface. QSI CCD is available as a 3rd party INDI driver.

Implements INDI::FilterInterface.

Reimplemented in FilterIFW, XAGYLWheel, TruTech, QFW, and FilterSim.

Definition at line 190 of file indifilterwheel.cpp.

bool INDI::FilterWheel::Handshake ( )
protectedvirtual

perform handshake with device to check communication

Reimplemented in FilterIFW, XAGYLWheel, TruTech, and QFW.

Definition at line 260 of file indifilterwheel.cpp.

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, QFW, and TruTech.

Definition at line 40 of file indifilterwheel.cpp.

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
devname 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 QFW.

Definition at line 71 of file indifilterwheel.cpp.

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.

Definition at line 123 of file indifilterwheel.cpp.

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, and TruTech.

Definition at line 117 of file indifilterwheel.cpp.

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.

Definition at line 143 of file indifilterwheel.cpp.

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.

Definition at line 196 of file indifilterwheel.cpp.

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

Definition at line 203 of file indifilterwheel.cpp.

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

Definition at line 246 of file indifilterwheel.cpp.

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

Definition at line 213 of file indifilterwheel.cpp.

int INDI::FilterWheel::QueryFilter ( )
protectedvirtual

Return current filter position.

Implements INDI::FilterInterface.

Reimplemented in QFW.

Definition at line 175 of file indifilterwheel.cpp.

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
fpPointer to config file handler
Returns
True if successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

Reimplemented in FilterIFW.

Definition at line 163 of file indifilterwheel.cpp.

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, QFW, TruTech, and FilterSim.

Definition at line 180 of file indifilterwheel.cpp.

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

setFilterConnection Set Filter connection mode. Child class should call this in the constructor before INDI::Filter registers any connection interfaces

Parameters
valueORed combination of FilterConnection values.

Definition at line 278 of file indifilterwheel.cpp.

bool INDI::FilterWheel::SetFilterNames ( )
protectedvirtual

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.

Returns
True if successful, false if supported or failed operation

Implements INDI::FilterInterface.

Reimplemented in FilterIFW, XAGYLWheel, TruTech, QFW, and FilterSim.

Definition at line 185 of file indifilterwheel.cpp.

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, and TruTech.

Definition at line 91 of file indifilterwheel.cpp.

Member Data Documentation

INDI::Controller* INDI::FilterWheel::controller
protected

Definition at line 87 of file indifilterwheel.h.

enum { ... } INDI::FilterWheel::FilterConnection
int INDI::FilterWheel::PortFD = -1
protected

For Serial & TCP connections.

Definition at line 93 of file indifilterwheel.h.

Connection::Serial* INDI::FilterWheel::serialConnection = NULL
protected

Definition at line 89 of file indifilterwheel.h.

Connection::TCP* INDI::FilterWheel::tcpConnection = NULL
protected

Definition at line 90 of file indifilterwheel.h.


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