#include <indifilterinterface.h>
|
virtual int | QueryFilter ()=0 |
| Return current filter position. More...
|
|
virtual bool | SelectFilter (int position)=0 |
| 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. The default implementation saves them in the configuration file. More...
|
|
virtual bool | GetFilterNames () |
| 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...
|
|
void | SelectFilterDone (int newpos) |
| The child class calls this function when the hardware successfully finished selecting a new filter wheel position. More...
|
|
Definition at line 45 of file indifilterinterface.h.
◆ FilterInterface()
FilterInterface::FilterInterface |
( |
DefaultDevice * |
defaultDevice | ) |
|
|
explicitprotected |
◆ ~FilterInterface()
FilterInterface::~FilterInterface |
( |
| ) |
|
|
protected |
◆ generateSampleFilters()
void FilterInterface::generateSampleFilters |
( |
| ) |
|
|
protected |
generateSampleFilters Generate sample 8-filter wheel and fill it sample filters
Definition at line 191 of file indifilterinterface.cpp.
◆ GetFilterNames()
bool FilterInterface::GetFilterNames |
( |
| ) |
|
|
virtual |
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 in FilterIFW.
Definition at line 220 of file indifilterinterface.cpp.
◆ initProperties()
void FilterInterface::initProperties |
( |
const char * |
groupName | ) |
|
|
protected |
Initilize filter wheel properties. It is recommended to call this function within initProperties() of your primary device.
- Parameters
-
groupName | Group or tab name to be used to define filter wheel properties. |
Definition at line 39 of file indifilterinterface.cpp.
◆ processNumber()
bool FilterInterface::processNumber |
( |
const char * |
dev, |
|
|
const char * |
name, |
|
|
double |
values[], |
|
|
char * |
names[], |
|
|
int |
n |
|
) |
| |
|
protected |
◆ processText()
bool FilterInterface::processText |
( |
const char * |
dev, |
|
|
const char * |
name, |
|
|
char * |
texts[], |
|
|
char * |
names[], |
|
|
int |
n |
|
) |
| |
|
protected |
◆ QueryFilter()
virtual int INDI::FilterInterface::QueryFilter |
( |
| ) |
|
|
pure virtual |
◆ saveConfigItems()
bool FilterInterface::saveConfigItems |
( |
FILE * |
fp | ) |
|
|
protected |
saveConfigItems save Filter Names in config file
- Parameters
-
- Returns
- Always return true
Definition at line 171 of file indifilterinterface.cpp.
◆ SelectFilter()
virtual bool INDI::FilterInterface::SelectFilter |
( |
int |
position | ) |
|
|
pure virtual |
Select a new filter position.
- Returns
- True if operation is successful, false otherwise
Implemented in INDI::FilterWheel, XAGYLWheel, TruTech, QHYCFW3, QHYCFW2, QHYCFW1, PegasusINDIGO, ManualFilter, FilterIFW, CCDSim, QFW, and FilterSim.
◆ SelectFilterDone()
void FilterInterface::SelectFilterDone |
( |
int |
newpos | ) |
|
The child class calls this function when the hardware successfully finished selecting a new filter wheel position.
- Parameters
-
newpos | New position of the filter wheel |
Definition at line 180 of file indifilterinterface.cpp.
◆ SetFilterNames()
bool FilterInterface::SetFilterNames |
( |
| ) |
|
|
virtual |
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 in FilterIFW.
Definition at line 240 of file indifilterinterface.cpp.
◆ updateProperties()
bool FilterInterface::updateProperties |
( |
| ) |
|
|
protected |
updateProperties Defines or Delete proprties based on default device connection status
- Returns
- True if all is OK, false otherwise.
Definition at line 49 of file indifilterinterface.cpp.
◆ CurrentFilter
int INDI::FilterInterface::CurrentFilter = 1 |
|
protected |
◆ FilterNameT
IText* INDI::FilterInterface::FilterNameT |
|
protected |
◆ FilterNameTP
◆ FilterSlotN
INumber INDI::FilterInterface::FilterSlotN[1] |
|
protected |
◆ FilterSlotNP
◆ loadingFromConfig
bool INDI::FilterInterface::loadingFromConfig = false |
|
protected |
◆ m_defaultDevice
DefaultDevice* INDI::FilterInterface::m_defaultDevice { nullptr } |
|
protected |
◆ TargetFilter
int INDI::FilterInterface::TargetFilter = 1 |
|
protected |
The documentation for this class was generated from the following files: