TwiceAsNice  2019-02-18
Public Types | Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
INDI::Detector Class Reference

Class to provide general functionality of Monodimensional Detector. More...

#include <indidetector.h>

Inheritance diagram for INDI::Detector:
Inheritance graph
Collaboration diagram for INDI::Detector:
Collaboration graph

Public Types

enum  {
  DETECTOR_CAN_ABORT = 1 << 0, DETECTOR_HAS_SHUTTER = 1 << 1, DETECTOR_HAS_COOLER = 1 << 2, DETECTOR_HAS_CONTINUUM = 1 << 3,
  DETECTOR_HAS_SPECTRUM = 1 << 4
}
 
enum  {
  DETECTOR_CAN_ABORT = 1 << 0, DETECTOR_HAS_SHUTTER = 1 << 1, DETECTOR_HAS_COOLER = 1 << 2, DETECTOR_HAS_CONTINUUM = 1 << 3,
  DETECTOR_HAS_SPECTRUM = 1 << 4
}
 
- 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

 Detector ()
 
virtual ~Detector ()
 
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 ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n)
 Process the client newNumber command. More...
 
virtual bool ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n)
 Process the client newSwitch command. More...
 
virtual bool ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n)
 Process the client newSwitch command. More...
 
virtual bool ISSnoopDevice (XMLEle *root)
 Process a snoop event from INDI server. More...
 
 Detector ()
 
virtual ~Detector ()
 
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 ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n)
 Process the client newNumber command. More...
 
virtual bool ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n)
 Process the client newSwitch command. More...
 
virtual bool ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n)
 Process the client newSwitch command. More...
 
virtual bool ISSnoopDevice (XMLEle *root)
 Process a snoop event from INDI server. More...
 
- 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 ()
 
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 ()
 
 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 Attributes

enum INDI::Detector:: { ... }  DetectorCapability
 
enum INDI::Detector:: { ... }  DetectorCapability
 

Protected Types

enum  { UPLOAD_DIR, UPLOAD_PREFIX }
 
enum  { TELESCOPE_PRIMARY }
 
enum  { FITS_OBSERVER, FITS_OBJECT }
 
enum  { UPLOAD_DIR, UPLOAD_PREFIX }
 
enum  { TELESCOPE_PRIMARY }
 
enum  { FITS_OBSERVER, FITS_OBJECT }
 

Protected Member Functions

uint32_t GetDetectorCapability () const
 GetDetectorCapability returns the Detector capabilities. More...
 
void SetDetectorCapability (uint32_t cap)
 SetDetectorCapability Set the Detector capabilities. More...
 
bool CanAbort ()
 
bool HasShutter ()
 
bool HasCooler ()
 
bool HasContinuum ()
 
bool HasSpectrum ()
 
virtual int SetTemperature (double temperature)
 Set Detector temperature. More...
 
virtual bool StartCapture (float duration)
 Start capture from the Detector device. More...
 
virtual bool CaptureParamsUpdated (float sr, float freq, float bps)
 Set common capture params. More...
 
virtual bool CaptureComplete (DetectorDevice *targetDevice)
 Uploads target Device exposed buffer as FITS to the client. More...
 
virtual bool AbortCapture ()
 Abort ongoing Capture. More...
 
virtual void SetDetectorParams (float samplerate, float freq, float bps)
 Setup Detector parameters for the Detector. More...
 
virtual void addFITSKeywords (fitsfile *fptr, DetectorDevice *targetDevice, int blobIndex)
 Add FITS keywords to a fits file. More...
 
void fits_update_key_s (fitsfile *fptr, int type, std::string name, void *p, std::string explanation, int *status)
 A function to just remove GCC warnings about deprecated conversion. More...
 
virtual void activeDevicesUpdated ()
 activeDevicesUpdated Inform children that ActiveDevices property was updated so they can snoop on the updated devices if desired. More...
 
virtual bool saveConfigItems (FILE *fp)
 saveConfigItems Save configuration items in XML file. More...
 
uint32_t GetDetectorCapability () const
 GetDetectorCapability returns the Detector capabilities. More...
 
void SetDetectorCapability (uint32_t cap)
 SetDetectorCapability Set the Detector capabilities. More...
 
bool CanAbort ()
 
bool HasShutter ()
 
bool HasCooler ()
 
bool HasContinuum ()
 
bool HasSpectrum ()
 
virtual int SetTemperature (double temperature)
 Set Detector temperature. More...
 
virtual bool StartCapture (float duration)
 Start capture from the Detector device. More...
 
virtual bool CaptureParamsUpdated (float sr, float freq, float bps)
 Set common capture params. More...
 
virtual bool CaptureComplete (DetectorDevice *targetDevice)
 Uploads target Device exposed buffer as FITS to the client. More...
 
virtual bool AbortCapture ()
 Abort ongoing Capture. More...
 
virtual void SetDetectorParams (float samplerate, float freq, float bps)
 Setup Detector parameters for the Detector. More...
 
virtual void addFITSKeywords (fitsfile *fptr, DetectorDevice *targetDevice, int blobIndex)
 Add FITS keywords to a fits file. More...
 
void fits_update_key_s (fitsfile *fptr, int type, std::string name, void *p, std::string explanation, int *status)
 A function to just remove GCC warnings about deprecated conversion. More...
 
virtual void activeDevicesUpdated ()
 activeDevicesUpdated Inform children that ActiveDevices property was updated so they can snoop on the updated devices if desired. More...
 
virtual bool saveConfigItems (FILE *fp)
 saveConfigItems Save configuration items in XML file. More...
 
- 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::InterfacegetActiveConnection ()
 
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::InterfacegetActiveConnection ()
 
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 Attributes

double RA
 
double Dec
 
double primaryAperture
 
double primaryFocalLength
 
bool InCapture
 
bool AutoLoop
 
bool SendCapture
 
bool ShowMarker
 
float CaptureTime
 
double MPSAS
 
std::vector< std::string > FilterNames
 
int CurrentFilterSlot
 
DetectorDevice PrimaryDetector
 
INumberVectorProperty EqNP
 
INumber EqN [2]
 
ITextVectorProperty ActiveDeviceTP
 
IText ActiveDeviceT [4] {}
 
INumber TemperatureN [1]
 
INumberVectorProperty TemperatureNP
 
IText FileNameT [1] {}
 
ITextVectorProperty FileNameTP
 
ISwitch DatasetS [1]
 
ISwitchVectorProperty DatasetSP
 
ISwitch UploadS [3]
 
ISwitchVectorProperty UploadSP
 
IText UploadSettingsT [2] {}
 
ITextVectorProperty UploadSettingsTP
 
ISwitch TelescopeTypeS [2]
 
ISwitchVectorProperty TelescopeTypeSP
 
IText FITSHeaderT [2] {}
 
ITextVectorProperty FITSHeaderTP
 
- Protected Attributes inherited from INDI::DefaultDevice
uint32_t POLLMS = 1000
 Period in milliseconds to call TimerHit(). Default 1000 ms. More...
 

Private Member Functions

bool uploadFile (DetectorDevice *targetDevice, const void *fitsData, size_t totalBytes, bool sendCapture, bool saveCapture, int blobindex)
 
void getMinMax (double *min, double *max, uint8_t *buf, int len, int bpp)
 
int getFileIndex (const char *dir, const char *prefix, const char *ext)
 
bool uploadFile (DetectorDevice *targetDevice, const void *fitsData, size_t totalBytes, bool sendCapture, bool saveCapture, int blobindex)
 
void getMinMax (double *min, double *max, uint8_t *buf, int len, int bpp)
 
int getFileIndex (const char *dir, const char *prefix, const char *ext)
 

Private Attributes

uint32_t capability
 

Detailed Description

Class to provide general functionality of Monodimensional Detector.

The Detector capabilities must be set to select which features are exposed to the clients. SetDetectorCapability() is typically set in the constructor or initProperties(), but can also be called after connection is established with the Detector, but must be called /em before returning true in Connect().

Developers need to subclass INDI::Detector to implement any driver for Detectors within INDI.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
UPLOAD_DIR 
UPLOAD_PREFIX 

◆ anonymous enum

anonymous enum
protected
Enumerator
TELESCOPE_PRIMARY 

◆ anonymous enum

anonymous enum
protected
Enumerator
FITS_OBSERVER 
FITS_OBJECT 

◆ anonymous enum

anonymous enum
Enumerator
DETECTOR_CAN_ABORT 

Can the Detector Capture be aborted?

DETECTOR_HAS_SHUTTER 

Does the Detector have a mechanical shutter?

DETECTOR_HAS_COOLER 

Does the Detector have a cooler and temperature control?

DETECTOR_HAS_CONTINUUM 

Does the Detector support live streaming?

DETECTOR_HAS_SPECTRUM 

Does the Detector support spectrum analysis?

◆ anonymous enum

anonymous enum
protected
Enumerator
UPLOAD_DIR 
UPLOAD_PREFIX 

◆ anonymous enum

anonymous enum
protected
Enumerator
TELESCOPE_PRIMARY 

◆ anonymous enum

anonymous enum
protected
Enumerator
FITS_OBSERVER 
FITS_OBJECT 

◆ anonymous enum

anonymous enum
Enumerator
DETECTOR_CAN_ABORT 

Can the Detector Capture be aborted?

DETECTOR_HAS_SHUTTER 

Does the Detector have a mechanical shutter?

DETECTOR_HAS_COOLER 

Does the Detector have a cooler and temperature control?

DETECTOR_HAS_CONTINUUM 

Does the Detector support live streaming?

DETECTOR_HAS_SPECTRUM 

Does the Detector support spectrum analysis?

Constructor & Destructor Documentation

◆ Detector() [1/2]

INDI::Detector::Detector ( )

◆ ~Detector() [1/2]

INDI::Detector::~Detector ( )
virtual

◆ Detector() [2/2]

INDI::Detector::Detector ( )

◆ ~Detector() [2/2]

virtual INDI::Detector::~Detector ( )
virtual

Member Function Documentation

◆ AbortCapture() [1/2]

bool INDI::Detector::AbortCapture ( )
protectedvirtual

Abort ongoing Capture.

Returns
true is abort is successful, false otherwise.
Note
This function is not implemented in Detector, it must be implemented in the child class

Reimplemented in RadioSim, RTLSDR, and SimpleDetector.

◆ AbortCapture() [2/2]

virtual bool INDI::Detector::AbortCapture ( )
protectedvirtual

Abort ongoing Capture.

Returns
true is abort is successful, false otherwise.
Note
This function is not implemented in Detector, it must be implemented in the child class

Reimplemented in RadioSim, RTLSDR, and SimpleDetector.

◆ activeDevicesUpdated() [1/2]

virtual void INDI::Detector::activeDevicesUpdated ( )
inlineprotectedvirtual

activeDevicesUpdated Inform children that ActiveDevices property was updated so they can snoop on the updated devices if desired.

◆ activeDevicesUpdated() [2/2]

virtual void INDI::Detector::activeDevicesUpdated ( )
inlineprotectedvirtual

activeDevicesUpdated Inform children that ActiveDevices property was updated so they can snoop on the updated devices if desired.

◆ addFITSKeywords() [1/2]

void INDI::Detector::addFITSKeywords ( fitsfile *  fptr,
DetectorDevice targetDevice,
int  blobIndex 
)
protectedvirtual

Add FITS keywords to a fits file.

Parameters
fptrpointer to a valid FITS file.
targetDeviceThe target device to extract the keywords from.
blobIndexThe blob index of this FITS (0: continuum, 1: spectrum).
Note
In additional to the standard FITS keywords, this function write the following keywords the FITS file:
  • EXPTIME: Total Capture Time (s)
  • DATAMIN: Minimum value
  • DATAMAX: Maximum value
  • INSTRUME: Detector Name
  • DATE-OBS: UTC start date of observation

To add additional information, override this function in the child class and ensure to call Detector::addFITSKeywords.

◆ addFITSKeywords() [2/2]

virtual void INDI::Detector::addFITSKeywords ( fitsfile *  fptr,
DetectorDevice targetDevice,
int  blobIndex 
)
protectedvirtual

Add FITS keywords to a fits file.

Parameters
fptrpointer to a valid FITS file.
targetDeviceThe target device to extract the keywords from.
blobIndexThe blob index of this FITS (0: continuum, 1: spectrum).
Note
In additional to the standard FITS keywords, this function write the following keywords the FITS file:
  • EXPTIME: Total Capture Time (s)
  • DATAMIN: Minimum value
  • DATAMAX: Maximum value
  • INSTRUME: Detector Name
  • DATE-OBS: UTC start date of observation

To add additional information, override this function in the child class and ensure to call Detector::addFITSKeywords.

◆ CanAbort() [1/2]

bool INDI::Detector::CanAbort ( )
inlineprotected
Returns
True if Detector can abort Capture. False otherwise.

◆ CanAbort() [2/2]

bool INDI::Detector::CanAbort ( )
inlineprotected
Returns
True if Detector can abort Capture. False otherwise.

◆ CaptureComplete() [1/2]

bool INDI::Detector::CaptureComplete ( DetectorDevice targetDevice)
protectedvirtual

Uploads target Device exposed buffer as FITS to the client.

Dervied classes should class this function when an Capture is complete.

Parameters
targetDevicedevice that contains upload capture data
Note
This function is not implemented in Detector, it must be implemented in the child class

◆ CaptureComplete() [2/2]

virtual bool INDI::Detector::CaptureComplete ( DetectorDevice targetDevice)
protectedvirtual

Uploads target Device exposed buffer as FITS to the client.

Dervied classes should class this function when an Capture is complete.

Parameters
targetDevicedevice that contains upload capture data
Note
This function is not implemented in Detector, it must be implemented in the child class

◆ CaptureParamsUpdated() [1/2]

bool INDI::Detector::CaptureParamsUpdated ( float  sr,
float  freq,
float  bps 
)
protectedvirtual

Set common capture params.

Parameters
srDetector samplerate (in Hz)
cfreqCapture frequency of the detector (Hz, observed frequency).
sfreqSampling frequency of the detector (Hz, electronic speed of the detector).
bpsBit resolution of a single sample.
Returns
true if OK and Capture will take some time to complete, false on error.
Note
This function is not implemented in Detector, it must be implemented in the child class

Reimplemented in RadioSim, RTLSDR, and SimpleDetector.

◆ CaptureParamsUpdated() [2/2]

virtual bool INDI::Detector::CaptureParamsUpdated ( float  sr,
float  freq,
float  bps 
)
protectedvirtual

Set common capture params.

Parameters
srDetector samplerate (in Hz)
cfreqCapture frequency of the detector (Hz, observed frequency).
sfreqSampling frequency of the detector (Hz, electronic speed of the detector).
bpsBit resolution of a single sample.
Returns
true if OK and Capture will take some time to complete, false on error.
Note
This function is not implemented in Detector, it must be implemented in the child class

Reimplemented in RadioSim, RTLSDR, and SimpleDetector.

◆ fits_update_key_s() [1/2]

void INDI::Detector::fits_update_key_s ( fitsfile *  fptr,
int  type,
std::string  name,
void *  p,
std::string  explanation,
int *  status 
)
protected

A function to just remove GCC warnings about deprecated conversion.

◆ fits_update_key_s() [2/2]

void INDI::Detector::fits_update_key_s ( fitsfile *  fptr,
int  type,
std::string  name,
void *  p,
std::string  explanation,
int *  status 
)
protected

A function to just remove GCC warnings about deprecated conversion.

◆ GetDetectorCapability() [1/2]

uint32_t INDI::Detector::GetDetectorCapability ( ) const
inlineprotected

GetDetectorCapability returns the Detector capabilities.

◆ GetDetectorCapability() [2/2]

uint32_t INDI::Detector::GetDetectorCapability ( ) const
inlineprotected

GetDetectorCapability returns the Detector capabilities.

◆ getFileIndex() [1/2]

int INDI::Detector::getFileIndex ( const char *  dir,
const char *  prefix,
const char *  ext 
)
private

◆ getFileIndex() [2/2]

int INDI::Detector::getFileIndex ( const char *  dir,
const char *  prefix,
const char *  ext 
)
private

◆ getMinMax() [1/2]

void INDI::Detector::getMinMax ( double *  min,
double *  max,
uint8_t buf,
int  len,
int  bpp 
)
private

◆ getMinMax() [2/2]

void INDI::Detector::getMinMax ( double *  min,
double *  max,
uint8_t buf,
int  len,
int  bpp 
)
private

◆ HasContinuum() [1/2]

bool INDI::Detector::HasContinuum ( )
inlineprotected
Returns
True if the Detector supports live streaming. False otherwise.

◆ HasContinuum() [2/2]

bool INDI::Detector::HasContinuum ( )
inlineprotected
Returns
True if the Detector supports live streaming. False otherwise.

◆ HasCooler() [1/2]

bool INDI::Detector::HasCooler ( )
inlineprotected
Returns
True if Detector has cooler and temperature can be controlled. False otherwise.

◆ HasCooler() [2/2]

bool INDI::Detector::HasCooler ( )
inlineprotected
Returns
True if Detector has cooler and temperature can be controlled. False otherwise.

◆ HasShutter() [1/2]

bool INDI::Detector::HasShutter ( )
inlineprotected
Returns
True if Detector has mechanical or electronic shutter. False otherwise.

◆ HasShutter() [2/2]

bool INDI::Detector::HasShutter ( )
inlineprotected
Returns
True if Detector has mechanical or electronic shutter. False otherwise.

◆ HasSpectrum() [1/2]

bool INDI::Detector::HasSpectrum ( )
inlineprotected
Returns
True if the Detector supports live streaming. False otherwise.

◆ HasSpectrum() [2/2]

bool INDI::Detector::HasSpectrum ( )
inlineprotected
Returns
True if the Detector supports live streaming. False otherwise.

◆ initProperties() [1/2]

bool INDI::Detector::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 RadioSim, RTLSDR, and SimpleDetector.

◆ initProperties() [2/2]

virtual bool INDI::Detector::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 RadioSim, RTLSDR, and SimpleDetector.

◆ ISGetProperties() [1/2]

void INDI::Detector::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 RadioSim.

◆ ISGetProperties() [2/2]

virtual void INDI::Detector::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 RadioSim.

◆ ISNewNumber() [1/2]

bool INDI::Detector::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 RadioSim.

◆ ISNewNumber() [2/2]

virtual bool INDI::Detector::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 RadioSim.

◆ ISNewSwitch() [1/2]

virtual bool INDI::Detector::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.

◆ ISNewSwitch() [2/2]

bool INDI::Detector::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.

◆ ISNewText() [1/2]

virtual bool INDI::Detector::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.

◆ ISNewText() [2/2]

bool INDI::Detector::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.

◆ ISSnoopDevice() [1/2]

virtual bool INDI::Detector::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]

bool INDI::Detector::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.

◆ saveConfigItems() [1/2]

bool INDI::Detector::saveConfigItems ( FILE *  fp)
protectedvirtual

saveConfigItems Save configuration items in XML file.

Parameters
fppointer to file to write to
Returns
True if successful, false otherwise

Reimplemented from INDI::DefaultDevice.

◆ saveConfigItems() [2/2]

virtual bool INDI::Detector::saveConfigItems ( FILE *  fp)
protectedvirtual

saveConfigItems Save configuration items in XML file.

Parameters
fppointer to file to write to
Returns
True if successful, false otherwise

Reimplemented from INDI::DefaultDevice.

◆ SetDetectorCapability() [1/2]

void INDI::Detector::SetDetectorCapability ( uint32_t  cap)
protected

SetDetectorCapability Set the Detector capabilities.

Al fields must be initilized.

Parameters
cappointer to DetectorCapability struct.

◆ SetDetectorCapability() [2/2]

void INDI::Detector::SetDetectorCapability ( uint32_t  cap)
protected

SetDetectorCapability Set the Detector capabilities.

Al fields must be initilized.

Parameters
cappointer to DetectorCapability struct.

◆ SetDetectorParams() [1/2]

void INDI::Detector::SetDetectorParams ( float  samplerate,
float  freq,
float  bps 
)
protectedvirtual

Setup Detector parameters for the Detector.

Child classes call this function to update Detector parameters

Parameters
samplerateDetector samplerate (in Hz)
freqCenter frequency of the detector (Hz, observed frequency).
bpsBit resolution of a single sample.

◆ SetDetectorParams() [2/2]

virtual void INDI::Detector::SetDetectorParams ( float  samplerate,
float  freq,
float  bps 
)
protectedvirtual

Setup Detector parameters for the Detector.

Child classes call this function to update Detector parameters

Parameters
samplerateDetector samplerate (in Hz)
freqCenter frequency of the detector (Hz, observed frequency).
bpsBit resolution of a single sample.

◆ SetTemperature() [1/2]

int INDI::Detector::SetTemperature ( double  temperature)
protectedvirtual

Set Detector temperature.

Parameters
temperatureDetector temperature in degrees celsius.
Returns
0 or 1 if setting the temperature call to the hardware is successful. -1 if an error is encountered. Return 0 if setting the temperature to the requested value takes time. Return 1 if setting the temperature to the requested value is complete.
Note
Upon returning 0, the property becomes BUSY. Once the temperature reaches the requested value, change the state to OK.
This function is not implemented in Detector, it must be implemented in the child class

Reimplemented in SimpleDetector.

◆ SetTemperature() [2/2]

virtual int INDI::Detector::SetTemperature ( double  temperature)
protectedvirtual

Set Detector temperature.

Parameters
temperatureDetector temperature in degrees celsius.
Returns
0 or 1 if setting the temperature call to the hardware is successful. -1 if an error is encountered. Return 0 if setting the temperature to the requested value takes time. Return 1 if setting the temperature to the requested value is complete.
Note
Upon returning 0, the property becomes BUSY. Once the temperature reaches the requested value, change the state to OK.
This function is not implemented in Detector, it must be implemented in the child class

Reimplemented in SimpleDetector.

◆ StartCapture() [1/2]

bool INDI::Detector::StartCapture ( float  duration)
protectedvirtual

Start capture from the Detector device.

Parameters
durationDuration in seconds
Returns
true if OK and Capture will take some time to complete, false on error.
Note
This function is not implemented in Detector, it must be implemented in the child class

Reimplemented in RadioSim, RTLSDR, and SimpleDetector.

◆ StartCapture() [2/2]

virtual bool INDI::Detector::StartCapture ( float  duration)
protectedvirtual

Start capture from the Detector device.

Parameters
durationDuration in seconds
Returns
true if OK and Capture will take some time to complete, false on error.
Note
This function is not implemented in Detector, it must be implemented in the child class

Reimplemented in RadioSim, RTLSDR, and SimpleDetector.

◆ updateProperties() [1/2]

virtual bool INDI::Detector::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 RadioSim, RTLSDR, and SimpleDetector.

◆ updateProperties() [2/2]

bool INDI::Detector::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 RadioSim, RTLSDR, and SimpleDetector.

◆ uploadFile() [1/2]

bool INDI::Detector::uploadFile ( DetectorDevice targetDevice,
const void *  fitsData,
size_t  totalBytes,
bool  sendCapture,
bool  saveCapture,
int  blobindex 
)
private

◆ uploadFile() [2/2]

bool INDI::Detector::uploadFile ( DetectorDevice targetDevice,
const void *  fitsData,
size_t  totalBytes,
bool  sendCapture,
bool  saveCapture,
int  blobindex 
)
private

Member Data Documentation

◆ ActiveDeviceT

IText INDI::Detector::ActiveDeviceT {}
protected

◆ ActiveDeviceTP

ITextVectorProperty INDI::Detector::ActiveDeviceTP
protected

◆ AutoLoop

bool INDI::Detector::AutoLoop
protected

◆ capability

uint32_t INDI::Detector::capability
private

◆ CaptureTime

float INDI::Detector::CaptureTime
protected

◆ CurrentFilterSlot

int INDI::Detector::CurrentFilterSlot
protected

◆ DatasetS

ISwitch INDI::Detector::DatasetS
protected

◆ DatasetSP

ISwitchVectorProperty INDI::Detector::DatasetSP
protected

◆ Dec

double INDI::Detector::Dec
protected

◆ DetectorCapability [1/2]

enum { ... } INDI::Detector::DetectorCapability

◆ DetectorCapability [2/2]

enum { ... } INDI::Detector::DetectorCapability

◆ EqN

INumber INDI::Detector::EqN
protected

◆ EqNP

INumberVectorProperty INDI::Detector::EqNP
protected

◆ FileNameT

IText INDI::Detector::FileNameT {}
protected

◆ FileNameTP

ITextVectorProperty INDI::Detector::FileNameTP
protected

◆ FilterNames

std::vector< std::string > INDI::Detector::FilterNames
protected

◆ FITSHeaderT

IText INDI::Detector::FITSHeaderT {}
protected

◆ FITSHeaderTP

ITextVectorProperty INDI::Detector::FITSHeaderTP
protected

◆ InCapture

bool INDI::Detector::InCapture
protected

◆ MPSAS

double INDI::Detector::MPSAS
protected

◆ primaryAperture

double INDI::Detector::primaryAperture
protected

◆ PrimaryDetector

DetectorDevice INDI::Detector::PrimaryDetector
protected

◆ primaryFocalLength

double INDI::Detector::primaryFocalLength
protected

◆ RA

double INDI::Detector::RA
protected

◆ SendCapture

bool INDI::Detector::SendCapture
protected

◆ ShowMarker

bool INDI::Detector::ShowMarker
protected

◆ TelescopeTypeS

ISwitch INDI::Detector::TelescopeTypeS
protected

◆ TelescopeTypeSP

ISwitchVectorProperty INDI::Detector::TelescopeTypeSP
protected

◆ TemperatureN

INumber INDI::Detector::TemperatureN
protected

◆ TemperatureNP

INumberVectorProperty INDI::Detector::TemperatureNP
protected

◆ UploadS

ISwitch INDI::Detector::UploadS
protected

◆ UploadSettingsT

IText INDI::Detector::UploadSettingsT {}
protected

◆ UploadSettingsTP

ITextVectorProperty INDI::Detector::UploadSettingsTP
protected

◆ UploadSP

ISwitchVectorProperty INDI::Detector::UploadSP
protected

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