Instrument Neutral Distributed Interface INDI  1.9.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
GuideSim Class Reference

The GuideSim class provides an advanced simulator for a CCD that includes a dedicated on-board guide chip. More...

#include <guide_simulator.h>

Inheritance diagram for GuideSim:
INDI::CCD INDI::DefaultDevice INDI::GuiderInterface INDI::BaseDevice

Public Member Functions

 GuideSim ()
 
virtual ~GuideSim () override=default
 
const char * getDefaultName () override
 
bool initProperties () override
 Initilize properties initial state and value. The child class must implement this function. More...
 
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...
 
void ISGetProperties (const char *dev) override
 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 ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n) override
 Process the client newNumber command. More...
 
virtual bool ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n) override
 Process the client newSwitch command. More...
 
virtual bool ISSnoopDevice (XMLEle *root) override
 Process a snoop event from INDI server. This function is called when a snooped property is updated in a snooped driver. More...
 
void * streamVideo ()
 
- Public Member Functions inherited from INDI::CCD
 CCD ()
 
virtual ~CCD ()
 
virtual bool ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n) override
 Process the client newSwitch command. More...
 
virtual bool ISNewBLOB (const char *dev, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n) override
 Process the client newBLOB command. More...
 
- Public Member Functions inherited from INDI::DefaultDevice
 DefaultDevice ()
 
virtual ~DefaultDevice () override=default
 
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) __attribute__((deprecated))
 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 defineProperty (INumberVectorProperty *property)
 
void defineText (ITextVectorProperty *tvp) __attribute__((deprecated))
 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 defineProperty (ITextVectorProperty *property)
 
void defineSwitch (ISwitchVectorProperty *svp) __attribute__((deprecated))
 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 defineProperty (ISwitchVectorProperty *property)
 
void defineLight (ILightVectorProperty *lvp) __attribute__((deprecated))
 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 defineProperty (ILightVectorProperty *property)
 
void defineBLOB (IBLOBVectorProperty *bvp) __attribute__((deprecated))
 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...
 
void defineProperty (IBLOBVectorProperty *property)
 
void defineProperty (INDI::Property &property)
 
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 (uint32_t ms)
 Set a timer to call the function TimerHit after ms milliseconds. More...
 
void RemoveTimer (int id)
 Remove timer added with SetTimer. More...
 
virtual const char * getDriverExec ()
 
virtual const char * getDriverName ()
 
void setVersion (uint16_t vMajor, uint16_t vMinor)
 Set driver version information to be defined in DRIVER_INFO property as vMajor.vMinor. More...
 
uint16_t getMajorVersion () const
 
uint16_t getMinorVersion () const
 
virtual uint16_t getDriverInterface () override
 
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 ()
 
INDI::PropertyView< INumber > * getNumber (const char *name) const
 
INDI::PropertyView< IText > * getText (const char *name) const
 
INDI::PropertyView< ISwitch > * getSwitch (const char *name) const
 
INDI::PropertyView< ILight > * getLight (const char *name) const
 
INDI::PropertyView< IBLOB > * getBLOB (const char *name) const
 
IPState getPropertyState (const char *name) const
 
IPerm getPropertyPermission (const char *name) const
 
void registerProperty (void *p, INDI_PROPERTY_TYPE type)
 
void registerProperty (ITextVectorProperty *property)
 
void registerProperty (INumberVectorProperty *property)
 
void registerProperty (ISwitchVectorProperty *property)
 
void registerProperty (ILightVectorProperty *property)
 
void registerProperty (IBLOBVectorProperty *property)
 
void registerProperty (INDI::PropertyView< IText > *property)
 
void registerProperty (INDI::PropertyView< INumber > *property)
 
void registerProperty (INDI::PropertyView< ISwitch > *property)
 
void registerProperty (INDI::PropertyView< ILight > *property)
 
void registerProperty (INDI::PropertyView< IBLOB > *property)
 
void registerProperty (INDI::Property &property)
 
int removeProperty (const char *name, char *errmsg)
 Remove a property. More...
 
void * getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const
 Return a property and its type given its name. More...
 
PropertygetProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const
 Return a property and its type given its name. More...
 
PropertiesgetProperties ()
 Return a list of all properties in the device. More...
 
const PropertiesgetProperties () const
 
void addMessage (const std::string &msg)
 Add message to the driver's message queue. More...
 
void checkMessage (XMLEle *root)
 
void doMessage (XMLEle *msg)
 
const std::string & messageQueue (size_t index) const
 
const std::string & lastMessage () const
 
bool isConnected () const
 
void setMediator (INDI::BaseMediator *mediator)
 Set the driver's mediator to receive notification of news devices and updated property values. More...
 
INDI::BaseMediatorgetMediator () const
 
void setDeviceName (const char *dev)
 Set the device name. More...
 
const char * getDeviceName () const
 
const char * getDriverName () const
 
const char * getDriverExec () const
 
const char * getDriverVersion () const
 
bool buildSkeleton (const char *filename)
 Build driver properties from a skeleton file. 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...
 

Static Public Member Functions

static void * streamVideoHelper (void *context)
 
- Static Public Member Functions inherited from INDI::CCD
static void wsThreadHelper (void *context)
 

Protected Member Functions

bool Connect () override
 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...
 
bool Disconnect () override
 Disconnect from device. More...
 
bool StartExposure (float duration) override
 Start exposing primary CCD chip. More...
 
bool StartGuideExposure (float) override
 Start exposing guide CCD chip. More...
 
bool AbortExposure () override
 Abort ongoing exposure. More...
 
bool AbortGuideExposure () override
 Abort ongoing exposure. More...
 
void TimerHit () override
 Callback function to be called once SetTimer duration elapses. More...
 
int DrawCcdFrame (INDI::CCDChip *targetChip)
 
int DrawImageStar (INDI::CCDChip *targetChip, float, float, float, float ExposureTime)
 
int AddToPixel (INDI::CCDChip *targetChip, int, int, int)
 
virtual IPState GuideNorth (uint32_t) override
 Guide northward for ms milliseconds. More...
 
virtual IPState GuideSouth (uint32_t) override
 Guide southward for ms milliseconds. More...
 
virtual IPState GuideEast (uint32_t) override
 Guide easward for ms milliseconds. More...
 
virtual IPState GuideWest (uint32_t) override
 Guide westward for ms milliseconds. More...
 
virtual bool saveConfigItems (FILE *fp) override
 saveConfigItems Save configuration items in XML file. More...
 
virtual void addFITSKeywords (fitsfile *fptr, INDI::CCDChip *targetChip) override
 Add FITS keywords to a fits file. More...
 
virtual void activeDevicesUpdated () override
 activeDevicesUpdated Inform children that ActiveDevices property was updated so they can snoop on the updated devices if desired. More...
 
virtual int SetTemperature (double temperature) override
 Set CCD temperature. More...
 
virtual bool UpdateCCDFrame (int x, int y, int w, int h) override
 CCD calls this function when CCD Frame dimension needs to be updated in the hardware. Derived classes should implement this function. More...
 
virtual bool UpdateCCDBin (int hor, int ver) override
 CCD calls this function when CCD Binning needs to be updated in the hardware. Derived classes should implement this function. More...
 
virtual bool StartStreaming () override
 StartStreaming Start live video streaming. More...
 
virtual bool StopStreaming () override
 StopStreaming Stop live video streaming. More...
 
- Protected Member Functions inherited from INDI::CCD
uint32_t GetCCDCapability () const
 GetCCDCapability returns the CCD capabilities. More...
 
void SetCCDCapability (uint32_t cap)
 SetCCDCapability Set the CCD capabilities. Al fields must be initilized. More...
 
bool CanAbort ()
 
bool CanBin ()
 
bool CanSubFrame ()
 
bool HasGuideHead ()
 
bool HasShutter ()
 
bool HasST4Port ()
 
bool HasCooler ()
 
bool HasBayer ()
 
bool HasStreaming ()
 
bool HasWebSocket ()
 
bool HasDSP ()
 
virtual bool ExposureComplete (CCDChip *targetChip)
 Uploads target Chip exposed buffer as FITS to the client. Dervied classes should class this function when an exposure is complete. More...
 
virtual bool UpdateGuiderFrame (int x, int y, int w, int h)
 CCD calls this function when Guide head frame dimension is updated by the client. Derived classes should implement this function. More...
 
virtual bool UpdateGuiderBin (int hor, int ver)
 CCD calls this function when Guide head binning is updated by the client. Derived classes should implement this function. More...
 
virtual bool UpdateCCDFrameType (CCDChip::CCD_FRAME fType)
 CCD calls this function when CCD frame type needs to be updated in the hardware. More...
 
virtual bool UpdateCCDUploadMode (CCD_UPLOAD_MODE mode)
 CCD calls this function when client upload mode switch is updated. More...
 
virtual bool UpdateGuiderFrameType (CCDChip::CCD_FRAME fType)
 CCD calls this function when Guide frame type is updated by the client. More...
 
virtual void SetCCDParams (int x, int y, int bpp, float xf, float yf)
 Setup CCD paramters for primary CCD. Child classes call this function to update CCD parameters. More...
 
virtual void SetGuiderParams (int x, int y, int bpp, float xf, float yf)
 Setup CCD paramters for guide head CCD. Child classes call this function to update CCD parameters. More...
 
void fits_update_key_s (fitsfile *fptr, int type, std::string name, void *p, std::string explanation, int *status)
 
void GuideComplete (INDI_EQ_AXIS axis) override
 Call GuideComplete once the guiding pulse is complete. More...
 
- 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 purgeConfig ()
 purgeConfig Remove config file from disk. 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 () const
 
bool isSimulation () const
 
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 ()
 
void setActiveConnection (Connection::Interface *existingConnection)
 setActiveConnection Switch the active connection to the passed connection plugin More...
 
void setDefaultPollingPeriod (uint32_t msec)
 setDefaultPollingPeriod Change the default polling period to call TimerHit() function in the driver. More...
 
void setPollingPeriodRange (uint32_t minimum, uint32_t maximum)
 setPollingPeriodRange Set the range permitted by the polling range in milliseconds More...
 
uint32_t getPollingPeriod () const
 getPollingPeriod Return the polling period. More...
 
void setCurrentPollingPeriod (uint32_t msec)
 setCurrentPollingPeriod Change the current polling period to call TimerHit() function in the driver. More...
 
uint32_t getCurrentPollingPeriod () const
 getCurrentPollingPeriod Return the current polling period. More...
 
uint32_t & refCurrentPollingPeriod () __attribute__((deprecated))
 
uint32_t refCurrentPollingPeriod () const __attribute__((deprecated))
 
bool isConfigLoading () const
 isConfigLoading Check if driver configuration is currently in the process of getting loaded. More...
 
void syncDriverInfo ()
 syncDriverInfo sends the current driver information to the client. More...
 
 DefaultDevice (DefaultDevicePrivate &dd)
 
- Protected Member Functions inherited from INDI::BaseDevice
 BaseDevice (BaseDevicePrivate &dd)
 

Additional Inherited Members

- Public Types inherited from INDI::CCD
enum  {
  CCD_CAN_BIN = 1 << 0, CCD_CAN_SUBFRAME = 1 << 1, CCD_CAN_ABORT = 1 << 2, CCD_HAS_GUIDE_HEAD = 1 << 3,
  CCD_HAS_ST4_PORT = 1 << 4, CCD_HAS_SHUTTER = 1 << 5, CCD_HAS_COOLER = 1 << 6, CCD_HAS_BAYER = 1 << 7,
  CCD_HAS_STREAMING = 1 << 8, CCD_HAS_WEB_SOCKET = 1 << 9, CCD_HAS_DSP = 1 << 10
}
 
enum  CCD_UPLOAD_MODE { UPLOAD_CLIENT, UPLOAD_LOCAL, UPLOAD_BOTH }
 
- 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 }
 
enum  { INDI_ENABLED, INDI_DISABLED }
 
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), CORRELATOR_INTERFACE = (1 << 14),
  AUX_INTERFACE = (1 << 15), SENSOR_INTERFACE = SPECTROGRAPH_INTERFACE | DETECTOR_INTERFACE | CORRELATOR_INTERFACE
}
 The DRIVER_INTERFACE enum defines the class of devices the driver implements. A driver may implement one or more interfaces. More...
 
typedef std::vector< INDI::Property * > Properties
 
- Public Attributes inherited from INDI::CCD
enum INDI::CCD:: { ... }  CCDCapability
 
- Static Public Attributes inherited from INDI::CCD
static constexpr const char * GUIDE_CONTROL_TAB = "Guider Control"
 Group Names. More...
 
static constexpr const char * WCS_TAB = "WCS"
 
- Protected Types inherited from INDI::CCD
enum  {
  ACTIVE_TELESCOPE, ACTIVE_ROTATOR, ACTIVE_FOCUSER, ACTIVE_FILTER,
  ACTIVE_SKYQUALITY
}
 
enum  { UPLOAD_DIR, UPLOAD_PREFIX }
 
enum  { TELESCOPE_PRIMARY, TELESCOPE_GUIDE }
 
enum  { WEBSOCKET_ENABLED, WEBSOCKET_DISABLED }
 
enum  { WS_SETTINGS_PORT }
 
enum  { FITS_OBSERVER, FITS_OBJECT }
 
- Protected Attributes inherited from INDI::CCD
double RA
 
double Dec
 
int pierSide
 
double J2000RA
 
double J2000DE
 
double primaryFocalLength
 
double primaryAperture
 
double guiderFocalLength
 
double guiderAperture
 
bool InExposure
 
bool InGuideExposure
 
bool AutoLoop
 
bool GuiderAutoLoop
 
bool SendImage
 
bool GuiderSendImage
 
bool ShowMarker
 
bool GuiderShowMarker
 
double ExposureTime
 
double GuiderExposureTime
 
double MPSAS
 
double RotatorAngle
 
long FocuserPos
 
double FocuserTemp
 
double Airmass
 
double Latitude
 
double Longitude
 
std::mutex ccdBufferLock
 
std::vector< std::string > FilterNames
 
int CurrentFilterSlot
 
std::unique_ptr< StreamManagerStreamer
 
std::unique_ptr< DSP::ManagerDSP
 
CCDChip PrimaryCCD
 
CCDChip GuideCCD
 
INumberVectorProperty EqNP
 Properties. More...
 
INumber EqN [2]
 
ITextVectorProperty ActiveDeviceTP
 ActiveDeviceTP defines 4 devices the camera driver can listen to (snoop) for properties of interest so that it can generate a proper FITS header. More...
 
IText ActiveDeviceT [5] {}
 
INumberVectorProperty TemperatureNP
 TemperatureNP Read-Only Temperature in Celcius. More...
 
INumber TemperatureN [1]
 
ITextVectorProperty BayerTP
 BayerTP Bayer pattern offset and type. More...
 
IText BayerT [3] {}
 
ITextVectorProperty FileNameTP
 FileNameTP File name of locally-saved images. By default, images are uploaded to the client but when upload option is set to either Both or Local, then they are saved on the local disk with this name. More...
 
IText FileNameT [1] {}
 
ISwitch UploadS [3]
 
ISwitchVectorProperty UploadSP
 
IText UploadSettingsT [2] {}
 
ITextVectorProperty UploadSettingsTP
 
ISwitch TelescopeTypeS [2]
 
ISwitchVectorProperty TelescopeTypeSP
 
ISwitch WebSocketS [2]
 
ISwitchVectorProperty WebSocketSP
 
INumber WebSocketSettingsN [1]
 
INumberVectorProperty WebSocketSettingsNP
 
ISwitch WorldCoordS [2]
 
ISwitchVectorProperty WorldCoordSP
 
INumber CCDRotationN [1]
 
INumberVectorProperty CCDRotationNP
 
IText FITSHeaderT [2] {}
 
ITextVectorProperty FITSHeaderTP
 
- Protected Attributes inherited from INDI::BaseDevice
std::shared_ptr< BaseDevicePrivated_ptr
 

Detailed Description

The GuideSim class provides an advanced simulator for a CCD that includes a dedicated on-board guide chip.

The CCD driver can generate star fields given that General-Star-Catalog (gsc) tool is installed on the same machine the driver is running.

Many simulator parameters can be configured to generate the final star field image. In addition to support guider chip and guiding pulses (ST4), a filter wheel support is provided for 8 filter wheels. Cooler and temperature control is also supported.

The driver can snoop the mount equatorial coords to draw the star field. It listens to EQUATORIAL_PE property and also defines it so that the user can set it manually.

Video streaming can be enabled from the Stream property group with several encoders and recorders supported.

Author
Gerry Rozema
Jasem Mutlaq

Definition at line 40 of file guide_simulator.h.

Constructor & Destructor Documentation

◆ GuideSim()

GuideSim::GuideSim ( )

Definition at line 37 of file guide_simulator.cpp.

◆ ~GuideSim()

virtual GuideSim::~GuideSim ( )
overridevirtualdefault

Member Function Documentation

◆ AbortExposure()

bool GuideSim::AbortExposure ( )
overrideprotectedvirtual

Abort ongoing exposure.

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

Reimplemented from INDI::CCD.

Definition at line 311 of file guide_simulator.cpp.

◆ AbortGuideExposure()

bool GuideSim::AbortGuideExposure ( )
overrideprotectedvirtual

Abort ongoing exposure.

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

Reimplemented from INDI::CCD.

Definition at line 321 of file guide_simulator.cpp.

◆ activeDevicesUpdated()

void GuideSim::activeDevicesUpdated ( )
overrideprotectedvirtual

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

Reimplemented from INDI::CCD.

Definition at line 1221 of file guide_simulator.cpp.

◆ addFITSKeywords()

void GuideSim::addFITSKeywords ( fitsfile *  fptr,
INDI::CCDChip targetChip 
)
overrideprotectedvirtual

Add FITS keywords to a fits file.

Parameters
fptrpointer to a valid FITS file.
targetChipThe target chip to extract the keywords from.
Note
In additional to the standard FITS keywords, this function write the following keywords the FITS file:
  • EXPTIME: Total Exposure Time (s)
  • DARKTIME (if applicable): Total Exposure Time (s)
  • PIXSIZE1: Pixel Size 1 (microns)
  • PIXSIZE2: Pixel Size 2 (microns)
  • BINNING: Binning HOR x VER
  • FRAME: Frame Type
  • DATAMIN: Minimum value
  • DATAMAX: Maximum value
  • INSTRUME: CCD Name
  • DATE-OBS: UTC start date of observation

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

Reimplemented from INDI::CCD.

Definition at line 1403 of file guide_simulator.cpp.

◆ AddToPixel()

int GuideSim::AddToPixel ( INDI::CCDChip targetChip,
int  x,
int  y,
int  val 
)
protected

Definition at line 1026 of file guide_simulator.cpp.

◆ Connect()

bool GuideSim::Connect ( )
overrideprotectedvirtual

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.

Returns
True if connection is successful, false otherwise

Reimplemented from INDI::DefaultDevice.

Definition at line 89 of file guide_simulator.cpp.

◆ Disconnect()

bool GuideSim::Disconnect ( )
overrideprotectedvirtual

Disconnect from device.

Returns
True if successful, false otherwise

Reimplemented from INDI::DefaultDevice.

Definition at line 98 of file guide_simulator.cpp.

◆ DrawCcdFrame()

int GuideSim::DrawCcdFrame ( INDI::CCDChip targetChip)
protected

Definition at line 468 of file guide_simulator.cpp.

◆ DrawImageStar()

int GuideSim::DrawImageStar ( INDI::CCDChip targetChip,
float  mag,
float  x,
float  y,
float  ExposureTime 
)
protected

Definition at line 957 of file guide_simulator.cpp.

◆ getDefaultName()

const char * GuideSim::getDefaultName ( )
overridevirtual
Returns
Default name of the device.

Implements INDI::DefaultDevice.

Definition at line 109 of file guide_simulator.cpp.

◆ GuideEast()

IPState GuideSim::GuideEast ( uint32_t  ms)
overrideprotectedvirtual

Guide easward for ms milliseconds.

Parameters
msDuration in milliseconds.
Note
This function is not implemented in CCD, it must be implemented in the child class
Returns
0 if successful, -1 otherwise.

Reimplemented from INDI::CCD.

Definition at line 1079 of file guide_simulator.cpp.

◆ GuideNorth()

IPState GuideSim::GuideNorth ( uint32_t  ms)
overrideprotectedvirtual

Guide northward for ms milliseconds.

Parameters
msDuration in milliseconds.
Note
This function is not implemented in CCD, it must be implemented in the child class
Returns
True if successful, false otherwise.

Reimplemented from INDI::CCD.

Definition at line 1067 of file guide_simulator.cpp.

◆ GuideSouth()

IPState GuideSim::GuideSouth ( uint32_t  ms)
overrideprotectedvirtual

Guide southward for ms milliseconds.

Parameters
msDuration in milliseconds.
Note
This function is not implemented in CCD, it must be implemented in the child class
Returns
0 if successful, -1 otherwise.

Reimplemented from INDI::CCD.

Definition at line 1073 of file guide_simulator.cpp.

◆ GuideWest()

IPState GuideSim::GuideWest ( uint32_t  ms)
overrideprotectedvirtual

Guide westward for ms milliseconds.

Parameters
msDuration in milliseconds.
Note
This function is not implemented in CCD, it must be implemented in the child class
Returns
0 if successful, -1 otherwise.

Reimplemented from INDI::CCD.

Definition at line 1090 of file guide_simulator.cpp.

◆ initProperties()

bool GuideSim::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::CCD.

Definition at line 114 of file guide_simulator.cpp.

◆ ISGetProperties()

void GuideSim::ISGetProperties ( const char *  dev)
overridevirtual

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

Definition at line 219 of file guide_simulator.cpp.

◆ ISNewNumber()

bool GuideSim::ISNewNumber ( const char *  dev,
const char *  name,
double  values[],
char *  names[],
int  n 
)
overridevirtual

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

Definition at line 1101 of file guide_simulator.cpp.

◆ ISNewSwitch()

bool GuideSim::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::CCD.

Definition at line 1170 of file guide_simulator.cpp.

◆ ISSnoopDevice()

bool GuideSim::ISSnoopDevice ( XMLEle root)
overridevirtual

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

Definition at line 1233 of file guide_simulator.cpp.

◆ saveConfigItems()

bool GuideSim::saveConfigItems ( FILE *  fp)
overrideprotectedvirtual

saveConfigItems Save configuration items in XML file.

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

Reimplemented from INDI::CCD.

Definition at line 1284 of file guide_simulator.cpp.

◆ SetTemperature()

int GuideSim::SetTemperature ( double  temperature)
overrideprotectedvirtual

Set CCD temperature.

Parameters
temperatureCCD temperature in degrees celcius.
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 CCD, it must be implemented in the child class

Reimplemented from INDI::CCD.

Definition at line 259 of file guide_simulator.cpp.

◆ StartExposure()

bool GuideSim::StartExposure ( float  duration)
overrideprotectedvirtual

Start exposing primary CCD chip.

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

Reimplemented from INDI::CCD.

Definition at line 275 of file guide_simulator.cpp.

◆ StartGuideExposure()

bool GuideSim::StartGuideExposure ( float  duration)
overrideprotectedvirtual

Start exposing guide CCD chip.

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

Reimplemented from INDI::CCD.

Definition at line 300 of file guide_simulator.cpp.

◆ StartStreaming()

bool GuideSim::StartStreaming ( )
overrideprotectedvirtual

StartStreaming Start live video streaming.

Returns
True if successful, false otherwise.

Reimplemented from INDI::CCD.

Definition at line 1302 of file guide_simulator.cpp.

◆ StopStreaming()

bool GuideSim::StopStreaming ( )
overrideprotectedvirtual

StopStreaming Stop live video streaming.

Returns
True if successful, false otherwise.

Reimplemented from INDI::CCD.

Definition at line 1313 of file guide_simulator.cpp.

◆ streamVideo()

void * GuideSim::streamVideo ( )

Definition at line 1360 of file guide_simulator.cpp.

◆ streamVideoHelper()

void * GuideSim::streamVideoHelper ( void *  context)
static

Definition at line 1355 of file guide_simulator.cpp.

◆ TimerHit()

void GuideSim::TimerHit ( )
overrideprotectedvirtual

Callback function to be called once SetTimer duration elapses.

Reimplemented from INDI::DefaultDevice.

Definition at line 347 of file guide_simulator.cpp.

◆ UpdateCCDBin()

bool GuideSim::UpdateCCDBin ( int  hor,
int  ver 
)
overrideprotectedvirtual

CCD calls this function when CCD Binning needs to be updated in the hardware. Derived classes should implement this function.

Parameters
horHorizontal binning.
verVertical binning.
Returns
true is CCD chip update is successful, false otherwise.
Note
This function is not implemented in CCD, it must be implemented in the child class

Reimplemented from INDI::CCD.

Definition at line 1336 of file guide_simulator.cpp.

◆ UpdateCCDFrame()

bool GuideSim::UpdateCCDFrame ( int  x,
int  y,
int  w,
int  h 
)
overrideprotectedvirtual

CCD calls this function when CCD Frame dimension needs to be updated in the hardware. Derived classes should implement this function.

Parameters
xSubframe X coordinate in pixels.
ySubframe Y coordinate in pixels.
wSubframe width in pixels.
hSubframe height in pixels.
Note
(0,0) is defined as most left, top pixel in the subframe.
Returns
true is CCD chip update is successful, false otherwise.
Note
This function is not implemented in CCD, it must be implemented in the child class

Reimplemented from INDI::CCD.

Definition at line 1323 of file guide_simulator.cpp.

◆ updateProperties()

bool GuideSim::updateProperties ( )
overridevirtual

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

Definition at line 228 of file guide_simulator.cpp.


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