Inheritance diagram for MockScopeSimDriver:

Public Member Functions
	MockScopeSimDriver ()

void	selectMountType (const char *type)

bool	syncAt (double ra, double dec)

void	setLocation (double latitude, double longitude)

const AlignmentDatabaseEntry &	lastSyncPoint ()

void	addSyncPoint ()

size_t	syncPoints ()

Public Member Functions inherited from ScopeSim
	ScopeSim ()

virtual	~ScopeSim ()=default

virtual const char *	getDefaultName () override

virtual 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.

virtual bool	Disconnect () override
	Disconnect from device.

virtual bool	ReadScopeStatus () override
	Read telescope status.

virtual bool	initProperties () override
	Called to initialize basic properties required all the time.

virtual 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.

virtual bool	updateProperties () override
	Called when connected state changes, to add/remove properties.

virtual bool	ISNewNumber (const char dev, const char name, double values[], char *names[], int n) override
	Process the client newNumber command.

virtual bool	ISNewSwitch (const char dev, const char name, ISState states, char names[], int n) override
	Process the client newSwitch command.

virtual bool	ISNewText (const char dev, const char name, char texts[], char names[], int n) override
	Process the client newSwitch command.

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.

	ScopeSim ()

Public Member Functions inherited from INDI::Telescope
	Telescope ()

virtual	~Telescope ()

uint32_t	GetTelescopeCapability () const
	GetTelescopeCapability returns the capability of the Telescope.

void	SetTelescopeCapability (uint32_t cap, uint8_t slewRateCount)
	SetTelescopeCapability sets the Telescope capabilities. All capabilities must be initialized.

bool	CanGOTO ()

bool	CanSync ()

bool	CanFlip ()

bool	CanAbort ()

bool	CanPark ()

bool	CanControlTrack ()

bool	HasTime ()

bool	HasLocation ()

bool	HasPierSide ()

bool	HasPierSideSimulation ()

bool	CanTrackSatellite ()

bool	HasPECState ()

bool	HasTrackMode ()

bool	HasTrackRate ()

bool	CanHomeFind ()

bool	CanHomeSet ()

bool	CanHomeGo ()

virtual bool	Handshake ()
	perform handshake with device to check communication

void	SetParkDataType (TelescopeParkData type)
	setParkDataType Sets the type of parking data stored in the park data file and presented to the user.

bool	InitPark ()
	InitPark Loads parking data (stored in ~/.indi/ParkData.xml) that contains parking status and parking position.

bool	isParked ()
	isParked is mount currently parked?

virtual void	SetParked (bool isparked)
	SetParked Change the mount parking status. The data park file (stored in ~/.indi/ParkData.xml) is updated in the process.

double	GetAxis1Park () const

double	GetAxis1ParkDefault () const

double	GetAxis2Park () const

double	GetAxis2ParkDefault () const

void	SetAxis1Park (double value)
	SetRAPark Set current RA/AZ parking position. The data park file (stored in ~/.indi/ParkData.xml) is updated in the process.

void	SetAxis1ParkDefault (double steps)
	SetRAPark Set default RA/AZ parking position.

void	SetAxis2Park (double steps)
	SetDEPark Set current DEC/ALT parking position. The data park file (stored in ~/.indi/ParkData.xml) is updated in the process.

void	SetAxis2ParkDefault (double steps)
	SetDEParkDefault Set default DEC/ALT parking position.

bool	isLocked () const
	isLocked is mount currently locked?

void	setTelescopeConnection (const uint8_t &value)
	setTelescopeConnection Set telescope connection mode. Child class should call this in the constructor before Telescope registers any connection interfaces

uint8_t	getTelescopeConnection () const

void	setPierSide (TelescopePierSide side)

TelescopePierSide	getPierSide ()

void	setPECState (TelescopePECState state)

TelescopePECState	getPECState ()

Public Member Functions inherited from INDI::DefaultDevice
	DefaultDevice ()

virtual	~DefaultDevice () override=default

void	addAuxControls ()
	Add Debug, Simulation, and Configuration options to the driver.

void	addDebugControl ()
	Add Debug control to the driver.

void	addSimulationControl ()
	Add Simulation control to the driver.

void	addConfigurationControl ()
	Add Configuration control to the driver.

void	addPollPeriodControl ()
	Add Polling period control to the driver.

void	addNicknameControl ()
	Add Nickname text property to the driver.

void	resetProperties ()
	Set all properties to IDLE state.

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.

void	defineProperty (INumberVectorProperty *property)

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.

void	defineProperty (ITextVectorProperty *property)

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.

void	defineProperty (ISwitchVectorProperty *property)

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.

void	defineProperty (ILightVectorProperty *property)

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.

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.

bool	deleteProperty (INDI::Property &property)
	deleteProperty Delete a property and unregister it. It will also be deleted from all clients.

virtual void	setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr)
	Set connection switch status in the client.

int	SetTimer (uint32_t ms)
	Set a timer to call the function TimerHit after ms milliseconds.

void	RemoveTimer (int id)
	Remove timer added with SetTimer.

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.

uint16_t	getMajorVersion () const

uint16_t	getMinorVersion () const

bool	ISNewProperty (INDI::Property &property, const std::string &elementName, const std::any &value)
	Generic convenience function to update a property element as if by client request, simulating an ISNew... call.

template<typename PropertyType , typename ValueType >
bool	updateProperty (PropertyType &property, ValueType values, char names[], int n, std::function< bool()> updater, bool saveConfig=false)
	Generic helper function to update an INDI property based on an external operation.

uint32_t	getDriverInterface () const

void	setDriverInterface (uint32_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.

void	watchDevice (const char *deviceName, const std::function< void(INDI::BaseDevice)> &callback)
	Add a device to the watch list.

Public Member Functions inherited from INDI::ParentDevice
	ParentDevice (Type type)

	~ParentDevice ()

	ParentDevice (ParentDevice &&other)=default

ParentDevice &	operator= (ParentDevice &&other)=default

Public Member Functions inherited from INDI::BaseDevice
	BaseDevice ()

virtual	~BaseDevice ()

void	registerProperty (const INDI::Property &property)
	Register the property to be able to observe and update.

void	registerProperty (const INDI::Property &property, INDI_PROPERTY_TYPE type)

int	removeProperty (const char name, char errmsg)
	Remove a property.

void	watchProperty (const char *name, const std::function< void(INDI::Property)> &callback, WATCH watch=WATCH_NEW)
	Call the callback function if property is available.

Property	getProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const
	Return a property and its type given its name.

Properties	getProperties ()
	Return a list of all properties in the device.

const Properties	getProperties () const

INDI::PropertyNumber	getNumber (const char *name) const

INDI::PropertyText	getText (const char *name) const

INDI::PropertySwitch	getSwitch (const char *name) const

INDI::PropertyLight	getLight (const char *name) const

INDI::PropertyBlob	getBLOB (const char *name) const

IPState	getPropertyState (const char *name) const

IPerm	getPropertyPermission (const char *name) const

void *	getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const
	Return a property and its type given its name.

void	addMessage (const std::string &msg)
	Add message to the driver's message queue.

void	checkMessage (XMLEle *root)

void	doMessage (XMLEle *msg)

const std::string &	messageQueue (size_t index) const

const std::string &	lastMessage () const

bool	isValid () const

bool	isSameDevice (const BaseDevice &other) const

bool	isConnected () const

void	attach ()
	indicates that the device is ready

void	detach ()
	indicates that the device is being removed

void	setMediator (INDI::BaseMediator *mediator)
	Set the driver's mediator to receive notification of news devices and updated property values.

INDI::BaseMediator *	getMediator () const

void	setDeviceName (const char *dev)
	Set the device name.

const char *	getDeviceName () const

bool	isDeviceNameMatch (const char *otherName) const
	Check that the device name matches the argument.

bool	isDeviceNameMatch (const std::string &otherName) const
	Check that the device name matches the argument.

const char *	getDriverName () const

const char *	getDriverExec () const

const char *	getDriverVersion () const

uint16_t	getDriverInterface () const
	getDriverInterface returns ORed values of DRIVER_INTERFACE. It presents the device classes supported by the driver.

bool	buildSkeleton (const char *filename)
	Build driver properties from a skeleton file.

int	buildProp (const INDI::LilXmlElement &root, char *errmsg, bool isDynamic=false)
	Build a property given the supplied XML element (defXXX)

int	setValue (const INDI::LilXmlElement &root, char *errmsg)
	handle SetXXX commands from client

	operator BaseDevice * ()

BaseDevice *	operator-> ()

bool	operator!= (std::nullptr_t) const

bool	operator== (std::nullptr_t) const

	operator bool () const

	operator bool ()

Public Member Functions inherited from INDI::GuiderInterface
virtual void	GuideComplete (INDI_EQ_AXIS axis)
	Call GuideComplete once the guiding pulse is complete.

Public Member Functions inherited from INDI::AlignmentSubsystem::AlignmentSubsystemForDrivers
	AlignmentSubsystemForDrivers ()
	Default constructor.

virtual	~AlignmentSubsystemForDrivers ()
	Virtual destructor.

void	InitAlignmentProperties (Telescope *pTelescope)
	Initialize alignment subsystem properties. It is recommended to call this function within initProperties() of your primary device.

void	ProcessAlignmentBLOBProperties (Telescope pTelescope, const char name, int sizes[], int blobsizes[], char blobs[], char formats[], char *names[], int n)
	Call this function from within the ISNewBlob processing path. The function will handle any alignment subsystem related properties.

void	ProcessAlignmentNumberProperties (Telescope pTelescope, const char name, double values[], char *names[], int n)
	Call this function from within the ISNewNumber processing path. The function will handle any alignment subsystem related properties.

void	ProcessAlignmentSwitchProperties (Telescope pTelescope, const char name, ISState states, char names[], int n)
	Call this function from within the ISNewSwitch processing path. The function will handle any alignment subsystem related properties.

void	ProcessAlignmentTextProperties (Telescope pTelescope, const char name, char texts[], char names[], int n)
	Call this function from within the ISNewText processing path. The function will handle any alignment subsystem related properties. This only text property at the moment is contained in the config file so this will normally only have work to do when the config file is loaded.

void	SaveAlignmentConfigProperties (FILE *fp)
	Call this function to save persistent alignment related properties. This function should be called from within the saveConfigItems function of your driver.

bool	AddAlignmentEntryEquatorial (double actualRA, double actualDec, double mountRA, double mountDec, double JD=ln_get_julian_from_sys())
	Adds an alignment point to the model database, usually called from Sync.

bool	SkyToTelescopeEquatorial (double actualRA, double actualDec, double &mountRA, double &mountDec, double JD=ln_get_julian_from_sys())
	Converts an actual sky location to coordinates to send to the mount, usually called in Goto.

bool	TelescopeEquatorialToSky (double mountRA, double mountDec, double &actualRA, double &actualDec, double JD=ln_get_julian_from_sys())
	Converts a mount location to actual sky coordinates, usually called in ReadScopeStatus.

bool	AddAlignmentEntryAltAz (double actualRA, double actualDec, double mountAlt, double mountAz, double JD=ln_get_julian_from_sys())
	Adds an alignment point to the model database, usually called from Sync.

bool	SkyToTelescopeAltAz (double actualRA, double actualDec, double &mountAlt, double &mountAz, double JD=ln_get_julian_from_sys())
	Converts an actual sky location to coordinates to send to the mount, usually called in Goto.

bool	TelescopeAltAzToSky (double mountAlt, double mountAz, double &actualRA, double &actualDec, double JD=ln_get_julian_from_sys())
	Converts a mount location to actual sky coordinates, usually called in ReadScopeStatus.

Public Member Functions inherited from INDI::AlignmentSubsystem::MapPropertiesToInMemoryDatabase
virtual	~MapPropertiesToInMemoryDatabase ()
	Virtual destructor.

void	InitProperties (Telescope *pTelescope)
	Initialize alignment database properties. It is recommended to call this function within initProperties() of your primary device.

void	ProcessBlobProperties (Telescope pTelescope, const char name, int sizes[], int blobsizes[], char blobs[], char formats[], char *names[], int n)
	Call this function from within the ISNewBLOB processing path. The function will handle any alignment database related properties.

void	ProcessNumberProperties (Telescope , const char name, double values[], char *names[], int n)
	Call this function from within the ISNewNumber processing path. The function will handle any alignment database related properties.

void	ProcessSwitchProperties (Telescope pTelescope, const char name, ISState states, char names[], int n)
	Call this function from within the ISNewSwitch processing path. The function will handle any alignment database related properties.

void	UpdateLocation (double latitude, double longitude, double elevation)
	Call this function from within the updateLocation processing path.

void	UpdateSize ()
	Call this function when the number of entries in the database changes.

Public Member Functions inherited from INDI::AlignmentSubsystem::InMemoryDatabase
	InMemoryDatabase ()
	Default constructor.

virtual	~InMemoryDatabase ()
	Virtual destructor.

bool	CheckForDuplicateSyncPoint (const AlignmentDatabaseEntry &CandidateEntry, double Tolerance=0.1) const
	Check if a entry already exists in the database.

void	RemoveSyncPoint (const AlignmentDatabaseEntry &CandidateEntry, double Tolerance=0.1)
	Remove a sync point that falls within the tolerance of a candidate point.

AlignmentDatabaseType &	GetAlignmentDatabase ()
	Get a reference to the in memory database.

bool	GetDatabaseReferencePosition (IGeographicCoordinates &Position)
	Get the database reference position.

bool	LoadDatabase (const char *DeviceName)
	Load the database from persistent storage.

bool	SaveDatabase (const char *DeviceName)
	Save the database to persistent storage.

void	SetDatabaseReferencePosition (double Latitude, double Longitude)
	Set the database reference position.

void	SetDatabaseReferencePosition (const IGeographicCoordinates &Position)
	Set the database reference position.

void	SetLoadDatabaseCallback (LoadDatabaseCallbackPointer_t CallbackPointer, void *ThisPointer)
	Set the function to be called when the database is loaded or reloaded.

Public Member Functions inherited from INDI::AlignmentSubsystem::MathPluginManagement
	MathPluginManagement ()
	Default constructor.

virtual	~MathPluginManagement ()
	Virtual destructor.

void	InitProperties (Telescope *pTelescope)
	Initialize alignment math plugin properties. It is recommended to call this function within initProperties() of your primary device.

void	ProcessSwitchProperties (Telescope pTelescope, const char name, ISState states, char names[], int n)
	Call this function from within the ISNewSwitch processing path. The function will handle any math plugin switch properties.

void	ProcessTextProperties (Telescope pTelescope, const char name, char texts[], char names[], int n)
	Call this function from within the ISNewText processing path. The function will handle any math plugin text properties. This text property is at the moment only contained in the config file so this will normally only have work to do when the config file is loaded.

void	SaveConfigProperties (FILE *fp)
	Call this function to save persistent math plugin properties. This function should be called from within the saveConfigItems function of your driver.

void	SetApproximateMountAlignmentFromMountType (MountType_t Type)
	Call this function to set the ApproximateMountAlignment property of the current Math Plugin. The alignment database should be initialised before this function is called so that it can use the DatabaseReferencePosition to determine which hemisphere the current observing site is in. For equatorial the ApproximateMountAlignment property will set to NORTH_CELESTIAL_POLE for sites in the northern hemisphere and SOUTH_CELESTIAL_POLE for sites in the southern hemisphere. For altaz mounts the ApproximateMountAlignment will be set to ZENITH.

void	SetCurrentInMemoryDatabase (InMemoryDatabase *pDatabase)
	Set the current in memory database.

void	SetAlignmentSubsystemActive (bool enable)
	SetAlignmentSubsystemActive Enable or Disable alignment subsystem.

bool	IsAlignmentSubsystemActive () const
	Return status of alignment subsystem.

MountAlignment_t	GetApproximateMountAlignment ()
	Get the approximate alignment of the mount.

bool	Initialise (InMemoryDatabase *pInMemoryDatabase)
	Initialise or re-initialise the math plugin. Re-reading the in memory database as necessary.

void	SetApproximateMountAlignment (MountAlignment_t ApproximateAlignment)
	Set the approximate alignment of the mount.

bool	TransformCelestialToTelescopeJD (double RightAscension, double Declination, double JulianDate, TelescopeDirectionVector &ApparentTelescopeDirectionVector)
	TransformCelestialToTelescopeJD Transforms Celestial (Sky) Coords to Mount Coordinates.

bool	TransformTelescopeToCelestialJD (const TelescopeDirectionVector &ApparentTelescopeDirectionVector, double &RightAscension, double &Declination, double JulianDate)
	TransformTelescopeToCelestialJD Transforms Mount Coords to Celestial (Sky) Coordinates.

bool	TransformCelestialToTelescope (const double RightAscension, const double Declination, double JulianOffset, TelescopeDirectionVector &ApparentTelescopeDirectionVector)
	TransformCelestialToTelescope Compat shim - resolves JD and delegates to TransformCelestialToTelescopeJD.

bool	TransformTelescopeToCelestial (const TelescopeDirectionVector &ApparentTelescopeDirectionVector, double &RightAscension, double &Declination, double JulianOffset=0)
	TransformTelescopeToCelestial Compat shim - resolves JD and delegates to TransformTelescopeToCelestialJD.

Public Member Functions inherited from INDI::AlignmentSubsystem::TelescopeDirectionVectorSupportFunctions
virtual	~TelescopeDirectionVectorSupportFunctions ()
	Virtual destructor.

void	AltitudeAzimuthFromTelescopeDirectionVector (const TelescopeDirectionVector TelescopeDirectionVector, INDI::IHorizontalCoordinates &HorizontalCoordinates)
	Calculates an altitude and azimuth from the supplied normalised direction vector and declination.

void	EquatorialCoordinatesFromTelescopeDirectionVector (const TelescopeDirectionVector TelescopeDirectionVector, INDI::IEquatorialCoordinates &EquatorialCoordinates)
	Calculates equatorial coordinates from the supplied telescope direction vector and declination.

void	LocalHourAngleDeclinationFromTelescopeDirectionVector (const TelescopeDirectionVector TelescopeDirectionVector, INDI::IEquatorialCoordinates &EquatorialCoordinates)
	Calculates a local hour angle and declination from the supplied telescope direction vector and declination.

void	SphericalCoordinateFromTelescopeDirectionVector (const TelescopeDirectionVector TelescopeDirectionVector, double &AzimuthAngle, AzimuthAngleDirection_t AzimuthAngleDirection, double &PolarAngle, PolarAngleDirection_t PolarAngleDirection)
	Calculates a spherical coordinate from the supplied telescope direction vector.

const TelescopeDirectionVector	TelescopeDirectionVectorFromAltitudeAzimuth (INDI::IHorizontalCoordinates HorizontalCoordinates)
	Calculates a normalised direction vector from the supplied altitude and azimuth.

const TelescopeDirectionVector	TelescopeDirectionVectorFromEquatorialCoordinates (INDI::IEquatorialCoordinates EquatorialCoordinates)
	Calculates a telescope direction vector from the supplied equatorial coordinates.

const TelescopeDirectionVector	TelescopeDirectionVectorFromLocalHourAngleDeclination (INDI::IEquatorialCoordinates EquatorialCoordinates)
	Calculates a telescope direction vector from the supplied local hour angle and declination.

const TelescopeDirectionVector	TelescopeDirectionVectorFromSphericalCoordinate (const double AzimuthAngle, AzimuthAngleDirection_t AzimuthAngleDirection, const double PolarAngle, PolarAngleDirection_t PolarAngleDirection)
	Calculates a telescope direction vector from the supplied spherical coordinate information.

Additional Inherited Members
Public Types inherited from INDI::Telescope
enum	TelescopeStatus { SCOPE_IDLE , SCOPE_SLEWING , SCOPE_TRACKING , SCOPE_PARKING , SCOPE_PARKED }

enum	TelescopeMotionCommand { MOTION_START = 0 , MOTION_STOP }

enum	TelescopeSlewRate { SLEW_GUIDE , SLEW_CENTERING , SLEW_FIND , SLEW_MAX }

enum	TelescopeTrackMode { TRACK_SIDEREAL , TRACK_SOLAR , TRACK_LUNAR , TRACK_CUSTOM }

enum	TelescopeTrackState { TRACK_ON , TRACK_OFF , TRACK_UNKNOWN }

enum	TelescopeParkData { PARK_NONE , PARK_RA_DEC , PARK_HA_DEC , PARK_AZ_ALT , PARK_RA_DEC_ENCODER , PARK_AZ_ALT_ENCODER , PARK_SIMPLE }

enum	TelescopeLocation { LOCATION_LATITUDE , LOCATION_LONGITUDE , LOCATION_ELEVATION }

enum	TelescopePierSide { PIER_UNKNOWN = -1 , PIER_WEST = 0 , PIER_EAST = 1 }

enum	TelescopeHomeAction { HOME_FIND , HOME_SET , HOME_GO }

enum	TelescopePECState { PEC_UNKNOWN = -1 , PEC_OFF = 0 , PEC_ON = 1 }

enum	DomeLockingPolicy { DOME_IGNORED , DOME_LOCKS }

enum	{ CONNECTION_NONE = 1 << 0 , CONNECTION_SERIAL = 1 << 1 , CONNECTION_TCP = 1 << 2 }

enum	{ TELESCOPE_CAN_GOTO = 1 << 0 , TELESCOPE_CAN_SYNC = 1 << 1 , TELESCOPE_CAN_PARK = 1 << 2 , TELESCOPE_CAN_ABORT = 1 << 3 , TELESCOPE_HAS_TIME = 1 << 4 , TELESCOPE_HAS_LOCATION = 1 << 5 , TELESCOPE_HAS_PIER_SIDE = 1 << 6 , TELESCOPE_HAS_PEC = 1 << 7 , TELESCOPE_HAS_TRACK_MODE = 1 << 8 , TELESCOPE_CAN_CONTROL_TRACK = 1 << 9 , TELESCOPE_HAS_TRACK_RATE = 1 << 10 , TELESCOPE_HAS_PIER_SIDE_SIMULATION = 1 << 11 , TELESCOPE_CAN_TRACK_SATELLITE = 1 << 12 , TELESCOPE_CAN_FLIP = 1 << 13 , TELESCOPE_CAN_HOME_FIND = 1 << 14 , TELESCOPE_CAN_HOME_SET = 1 << 15 , TELESCOPE_CAN_HOME_GO = 1 << 16 }

Public Types inherited from INDI::ParentDevice
enum	Type { Valid , Invalid }

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	WATCH { WATCH_NEW = 0 , WATCH_UPDATE , WATCH_NEW_OR_UPDATE }

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) , OUTPUT_INTERFACE = (1 << 16) , INPUT_INTERFACE = (1 << 17) , POWER_INTERFACE = (1 << 18) , IMU_INTERFACE = (1 << 19) , PAC_INTERFACE = (1 << 20) , 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 INDI::Properties	Properties

Public Types inherited from INDI::AlignmentSubsystem::InMemoryDatabase
typedef std::vector< AlignmentDatabaseEntry >	AlignmentDatabaseType

typedef void(*	LoadDatabaseCallbackPointer_t) (void *)

Public Types inherited from INDI::AlignmentSubsystem::MathPluginManagement
enum	MountType { EQUATORIAL , ALTAZ }
	Describes the basic type of the mount. More...

typedef enum INDI::AlignmentSubsystem::MathPluginManagement::MountType	MountType_t

Public Types inherited from INDI::AlignmentSubsystem::TelescopeDirectionVectorSupportFunctions
enum	AzimuthAngleDirection { CLOCKWISE , ANTI_CLOCKWISE }

enum	PolarAngleDirection { FROM_POLAR_AXIS , FROM_AZIMUTHAL_PLANE }

typedef enum INDI::AlignmentSubsystem::TelescopeDirectionVectorSupportFunctions::AzimuthAngleDirection	AzimuthAngleDirection_t

typedef enum INDI::AlignmentSubsystem::TelescopeDirectionVectorSupportFunctions::PolarAngleDirection	PolarAngleDirection_t

Static Public Member Functions inherited from INDI::Telescope
static void	joystickHelper (const char joystick_n, double mag, double angle, void context)

static void	axisHelper (const char axis_n, double value, void context)

static void	buttonHelper (const char button_n, ISState state, void context)

Static Public Member Functions inherited from INDI::BaseDevice
static std::string	getSharedFilePath (std::string fileName)

Public Attributes inherited from INDI::Telescope
enum INDI::Telescope:: { ... }	TelescopeConnection

enum INDI::Telescope:: { ... }	TelescopeCapability

Protected Types inherited from INDI::Telescope
enum	{ PARK , UNPARK }

enum	{ PARK_CURRENT , PARK_DEFAULT , PARK_WRITE_DATA , PARK_PURGE_DATA }

enum	{ REVERSE_NS , REVERSE_WE }

enum	{ UTC , OFFSET }

enum	{ ACTIVE_GPS , ACTIVE_DOME }

enum	{ MOTION_CONTROL_MODE_JOYSTICK , MOTION_CONTROL_MODE_AXES }

enum	{ LOCK_AXIS_1 , LOCK_AXIS_2 }

enum	{ JOYSTICK_REVERSE_NS , JOYSTICK_REVERSE_WE , JOYSTICK_REVERSE_SWAP }

enum	{ SIMULATE_YES , SIMULATE_NO }

enum	{ SAT_PASS_WINDOW_START , SAT_PASS_WINDOW_END }

enum	{ SAT_TRACK , SAT_HALT }

enum	{ MOUNT_ALTAZ , MOUNT_EQ_FORK , MOUNT_EQ_GEM }

Protected Member Functions inherited from ScopeSim
virtual bool	MoveNS (INDI_DIR_NS dir, TelescopeMotionCommand command) override
	Start or Stop the telescope motion in the direction dir.

virtual bool	MoveWE (INDI_DIR_WE dir, TelescopeMotionCommand command) override
	Move the telescope in the direction dir.

virtual bool	Abort () override
	Abort any telescope motion including tracking if possible.

virtual IPState	GuideNorth (uint32_t ms) override
	Guide north for ms milliseconds. North is defined as DEC+.

virtual IPState	GuideSouth (uint32_t ms) override
	Guide south for ms milliseconds. South is defined as DEC-.

virtual IPState	GuideEast (uint32_t ms) override
	Guide east for ms milliseconds. East is defined as RA+.

virtual IPState	GuideWest (uint32_t ms) override
	Guide west for ms milliseconds. West is defined as RA-.

virtual bool	SetTrackMode (uint8_t mode) override
	SetTrackMode Set active tracking mode. Do not change track state.

virtual bool	SetTrackEnabled (bool enabled) override
	SetTrackEnabled Engages or disengages mount tracking. If there are no tracking modes available, it is assumed sidereal. Otherwise, whatever tracking mode should be activated or deactivated accordingly.

virtual bool	SetTrackRate (double raRate, double deRate) override
	SetTrackRate Set custom tracking rates.

virtual bool	Goto (double, double) override
	Move the scope to the supplied RA and DEC coordinates.

virtual bool	Park () override
	Park the telescope to its home position.

virtual bool	UnPark () override
	Unpark the telescope if already parked.

virtual bool	Sync (double ra, double dec) override
	Set the telescope current RA and DEC coordinates to the supplied RA and DEC coordinates.

virtual bool	SetCurrentPark () override
	SetCurrentPark Set current coordinates/encoders value as the desired parking position.

virtual bool	SetDefaultPark () override
	SetDefaultPark Set default coordinates/encoders value as the desired parking position.

virtual bool	updateLocation (double latitude, double longitude, double elevation) override
	Update telescope location settings.

virtual bool	updateTime (ln_date *utc, double utc_offset) override
	Update telescope time, date, and UTC offset.

virtual IPState	ExecuteHomeAction (TelescopeHomeAction action) override
	Execute a homing action.

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.

bool	Abort () override
	Abort any telescope motion including tracking if possible.

bool	canSync ()

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.

bool	Disconnect () override
	Disconnect from device.

const char *	getDefaultName () override

bool	Goto (double ra, double dec) override
	Move the scope to the supplied RA and DEC coordinates.

bool	initProperties () override
	Called to initialize basic properties required all the time.

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.

bool	ISNewNumber (const char dev, const char name, double values[], char *names[], int n) override
	Process the client newNumber command.

bool	ISNewSwitch (const char dev, const char name, ISState states, char names[], int n) override
	Process the client newSwitch command.

bool	ISNewText (const char dev, const char name, char texts[], char names[], int n) override
	Process the client newSwitch command.

bool	MoveNS (INDI_DIR_NS dir, TelescopeMotionCommand command) override
	Start or Stop the telescope motion in the direction dir.

bool	MoveWE (INDI_DIR_WE dir, TelescopeMotionCommand command) override
	Move the telescope in the direction dir.

bool	ReadScopeStatus () override
	Read telescope status.

bool	Sync (double ra, double dec) override
	Set the telescope current RA and DEC coordinates to the supplied RA and DEC coordinates.

void	TimerHit () override
	Called when setTimer() time is up.

bool	updateLocation (double latitude, double longitude, double elevation) override
	Update telescope location settings.

Protected Member Functions inherited from INDI::Telescope
void	NewRaDec (double ra, double dec)
	The child class calls this function when it has updates.

virtual bool	Flip (double ra, double dec)
	Move and flip the scope to the supplied RA and DEC coordinates.

virtual int	AddTrackMode (const char name, const char label, bool isDefault=false)
	AddTrackMode.

void	updateObserverLocation (double latitude, double longitude, double elevation)
	Update location settings of the observer.

virtual bool	SetParkPosition (double Axis1Value, double Axis2Value)
	SetParkPosition Set desired parking position to the supplied value. This ONLY sets the desired park position value and does not perform parking.

virtual void	SyncParkStatus (bool isparked)
	SyncParkStatus Update the state and switches for parking.

virtual bool	SetSlewRate (int index)
	SetSlewRate Set desired slew rate index.

bool	callHandshake ()
	callHandshake Helper function that sets the port file descriptor before calling the actual Handshake function implenented in drivers

void	processNSWE (double mag, double angle)

void	processJoystick (const char *joystick_n, double mag, double angle)

void	processAxis (const char *axis_n, double value)

void	processSlewPresets (double mag, double angle)

void	processButton (const char *button_n, ISState state)

TelescopePierSide	expectedPierSide (double ra)
	Calculate the expected pier side for scopes that do not report this property themselves.

std::string	GetHomeDirectory () const
	Validate a file name.

int	GetScopeConfigIndex () const
	Get the scope config index.

bool	CheckFile (const std::string &file_name, bool writable) const
	Check if a file exists and it is readable.

void	sendTimeFromSystem ()

bool	getSimulatePierSide () const

void	setSimulatePierSide (bool value)

const char *	getPierSideStr (TelescopePierSide ps)

const char *	LoadParkData ()

bool	WriteParkData ()

bool	PurgeParkData ()

Protected Member Functions inherited from INDI::DefaultDevice
void	setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled)
	setDynamicPropertiesBehavior controls handling of dynamic properties. Dynamic 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.

virtual bool	loadConfig (bool silent=false, const char *property=nullptr)
	Load the last saved configuration file.

bool	loadConfig (INDI::Property &property)
	Load property config from the configuration file. If the property configuration is successfully parsed, the corresponding ISNewXXX is called with the values parsed from the config file.

virtual bool	saveConfig (bool silent=false, const char *property=nullptr)
	Save the current properties in a configuration file.

bool	saveConfig (INDI::Property &property)
	Save a property in the configuration file.

virtual bool	purgeConfig ()
	purgeConfig Remove config file from disk.

virtual bool	saveAllConfigItems (FILE *fp)
	saveAllConfigItems Save all the drivers' properties in the configuration file

virtual bool	loadDefaultConfig ()
	Load the default configuration file.

void	setDebug (bool enable)
	Toggle driver debug status A driver can be more verbose if Debug option is enabled by the client.

void	setSimulation (bool enable)
	Toggle driver simulation status A driver can run in simulation mode if Simulation option is enabled by the client.

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.

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.

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()

bool	unRegisterConnection (Connection::Interface *existingConnection)
	unRegisterConnection Remove connection from existing pool

Connection::Interface *	getActiveConnection ()

void	setActiveConnection (Connection::Interface *existingConnection)
	setActiveConnection Switch the active connection to the passed connection plugin

void	setDefaultPollingPeriod (uint32_t msec)
	setDefaultPollingPeriod Change the default polling period to call TimerHit() function in the driver.

void	setPollingPeriodRange (uint32_t minimum, uint32_t maximum)
	setPollingPeriodRange Set the range permitted by the polling range in milliseconds

uint32_t	getPollingPeriod () const
	getPollingPeriod Return the polling period.

void	setCurrentPollingPeriod (uint32_t msec)
	setCurrentPollingPeriod Change the current polling period to call TimerHit() function in the driver.

uint32_t	getCurrentPollingPeriod () const
	getCurrentPollingPeriod Return the current polling period.

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.

bool	isInitializationComplete () const
	isInitializationComplete Check if driver initialization is complete.

void	syncDriverInfo ()
	syncDriverInfo sends the current driver information to the client.

void	setDeviceNickname (const char *nick)
	Set the device nickname.

const char *	getDeviceNickname ()

const char *	lookupDeviceNicknameFromId (const char identifier, const char device=nullptr)
	Lookup device nickname for an identifier.

bool	setDeviceNicknameFromId (const char *identifier)
	Set device nickname based on an identifier.

void	saveNicknameId (const char nickname, const char identifier)

virtual void	nicknameSet (const char *nickname)
	Inform driver that the nickname has been set.

	DefaultDevice (const std::shared_ptr< DefaultDevicePrivate > &dd)

Protected Member Functions inherited from INDI::ParentDevice
	ParentDevice (const std::shared_ptr< ParentDevicePrivate > &dd)

Protected Member Functions inherited from INDI::BaseDevice
	BaseDevice (BaseDevicePrivate &dd)

	BaseDevice (const std::shared_ptr< BaseDevicePrivate > &dd)

Protected Member Functions inherited from INDI::GuiderInterface
	GuiderInterface (DefaultDevice *defaultDevice)

	~GuiderInterface ()

void	initProperties (const char *groupName)
	Initialize guider properties. It is recommended to call this function within initProperties() of your primary device.

bool	updateProperties ()
	updateProperties Define or Delete Rotator properties based on the connection status of the base device

bool	processNumber (const char dev, const char name, double values[], char *names[], int n)
	Call this function whenever client updates GuideNSNP or GuideWSP properties in the primary device. This function then takes care of issuing the corresponding GuideXXXX function accordingly.

Protected Attributes inherited from INDI::Telescope
IGeographicCoordinates	m_Location { 0, 0, 0 }

TelescopeStatus	TrackState {SCOPE_IDLE}

TelescopeStatus	RememberTrackState {SCOPE_IDLE}
	RememberTrackState Remember last state of Track State to fall back to in case of errors or aborts.

INDI::PropertyNumber	EqNP {2}

INDI::PropertyNumber	TargetNP {2}

INDI::PropertySwitch	AbortSP {1}

INDI::PropertySwitch	CoordSP {4}

INDI::PropertyNumber	LocationNP {3}

INDI::PropertySwitch	ParkSP {2}

INDI::PropertyNumber	ParkPositionNP {2}

INDI::PropertySwitch	ParkOptionSP {4}

INDI::PropertySwitch	MovementNSSP {2}

INDI::PropertySwitch	MovementWESP {2}

INDI::PropertySwitch	ReverseMovementSP {2}

INDI::PropertySwitch	SlewRateSP {0}

INDI::PropertyText	TimeTP {2}

INDI::PropertyText	ActiveDeviceTP {2}

INDI::PropertySwitch	DomePolicySP {2}

INDI::PropertySwitch	MotionControlModeTP {2}

INDI::PropertySwitch	LockAxisSP {2}

INDI::PropertySwitch	JoystickReverseSP {3}

INDI::PropertySwitch	PierSideSP {2}

INDI::PropertySwitch	SimulatePierSideSP {2}

TelescopePierSide	lastPierSide

TelescopePierSide	currentPierSide

INDI::PropertyText	TLEtoTrackTP {1}
	Text Vector property defining the orbital elements of an artificial satellite (TLE). Example implementation.

INDI::PropertyText	SatPassWindowTP {2}
	Text Vector property defining the start and end of a satellite pass (window contains pass). Example implementation.

enum INDI::Telescope:: { ... }	SatelliteWindow

INDI::PropertySwitch	TrackSatSP {2}
	Switch Vector property defining the state of the satellite tracking of the mount. Example implementation.

enum INDI::Telescope:: { ... }	SatelliteTracking

INDI::PropertySwitch	PECStateSP {2}

INDI::PropertySwitch	MountTypeSP {3}

INDI::PropertySwitch	TrackModeSP {0}

INDI::PropertySwitch	TrackStateSP {2}

INDI::PropertyNumber	TrackRateNP {2}

INDI::PropertySwitch	HomeSP {0}

TelescopePECState	lastPECState {PEC_UNKNOWN}

TelescopePECState	currentPECState {PEC_UNKNOWN}

uint32_t	capability {0}

int	last_we_motion {-1}

int	last_ns_motion {-1}

int	PortFD = -1

Connection::Serial *	serialConnection = nullptr

Connection::TCP *	tcpConnection = nullptr

bool	IsParked {false}

TelescopeParkData	parkDataType {PARK_NONE}

Protected Attributes inherited from INDI::BaseDevice
std::shared_ptr< BaseDevicePrivate >	d_ptr

Protected Attributes inherited from INDI::GuiderInterface
INDI::PropertyNumber	GuideNSNP {2}

INDI::PropertyNumber	GuideWENP {2}