Script TheSky  Version 1.30
Public Types | Public Slots | Properties | List of all members
WeatherUtil Class Reference

The WeatherUtil object. More...

Inheritance diagram for WeatherUtil:

Public Types

enum  StartupShutdownStateEnum { StartupShutdownStateUnknown =0, StartupSucceeded =1, ShutdownSucceeded =2 }
 The startup shutdown state. More...
 

Public Slots

bool isStartedUp ()
 Returns true (non-zero) if the imaging system is "started up". More...
 
bool isShutdown ()
 Returns true (non-zero) if the imaging system is shutdown. More...
 
StartupShutdownStateEnum startupShutdownState ()
 Returns the startup/shudown state of the imaging system. More...
 
int lastError ()
 Returns the error code to the last call to statrup or shutdown.
 
int connectAll ()
 Connects all imaging system hardware. More...
 
int disconnectAll ()
 Disconnects all imaging system hardware. More...
 
int startup ()
 Performs an imaging system startup (will connect all hardardware before performing the startup). More...
 
int shutdown ()
 Performs an imaging system shutdown and disconnects all hardware. More...
 
int connectWeatherStation ()
 Connects (just) the weather station.
 
int disconnectWeatherStation ()
 Disconnects (just) the weather station.
 
int weatherUtilDoCommand (int nArg, QString qsArg)
 Software Bisque only.
 

Properties

int autoConnect
 This property controls if TheSky automatically connects to all imaging system hardware when TheSky starts (doing a connectAll() when TheSky starts).
 
int autoStartup
 This property controls if TheSky automatically performs an startup() when the conditions are good to go.
 
int autoShutdown
 This property controls if TheSky automatically performs an shutdown() when the conditions are no go.
 
int scriptedObjectsNoGoAware
 This property controls if TheSky scripted objects are aware of a no go condition. More...
 
int goodToGo
 This property retuns if the conditions are good to go.
 
int isWeatherStationConnected
 This property tells if there is a connection to a weather station.
 
QString doCommandResult
 Software bisque only.
 

Detailed Description

The WeatherUtil object.

The WeatherUtil object allows external programs to be compatable with TheSky's Weather Station Add On.

The Weather Station Add On is not yet available to the general public.

Member Enumeration Documentation

◆ StartupShutdownStateEnum

The startup shutdown state.

See also
startupShutdownState() method that returns this enumeration.
Enumerator
StartupShutdownStateUnknown 

The startup/shutdown state is unknown.

This means a startup or shutdown has never been issued or an error occured during the last startup or shutdown.

See also
lastError
StartupSucceeded 

The startup succeeded.

ShutdownSucceeded 

The shutdown succeeded.

Member Function Documentation

◆ connectAll

int WeatherUtil::connectAll ( )
slot

Connects all imaging system hardware.

Only applies to hardware that has a selection. For example, if there is no dome selected, this method will not attempt a dome connection.

◆ disconnectAll

int WeatherUtil::disconnectAll ( )
slot

Disconnects all imaging system hardware.

Only applies to hardware that has a selection. For example, if there is no dome selected, this method will not attempt a dome disconnection.

◆ isShutdown

bool WeatherUtil::isShutdown ( )
slot

Returns true (non-zero) if the imaging system is shutdown.

The criteria used is lastError must be zero indicating no error on the last shutdown(), along with appropriate criteria for presently used shutdown actions. For the latter, for example, if "Dome Close Slit" is one of the shutdown actions, the dome must be presently closed.

◆ isStartedUp

bool WeatherUtil::isStartedUp ( )
slot

Returns true (non-zero) if the imaging system is "started up".

The criteria used is lastError must be zero indicating no error on the last startup(), along with appropriate criteria for presently used startup actions. For the latter, for example, if "Dome Open Slit" is one of the startup actions, the dome must be presently open.

◆ shutdown

int WeatherUtil::shutdown ( )
slot

Performs an imaging system shutdown and disconnects all hardware.

Note, the weather station is not disconnected if autoStartup or autoShutdown is on so that TheSky can continue to monitor the weather.

See also
startupShutdownState lastError

◆ startup

int WeatherUtil::startup ( )
slot

Performs an imaging system startup (will connect all hardardware before performing the startup).

See also
startupShutdownState lastError

◆ startupShutdownState

StartupShutdownStateEnum WeatherUtil::startupShutdownState ( )
slot

Returns the startup/shudown state of the imaging system.

Disclamier

The state of this variable is maintained only when the startup() and shutdown() methods are used (either interactively or through a scripting interface). The state of this variable can be wrong if any hardware under control fails without providing an error or any hardware involved is changed by a means other than TheSky (i.e. a person on site opens the dome slit manually without using TheSky). The state of this variable is persistent across exit and restart of TheSky without necessarily actually querying hardware so TheSky is "doing the best it can" for all hardware involved (especially hardware that doesn't have reliable hardware feedback on critical hardware states).
In summary, this method provides a convienient means of knowing the success or failure of the last imaging system startup or shutdown.

Property Documentation

◆ scriptedObjectsNoGoAware

int WeatherUtil::scriptedObjectsNoGoAware
readwrite

This property controls if TheSky scripted objects are aware of a no go condition.

When on, attempting to slew the telescope or take a photo with result in an error.

ScriptTheSkyX Examples
(C) Software Bisque, Inc. All rights reserved.