PowerControl Class Reference

TheSky PowerControl object. More...

Inheritance diagram for PowerControl:

Public Slots
int	connect ()
	Establishes communication between this power control object and the power control hardware. More...
int	disconnect ()
	Terminate the communication between this power control object and the power control hardware. More...
int	circuitState (const int &nZeroBasedIndex)
	Determine (read) the current state of a circuit. More...
int	setCircuitState (const int &nZeroBasedIndex, const bool &bZeroForOffOneForOn)
	Set the state of a circuit. More...
int	circuitLabel (const int &nZeroBasedIndex)
	Returns the label associated with the circuit addressed by nZeroBasedIndex. More...
int	setCircuitLabel (const int &nZeroBasedIndex, const QString &qsLabel)
	Sets the label associated with the circuit addressed by nZeroBasedIndex. More...

Properties
int	isConnected
	This property determines if this object is connected to the power control hardware or not.
int	numberOfCircuits
	Returns the number of circuits (outlets) that can be controlled by this power control hardware. More...
int	circuitStateResult
	This property holds the result of calling the method circuitState(), i.e. More...
QString	circuitLabelResult
	This property holds the result of calling the method circuitLabel(), i.e. More...
int	autoguider
	This property determines if this object represents the imager or the autoguider. More...

Detailed Description

TheSky PowerControl object.

This object allows scripted control of TheSky's power control. This object was added in TheSky build 12809 (see Application.build).

Member Function Documentation

circuitLabel

int PowerControl::circuitLabel ( const int &  nZeroBasedIndex )

slot

Returns the label associated with the circuit addressed by nZeroBasedIndex.

After calling this method, the result is held in the property circuitaLabelResult.

Parameters

nZeroBasedIndex

(in) the index of the circuit, starting at zero to 1-number of circuits.

See also

circuitaLabelResult Possible method return values

circuitState

int PowerControl::circuitState ( const int &  nZeroBasedIndex )

slot

Determine (read) the current state of a circuit.

After calling this method, the result is held in the property circuitStateResult.

Parameters

nZeroBasedIndex

(in) the index of the circuit, starting at zero to 1-number of circuits.

See also

circuitStateResult Possible method return values

connect

int PowerControl::connect ( )

slot

Establishes communication between this power control object and the power control hardware.

Possible method return values

disconnect

int PowerControl::disconnect ( )

slot

Terminate the communication between this power control object and the power control hardware.

Possible method return values

setCircuitLabel

int PowerControl::setCircuitLabel ( const int &  nZeroBasedIndex, const QString &  qsLabel  )

slot

Sets the label associated with the circuit addressed by nZeroBasedIndex.

Parameters

nZeroBasedIndex	(in) the index of the circuit, starting at zero to 1-number of circuits.
qsLabel	(in) the text label. Possible method return values

setCircuitState

int PowerControl::setCircuitState ( const int &  nZeroBasedIndex, const bool &  bZeroForOffOneForOn  )

slot

Set the state of a circuit.

Parameters

nZeroBasedIndex	(in) the index of the circuit, starting at zero to 1-number of circuits.
bZeroForOffOneForOn	(in) the desired state of a circuit. bZeroForOffOneForOn will be zero (0) to set the circuit off and one (1) to set the circuit on. Possible method return values

Property Documentation

autoguider

int PowerControl::autoguider

readwrite

This property determines if this object represents the imager or the autoguider.

A value of zero, the default, is the imager while a value of 1 is the autoguider).

circuitLabelResult

QString PowerControl::circuitLabelResult

read

This property holds the result of calling the method circuitLabel(), i.e.

the text label associated with the circuit.

circuitStateResult

int PowerControl::circuitStateResult

read

This property holds the result of calling the method circuitState(), i.e.

the current state of a circuit. A circuitStateResult zero (0) means the circuit is off and one (1) to indicates the circuit is on.

numberOfCircuits

int PowerControl::numberOfCircuits

read

Returns the number of circuits (outlets) that can be controlled by this power control hardware.

This property is only valid when connected.