KStarsInterface Class Reference

This class encapsulates the DCOP functions for KStars. More...

#include <kstarsinterface.h>

Inheritance diagram for KStarsInterface:

[legend]

List of all members.

---

Detailed Description

This class encapsulates the DCOP functions for KStars.

Note:

Clock-related DCOP functions are in a separate class: SimClockInterface

The function definitions are in the file kstarsdcop.cpp

Author:

Mark Hollomon

Version:

1.0

Definition at line 35 of file kstarsinterface.h.

---

Member Function Documentation

virtual ASYNC KStarsInterface::changeViewOption	(	const QString	option,
		const QString	value
	)			[pure virtual]

Reset a View option.

There are dozens of view options which can be adjusted with this function. See the ScriptBuilder tool for a hierarchical list, or see the kstarsrc config file. Different options require different data types for their argument. The value parameter will be recast from a QString to the correct data type for the specified option. If the value cannot be recast, then the option will not be changed.

Parameters:

	option	the name of the option to change
	value	the new value for the option

Implemented in KStars.

virtual ASYNC KStarsInterface::defaultZoom

(

)

[pure virtual]

Set the zoomFactor to its default value.

Implemented in KStars.

virtual ASYNC KStarsInterface::drawLine	(	int	x1,
		int	y1,
		int	x2,
		int	y2,
		int	speed
	)			[pure virtual]

Draw a line on the sky map (NOT YET IMPLEMENTED).

Parameters:

	x1	the x-coordinate of the starting point of the line
	y1	the y-coordinate of the starting point of the line
	x2	the x-coordinate of the ending point of the line
	y2	the y-coordinate of the ending point of the line
	speed	how fast the line should be drawn from the starting point to the ending point. A speed of 0 will draw the entire line instantly.

Implemented in KStars.

virtual ASYNC KStarsInterface::exportImage	(	const QString	filename,
		int	width,
		int	height
	)			[pure virtual]

Export an image of the current sky to a file on disk.

Parameters:

	filename	The filename for the exported image (the image type will be determined from the fileame extension; if this is not possible, it will save the image as a PNG)
	width	the width of the image
	height	the height of the image

Implemented in KStars.

virtual QString KStarsInterface::getOption

(

const QString &

name

)

[pure virtual]

Returns:

the value of an option in the config file

Parameters:

name

the name of the option to be read

Implemented in KStars.

virtual ASYNC KStarsInterface::loadColorScheme

(

const QString

name

)

[pure virtual]

Load a color scheme.

Parameters:

name

The name of the color scheme to be loaded

Implemented in KStars.

virtual ASYNC KStarsInterface::lookTowards

(

const QString

direction

)

[pure virtual]

Recenter the display at a new object or point in the sky.

Parameters:

direction

This is either the name of a SkyObject, or one of the following to center on a compass point along the horizon or at the zenith point: north, n northeast, ne east, e southeast, se south, s southwest, sw west, w northwest, nw zenith, z

Implemented in KStars.

virtual ASYNC KStarsInterface::popupMessage	(	int	x,
		int	y,
		const QString	message
	)			[pure virtual]

Show a message in a popup window (NOT YET IMPLEMENTED).

Parameters:

	x	the X-coordinate of the window
	y	the Y-coordinate of the window
	message	the text to be displayed

Implemented in KStars.

virtual ASYNC KStarsInterface::printImage	(	bool	usePrintDialog,
		bool	useChartColors
	)			[pure virtual]

Print the current sky map.

Options to show the Print Dialog and to use Star Chart colors.

Implemented in KStars.

virtual ASYNC KStarsInterface::readConfig

(

)

[pure virtual]

read in the config file

Implemented in KStars.

virtual ASYNC KStarsInterface::setAltAz	(	double	alt,
		double	az
	)			[pure virtual]

Recenter the Display to the given Alt,Az position.

Parameters:

	alt	the new Alt coordinate
	az	the new Az coordinate

Implemented in KStars.

virtual ASYNC KStarsInterface::setColor	(	const QString	colorName,
		const QString	value
	)			[pure virtual]

Adjust one of the color settings.

Parameters:

	colorName	The name of the color to change (see one of the *.colors files, or colorscheme.cpp)
	value	The new color setting

Implemented in KStars.

virtual ASYNC KStarsInterface::setGeoLocation	(	const QString	city,
		const QString	province,
		const QString	country
	)			[pure virtual]

Set the Geographic location according to the given city name.

Parameters:

	city	the name of the city
	province	the name of the province or US state
	country	the name of the country

Implemented in KStars.

virtual ASYNC KStarsInterface::setINDIAction	(	QString	deviceName,
		QString	action
	)			[pure virtual]

Set INDI device action.

This action is an element of a valid switch property in the device.

Parameters:

	deviceName	The INDI device name
	action	The generic action to invoke

Implemented in KStars.

virtual ASYNC KStarsInterface::setINDICCDTemp	(	QString	deviceName,
		int	temp
	)			[pure virtual]

Set CCD target temperature.

Parameters:

	deviceName	The INDI device name
	temp	The target CCD temperature.

Implemented in KStars.

virtual ASYNC KStarsInterface::setINDIFilterNum	(	QString	deviceName,
		int	filter_num
	)			[pure virtual]

Sets the Filter position.

Parameters:

	deviceName	The INDI device name
	filter_num	The filter position (0-20)

Implemented in KStars.

virtual ASYNC KStarsInterface::setINDIFocusSpeed	(	QString	deviceName,
		unsigned int	speed
	)			[pure virtual]

Set Focus Speed.

Parameters:

	deviceName	The INDI device name
	speed	Focus speed: Halt, Fast, Medium, and Slow; which numerical value corresponds to which is left to the INDI driver.

Todo:

Be more explicit about allowed action strings.

Implemented in KStars.

virtual ASYNC KStarsInterface::setINDIFocusTimeout	(	QString	deviceName,
		int	timeout
	)			[pure virtual]

Set INDI focus timeout.

Parameters:

	deviceName	The INDI device name
	timeout	Number of seconds to perform focusing.

Implemented in KStars.

virtual ASYNC KStarsInterface::setINDIFrameType	(	QString	deviceName,
		QString	type
	)			[pure virtual]

Sets the CCD camera frame type.

Parameters:

	deviceName	The INDI device name
	type	The frame type can be either FRAME_LIGHT, FRAME_DARK, FRAME_BIAS, or FRAME_FLAT

Implemented in KStars.

virtual ASYNC KStarsInterface::setINDIGeoLocation	(	QString	deviceName,
		double	longitude,
		double	latitude
	)			[pure virtual]

Set INDI geographical location.

Parameters:

	deviceName	The INDI device name
	longitude	Longitude expressed in double. E of N
	latitude	Latitude expressed in double.

Implemented in KStars.

virtual ASYNC KStarsInterface::setINDIPort	(	QString	deviceName,
		QString	port
	)			[pure virtual]

Set INDI connection port.

Parameters:

	deviceName	The INDI device name
	port	The connection port (e.g. /dev/ttyS0)

Implemented in KStars.

virtual ASYNC KStarsInterface::setINDIScopeAction	(	QString	deviceName,
		QString	action
	)			[pure virtual]

Set telescope action.

Parameters:

	deviceName	The INDI device name
	action	The specfic action to perform. Either SLEW, TRACK, SYNC, PARK, or ABORT.

Implemented in KStars.

virtual ASYNC KStarsInterface::setINDITargetCoord	(	QString	deviceName,
		double	RA,
		double	DEC
	)			[pure virtual]

Set telescope target coordinates.

Parameters:

	deviceName	The INDI device name
	RA	Target's right ascension in JNOW
	DEC	Target's declination in JNOW

Implemented in KStars.

virtual ASYNC KStarsInterface::setINDITargetName	(	QString	deviceName,
		QString	objectName
	)			[pure virtual]

Set telescope target.

Parameters:

	deviceName	The INDI device name
	objectName	Object's name as found in KStars

Implemented in KStars.

virtual ASYNC KStarsInterface::setINDIUTC	(	QString	deviceName,
		QString	UTCDateTime
	)			[pure virtual]

Start INDI UTC date and time in ISO 8601 format.

Parameters:

	deviceName	The INDI device name
	UTCDateTime	UTC date and time in ISO 8601 format.

Implemented in KStars.

virtual ASYNC KStarsInterface::setLocalTime	(	int	yr,
		int	mth,
		int	day,
		int	hr,
		int	min,
		int	sec
	)			[pure virtual]

Reset the clock to the given time and date.

Parameters:

	yr	the year
	mth	the month
	day	the day
	hr	the hour
	min	the minute
	sec	the second

Implemented in KStars.

virtual ASYNC KStarsInterface::setRaDec	(	double	ra,
		double	dec
	)			[pure virtual]

Recenter the Display to the given RA,Dec position.

Parameters:

	ra	the new RA coordinate
	dec	the new Dec coordinate

Implemented in KStars.

virtual ASYNC KStarsInterface::setTracking

(

bool

track

)

[pure virtual]

Turn tracking mode on or off.

If tracking is on, then the coordinates at the center of the screen remain fixed with time. If tracking is off, then the sky "drifts" past the screen at the sidereal rate.

Parameters:

track

if TRUE, turn tracking on; otherwise turn it off.

Implemented in KStars.

virtual ASYNC KStarsInterface::shutdownINDI

(

QString

deviceName

)

[pure virtual]

Shotdown a device.

Parameters:

deviceName

The INDI device name

Implemented in KStars.

virtual ASYNC KStarsInterface::startINDI	(	QString	deviceName,
		bool	useLocal
	)			[pure virtual]

Establish the device for an INDI-compatible device.

Parameters:

	deviceName	The INDI device name
	useLocal	If true, starts the device in local mode. Otherwise, in server mode.

Implemented in KStars.

virtual ASYNC KStarsInterface::startINDIExposure	(	QString	deviceName,
		int	timeout
	)			[pure virtual]

Start camera exposure.

Parameters:

	deviceName	The INDI device name
	timeout	Number of seconds to perform exposure.

Implemented in KStars.

virtual ASYNC KStarsInterface::startINDIFocus	(	QString	deviceName,
		int	focusDir
	)			[pure virtual]

Start INDI focus operation in the selected direction.

Parameters:

	deviceName	The INDI device name
	focusDir	Focus direction. If 0, focus in, if 1 focus out

Implemented in KStars.

virtual ASYNC KStarsInterface::switchINDI	(	QString	deviceName,
		bool	turnOn
	)			[pure virtual]

Turn the INDI device on/off.

Parameters:

	deviceName	The INDI device name
	turnOn	If true, the device is switched on, otherwise it is switches off.

Implemented in KStars.

virtual ASYNC KStarsInterface::waitFor

(

double

t

)

[pure virtual]

Pause execution of the script for a given number of seconds.

Parameters:

t

pause interval in seconds

Implemented in KStars.

virtual ASYNC KStarsInterface::waitForINDIAction	(	QString	deviceName,
		QString	action
	)			[pure virtual]

Wait for action to complete (state changed to OK or IDLE).

Parameters:

	deviceName	The INDI device name
	action	The action. The action can be any valid device property. script will pause until the property status becomes OK.

Implemented in KStars.

virtual ASYNC KStarsInterface::waitForKey

(

const QString

k

)

[pure virtual]

Pause execution of the script until a key is pressed.

Parameters:

k

the key which will resume the script

Implemented in KStars.

virtual ASYNC KStarsInterface::writeConfig

(

)

[pure virtual]

write current settings to the config file

Implemented in KStars.

virtual ASYNC KStarsInterface::zoom

(

double

f

)

[pure virtual]

Set the zoomFactor.

The zoomFactor is equal to the number of pixels which subtend one radian of angle.

Parameters:

f

the new zoomFactor

Implemented in KStars.

virtual ASYNC KStarsInterface::zoomIn

(

)

[pure virtual]

Increase the zoomFactor by 10%.

Implemented in KStars.

virtual ASYNC KStarsInterface::zoomOut

(

)

[pure virtual]

Decrease the zoomFactor by 10%.

Implemented in KStars.

---

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

• kstarsinterface.h