sky6MyFOVs Class Reference

The sky6MyFOVs object. More...

Inheritance diagram for sky6MyFOVs:

Public Types
enum	sk6MyFOVProperty {   sk6MyFOVProp_Visible = 0, sk6MyFOVProp_PositionAngleDegrees = 1, sk6MyFOVProp_ReferenceFrame = 2, sk6MyFOVProp_OffsetEastWestArcMinutes = 3,   sk6MyFOVProp_OffsetNorthSouthArcMinutes = 4, sk6MyFOVProp_Scale = 5, sk6MyFOVProp_Elem_Description = 6, sk6MyFOVProp_Elem_Shape = 7,   sk6MyFOVProp_Elem_XSize = 8, sk6MyFOVProp_Elem_YSize = 9, sk6MyFOVProp_Elem_XOffset = 10, sk6MyFOVProp_Elem_YOffset = 11,   sk6MyFOVProp_Elem_XPixels = 12, sk6MyFOVProp_Elem_YPixels = 13 }
	The FOV property enum. More...
enum	sk6MyFOVReferenceFrame { sk6MyFOVRefFrame_Screen = 0, sk6MyFOVRefFrame_Equatorial = 1, sk6MyFOVRefFrame_Telescope = 2, sk6MyFOVRefFrame_TelescopeMask = 3 }
	The FOV refernece frame enum. More...
enum	sk6MyFOVElement {   sk6MyFOVElement_1 = 0, sk6MyFOVElement_2 = 1, sk6MyFOVElement_3 = 2, sk6MyFOVElement_4 = 3,   sk6MyFOVElement_5 = 4, sk6MyFOVElement_6 = 5, sk6MyFOVElement_7 = 6, sk6MyFOVElement_8 = 7,   sk6MyFOVElement_9 = 8, sk6MyFOVElement_10 = 9, sk6MyFOVElement_11 = 10, sk6MyFOVElement_12 = 11,   sk6MyFOVElement_13 = 12, sk6MyFOVElement_14 = 13, sk6MyFOVElement_15 = 14, sk6MyFOVElement_16 = 15,   sk6MyFOVElement_17 = 16, sk6MyFOVElement_18 = 17, sk6MyFOVElement_19 = 18, sk6MyFOVElement_20 = 19 }
	The FOV element enum, must be zero (0).
enum	sk6MyFOVShape { sk6MyFOVShape_Circle = 0, sk6MyFOVShape_Rectangle = 1, sk6MyFOVShape_Marker = 2, sk6MyFOVShape_Telrad = 3 }
	The FOV shape enum, not supported.

Public Slots
void	Property (QString FOVIName, sk6MyFOVElement Element, sk6MyFOVProperty Prop)
	Returns a value for the desired sk6MyFOVProperty argument from a FOVI. More...
void	setProperty (QString DectorName, sk6MyFOVElement Element, sk6MyFOVProperty Prop, QVariant vVal)
	This method is not supported, read only access to FOVI is only supported.
void	Name (int Index)
	For FOV with Index, returns the name of the FOV in the OutString() property.
void	Fill (sk6MyFOVReferenceFrame rf, sk6MyFOVShape shape, sk6MyFOVElement elem)
	This method is not supported.

Public Member Functions
	Q_ENUMS (sk6MyFOVElement)
	Q_ENUMS (sk6MyFOVProperty)
	Q_ENUMS (sk6MyFOVReferenceFrame)
	Q_ENUMS (sk6MyFOVShape)

Properties
int	Count
	This propery holds the number of FOVIs defined in TheSky. More...
QString	OutString
	This property holds the result of calling the Name() method. More...
QVariant	OutVar
	This property holds the result of calling the Property() method. More...

Detailed Description

The sky6MyFOVs object.

The sky6MyFOVs object provides scripted access to TheSky Field of View Indicators and their properties.

Beware of these restrictions:

The MyFOVs object:

Gives access to properties by detector name only.

Does not yet give access to FOV elements.

Does not give the ability to Add or Delete FOVs via script. This must be done within TheSky.

Member Enumeration Documentation

sk6MyFOVProperty

enum sky6MyFOVs::sk6MyFOVProperty

The FOV property enum.

Enumerator
sk6MyFOVProp_Visible	0 - FOVI element is not visible, 1 - FOVI element is visible.
sk6MyFOVProp_PositionAngleDegrees	Position angle of the FOVI in decimal degrees.
sk6MyFOVProp_ReferenceFrame	Frame of reference for the FOVI.
sk6MyFOVProp_OffsetEastWestArcMinutes	The east-west offset (in arcminutes) of the current element from the center of the FOVI.
sk6MyFOVProp_OffsetNorthSouthArcMinutes	The north-south offset (in arcminutes) of the current element from the center of the FOVI.
sk6MyFOVProp_Scale	The scale of this FOVI element (in arcseconds per pixel).
sk6MyFOVProp_Elem_Description	THIS PROPERTY IS NOT CURRENTLY SUPPORTED.
sk6MyFOVProp_Elem_Shape	THIS PROPERTY IS NOT CURRENTLY SUPPORTED.
sk6MyFOVProp_Elem_XSize	THIS PROPERTY IS NOT CURRENTLY SUPPORTED.
sk6MyFOVProp_Elem_YSize	THIS PROPERTY IS NOT CURRENTLY SUPPORTED.
sk6MyFOVProp_Elem_XOffset	THIS PROPERTY IS NOT CURRENTLY SUPPORTED.
sk6MyFOVProp_Elem_YOffset	THIS PROPERTY IS NOT CURRENTLY SUPPORTED.
sk6MyFOVProp_Elem_XPixels	THIS PROPERTY IS NOT CURRENTLY SUPPORTED.
sk6MyFOVProp_Elem_YPixels	THIS PROPERTY IS NOT CURRENTLY SUPPORTED.

sk6MyFOVReferenceFrame

enum sky6MyFOVs::sk6MyFOVReferenceFrame

The FOV refernece frame enum.

Enumerator
sk6MyFOVRefFrame_Screen	FOVI is displayed at a position relative to the center of the computer screen.
sk6MyFOVRefFrame_Equatorial	FOVI is displayed at a position relative an absolute right ascension/declination.
sk6MyFOVRefFrame_Telescope	FOVI is displayed at a position relative to the position of the telescope cross hairs (the FOVI replaces the telescope cross hairs).
sk6MyFOVRefFrame_TelescopeMask	FOVI is displayed as a mask.

Member Function Documentation

Property

void sky6MyFOVs::Property ( QString  FOVIName, sk6MyFOVElement  Element, sk6MyFOVProperty  Prop  )

slot

Returns a value for the desired sk6MyFOVProperty argument from a FOVI.

The result of calling this function resides in the OutVar() property.

Parameters

FOVIName	The name of the desired FOVI.
Element	The desired element (a value of zero is only supported).
Prop	The desired property.

Property Documentation

Count

sky6MyFOVs::Count

read

This propery holds the number of FOVIs defined in TheSky.

Go from index to FOV name by the Name() method.

See also

Name()

OutString

sky6MyFOVs::OutString

read

This property holds the result of calling the Name() method.

See also

Name()

OutVar

sky6MyFOVs::OutVar

read

This property holds the result of calling the Property() method.

See also

Property()