Ksetiwatch API Documentation

Overview Class Hierarchy Classes Classes (annotated) Members Source Files Related Pages

LocSettings Struct Reference

Settings and options of a S@h location. More...

#include <setiloc.h>

Collaboration diagram for LocSettings:

Collaboration graph
[legend]
List of all members.

Public Attributes

QString description
QString directory
bool useCustomStartExe
QString customStartExe
bool useCustomStopExe
QString customStopExe
QColor color
QString arguments
bool startSeti
bool stopSeti
bool keepClientAlive
bool log
bool redirectLog
QString logDirectory
bool stopAfterProcess
bool stopAfterSend
bool email
bool graphics
int priority
bool useProxy
QString proxyServer
int proxyPort

Detailed Description

Settings and options of a S@h location.

Definition at line 28 of file setiloc.h.

Member Data Documentation

QString LocSettings::description
 

A descriptive name for the location.

Definition at line 30 of file setiloc.h.

Referenced by SetiLoc::description(), AddSetiLocDlg::options(), Ksetiwatch::readConfig(), Ksetiwatch::saveConfig(), SetiLoc::SetiLoc(), and AddSetiLocDlg::setOptions().

QString LocSettings::directory
 

The working directory of the S@h location.

Definition at line 32 of file setiloc.h.

Referenced by AddSetiLocDlg::options(), Ksetiwatch::readConfig(), Ksetiwatch::saveConfig(), SetiLoc::SetiLoc(), SetiLoc::setOptions(), and AddSetiLocDlg::setOptions().

bool LocSettings::useCustomStartExe
 

If TRUE, the executable specified in LocSettings::customStartExe is used to start the S@h client.

Definition at line 36 of file setiloc.h.

Referenced by AddSetiLocDlg::options(), Ksetiwatch::readConfig(), Ksetiwatch::saveConfig(), AddSetiLocDlg::setOptions(), and SetiLoc::startClient().

QString LocSettings::customStartExe
 

Path and file name of a user-defined executable to start the S@h client.

Only used if LocSettings::useCustomStartExe is TRUE, otherwise the standard S@h client in LocSettings::directory is used.

Definition at line 42 of file setiloc.h.

Referenced by AddSetiLocDlg::options(), Ksetiwatch::readConfig(), Ksetiwatch::saveConfig(), AddSetiLocDlg::setOptions(), and SetiLoc::startClient().

bool LocSettings::useCustomStopExe
 

If TRUE, the executable specified in LocSettings::customStopExe is used to stop the S@h client.

Definition at line 46 of file setiloc.h.

Referenced by AddSetiLocDlg::options(), Ksetiwatch::readConfig(), Ksetiwatch::saveConfig(), AddSetiLocDlg::setOptions(), and SetiLoc::stopClient().

QString LocSettings::customStopExe
 

Path and file name of a user-defined executable to stop the S@h client.

Only used if LocSettings::useCustomStopExe is TRUE, otherwise the S@h client will be stopped by sending a SIGTERM signal.

Definition at line 52 of file setiloc.h.

Referenced by AddSetiLocDlg::options(), Ksetiwatch::readConfig(), Ksetiwatch::saveConfig(), AddSetiLocDlg::setOptions(), and SetiLoc::stopClient().

QColor LocSettings::color
 

The color used for the markers in the skymap.

Definition at line 54 of file setiloc.h.

Referenced by SetiLoc::color(), AddSetiLocDlg::options(), Ksetiwatch::readConfig(), Ksetiwatch::saveConfig(), SetiLoc::SetiLoc(), and AddSetiLocDlg::setOptions().

QString LocSettings::arguments
 

A string with the command-line arguments passed to the S@h client.

Definition at line 57 of file setiloc.h.

Referenced by AddSetiLocDlg::options(), Ksetiwatch::readConfig(), Ksetiwatch::saveConfig(), SetiLoc::setOptions(), AddSetiLocDlg::setOptions(), and SetiLoc::startClient().

bool LocSettings::startSeti
 

If TRUE, the S@h client is started on start-up of Ksetiwatch.

Definition at line 60 of file setiloc.h.

Referenced by AddSetiLocDlg::options(), SetiLoc::optionStartSeti(), Ksetiwatch::readConfig(), Ksetiwatch::saveConfig(), and AddSetiLocDlg::setOptions().

bool LocSettings::stopSeti
 

If TRUE, the S@h client is stopped on shut-down of Ksetiwatch.

Definition at line 63 of file setiloc.h.

Referenced by AddSetiLocDlg::options(), SetiLoc::optionStopSeti(), Ksetiwatch::readConfig(), Ksetiwatch::saveConfig(), and AddSetiLocDlg::setOptions().

bool LocSettings::keepClientAlive
 

If TRUE, Ksetiwatch tries to restart the S@h client whenever it stops running without user intervention.

Definition at line 66 of file setiloc.h.

Referenced by SetiLoc::optionKeepClientAlive(), AddSetiLocDlg::options(), Ksetiwatch::readConfig(), Ksetiwatch::saveConfig(), and AddSetiLocDlg::setOptions().

bool LocSettings::log
 

If TRUE, the results of a completed WU are logged.

Definition at line 68 of file setiloc.h.

Referenced by SetiLoc::checkWUStatus(), AddSetiLocDlg::options(), Ksetiwatch::readConfig(), Ksetiwatch::saveConfig(), and AddSetiLocDlg::setOptions().

bool LocSettings::redirectLog
 

If TRUE, the results of a completed WU are redirected to the directory specified in LocSettings::logDirectory.

If FALSE, the results are stored in the working directory of the client.

Definition at line 73 of file setiloc.h.

Referenced by CompletedWUList::checkForRedirect(), SetiLoc::logDirectory(), AddSetiLocDlg::options(), Ksetiwatch::readConfig(), Ksetiwatch::saveConfig(), and AddSetiLocDlg::setOptions().

QString LocSettings::logDirectory
 

The directory where the results of the completed WUs are stored.

Only used if LocSettings::log is TRUE.

Definition at line 76 of file setiloc.h.

Referenced by SetiLoc::logDirectory(), AddSetiLocDlg::options(), Ksetiwatch::readConfig(), Ksetiwatch::saveConfig(), and AddSetiLocDlg::setOptions().

bool LocSettings::stopAfterProcess
 

If TRUE, the client is stopped after processing a WU.

Definition at line 79 of file setiloc.h.

Referenced by AddSetiLocDlg::options(), Ksetiwatch::readConfig(), Ksetiwatch::saveConfig(), AddSetiLocDlg::setOptions(), and SetiLoc::startClient().

bool LocSettings::stopAfterSend
 

If TRUE, the client is stopped after sending the results of the last WU.

Definition at line 82 of file setiloc.h.

Referenced by AddSetiLocDlg::options(), Ksetiwatch::readConfig(), Ksetiwatch::saveConfig(), AddSetiLocDlg::setOptions(), and SetiLoc::startClient().

bool LocSettings::email
 

If TRUE, an email is sent to the user in case of an error.

Definition at line 85 of file setiloc.h.

Referenced by AddSetiLocDlg::options(), Ksetiwatch::readConfig(), Ksetiwatch::saveConfig(), AddSetiLocDlg::setOptions(), and SetiLoc::startClient().

bool LocSettings::graphics
 

If TRUE, the client produces a data stream for the xsetiathome graphics program.

Definition at line 88 of file setiloc.h.

Referenced by AddSetiLocDlg::options(), Ksetiwatch::readConfig(), Ksetiwatch::saveConfig(), AddSetiLocDlg::setOptions(), and SetiLoc::startClient().

int LocSettings::priority
 

The priority of the S@h client.

Ranges from 1 to 19. Higher values indicate a higher priority. A value of 1 corresponds to a nice level of 19.

Definition at line 92 of file setiloc.h.

Referenced by AddSetiLocDlg::options(), Ksetiwatch::readConfig(), Ksetiwatch::saveConfig(), AddSetiLocDlg::setOptions(), and SetiLoc::startClient().

bool LocSettings::useProxy
 

If TRUE, a proxy server is used to connect to the S@h server.

Definition at line 95 of file setiloc.h.

Referenced by AddSetiLocDlg::options(), Ksetiwatch::readConfig(), Ksetiwatch::saveConfig(), AddSetiLocDlg::setOptions(), and SetiLoc::startClient().

QString LocSettings::proxyServer
 

The proxy server via which to connect to the S@h server.

Definition at line 98 of file setiloc.h.

Referenced by AddSetiLocDlg::options(), Ksetiwatch::readConfig(), Ksetiwatch::saveConfig(), AddSetiLocDlg::setOptions(), and SetiLoc::startClient().

int LocSettings::proxyPort
 

The port of the proxy server.

Definition at line 100 of file setiloc.h.

Referenced by AddSetiLocDlg::options(), Ksetiwatch::readConfig(), Ksetiwatch::saveConfig(), AddSetiLocDlg::setOptions(), and SetiLoc::startClient().

The documentation for this struct was generated from the following file:
KDE Logo
This file is part of the documentation for Ksetiwatch API Version 2.6.1.
Documentation copyright © 2000-2003 Gordon Machel.
Generated on Fri Jun 6 00:28:48 2003 by doxygen 1.2.18, written by Dimitri van Heesch, © 1997-2002