Instrument Neutral Distributed Interface INDI  1.6.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FilterIFW Class Reference

#include <ifwoptec.h>

Inheritance diagram for FilterIFW:
INDI::FilterWheel INDI::DefaultDevice INDI::FilterInterface INDI::BaseDevice

Public Member Functions

 FilterIFW ()
 
virtual ~FilterIFW ()=default
 
virtual bool initProperties () override
 Initilize properties initial state and value. The child class must implement this function. 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. 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 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. Child class should call this in the constructor before 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 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...
 

Protected Member Functions

virtual bool updateProperties () override
 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 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. 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 void simulationTriggered (bool enable) override
 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...
 
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. 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. More...
 
virtual bool GetFilterNames () override
 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. 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)
 
- 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 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...
 
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...
 
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 ()
 
- 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 (DefaultDevice *defaultDevice)
 FilterInterface Initiailize Filter Interface. More...
 
 ~FilterInterface ()
 
void initProperties (const char *groupName)
 Initilize filter wheel properties. It is recommended to call this function within initProperties() of your primary device. 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
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 { nullptr }
 
ITextFilterNameT
 
int CurrentFilter
 
int TargetFilter
 
bool loadingFromConfig = false
 
DefaultDevicem_defaultDevice { nullptr }
 

Additional Inherited Members

- Public Types inherited from INDI::FilterWheel
- Public Types inherited from INDI::BaseDevice
- 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)
 
- Public Attributes inherited from INDI::FilterWheel
enum INDI::FilterWheel:: { ... }  FilterConnection
 

Detailed Description

Definition at line 76 of file ifwoptec.h.

Constructor & Destructor Documentation

FilterIFW::FilterIFW ( )

Definition at line 110 of file ifwoptec.cpp.

virtual FilterIFW::~FilterIFW ( )
virtualdefault

Member Function Documentation

bool FilterIFW::Disconnect ( )
overrideprotectedvirtual

Disconnect from device.

Returns
True if successful, false otherwise

Reimplemented from INDI::DefaultDevice.

Definition at line 312 of file ifwoptec.cpp.

const char * FilterIFW::getDefaultName ( )
overrideprotectedvirtual
Returns
Default name of the device.

Implements INDI::DefaultDevice.

Definition at line 129 of file ifwoptec.cpp.

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.

Definition at line 599 of file ifwoptec.cpp.

int FilterIFW::GetFilterPos ( )
protected

Definition at line 872 of file ifwoptec.cpp.

bool FilterIFW::GetFirmware ( )
protected

Definition at line 972 of file ifwoptec.cpp.

bool FilterIFW::GetWheelID ( )
protected

Definition at line 825 of file ifwoptec.cpp.

bool FilterIFW::Handshake ( )
overrideprotectedvirtual

perform handshake with device to check communication

Reimplemented from INDI::FilterWheel.

Definition at line 279 of file ifwoptec.cpp.

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.

Definition at line 137 of file ifwoptec.cpp.

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.

Definition at line 394 of file ifwoptec.cpp.

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.

Definition at line 345 of file ifwoptec.cpp.

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

Load the last saved configuration file.

Parameters
silentif true, don't report any error or notification messages.
propertyName 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.

Definition at line 1044 of file ifwoptec.cpp.

bool FilterIFW::moveHome ( )
protected

Definition at line 918 of file ifwoptec.cpp.

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

Definition at line 239 of file ifwoptec.cpp.

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

Reimplemented from INDI::FilterWheel.

Definition at line 1031 of file ifwoptec.cpp.

bool FilterIFW::SelectFilter ( int  position)
overrideprotectedvirtual

Select a new filter position.

Returns
True if operation is successful, false otherwise

Reimplemented from INDI::FilterWheel.

Definition at line 519 of file ifwoptec.cpp.

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.

Definition at line 727 of file ifwoptec.cpp.

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
enableIf true, the simulation option is set to ON.

Reimplemented from INDI::DefaultDevice.

Definition at line 494 of file ifwoptec.cpp.

void FilterIFW::TimerHit ( )
overrideprotectedvirtual

Callback function to be called once SetTimer duration elapses.

Reimplemented from INDI::DefaultDevice.

Definition at line 511 of file ifwoptec.cpp.

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.

Definition at line 179 of file ifwoptec.cpp.

bool FilterIFW::WriteTTY ( char *  command)
protected

Definition at line 214 of file ifwoptec.cpp.

Member Data Documentation

int FilterIFW::actualSimFilter { 1 }
protected

Definition at line 127 of file ifwoptec.h.

ISwitch FilterIFW::CharSetS[2]
protected

Definition at line 120 of file ifwoptec.h.

ISwitchVectorProperty FilterIFW::CharSetSP
protected

Definition at line 119 of file ifwoptec.h.

ISwitch FilterIFW::FilterNbrS[4]
protected

Definition at line 116 of file ifwoptec.h.

ISwitchVectorProperty FilterIFW::FilterNbrSP
protected

Definition at line 115 of file ifwoptec.h.

char FilterIFW::filterSim[OPTEC_MAXLEN_NAMES+1]
protected

Definition at line 130 of file ifwoptec.h.

IText FilterIFW::FirmwareT[1]
protected

Definition at line 124 of file ifwoptec.h.

ITextVectorProperty FilterIFW::FirmwareTP
protected

Definition at line 123 of file ifwoptec.h.

ISwitch FilterIFW::HomeS[1]
protected

Definition at line 112 of file ifwoptec.h.

ISwitchVectorProperty FilterIFW::HomeSP
protected

Definition at line 111 of file ifwoptec.h.

IText FilterIFW::WheelIDT[1]
protected

Definition at line 108 of file ifwoptec.h.

ITextVectorProperty FilterIFW::WheelIDTP
protected

Definition at line 107 of file ifwoptec.h.


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