tcc.parse.getRestart Namespace Reference

Functions
def	getRestart
	Get a list of axes from the /Restart qualifier. More...

Variables
list	__all__ = ["getRestart"]
dictionary	_TranslateDict
tuple	_AllAxesList = ("azimuth", "altitude", "rotator")

Function Documentation

def tcc.parse.getRestart.getRestart	(		qual,
			rotExists
	)

Get a list of axes from the /Restart qualifier.

Todo:

: tweak this once we figure out how the parser handles /Restart vs /Restart=(); for now assume that the values are [] if present with no values and treat this as "all"

Useful because the parser returns the data as named axes and the names are negatable.

Parameters

[in]	qual	the parsed /Restart qualifier
[in]	rotExists	does the current instrument have a rotator? If False, the returned restartRot is always false (even if the user requested restarting the rotator)

Returns

a tuple of 3 booleans: (restartAz, restartAlt, restartRot). If /Restart is omitted or specified with no values then return the default for the qualifier (but set restartRot false if rotExists false)

Exceptions

twistedActor.CommandError

if an axis is explicitly specified and negated, e.g. /Restart=(Az, NoAz); the test ignores "all" and "noall" (they are not explicit), so this is permitted: /Restart=(All, NoAz) Also raise a CommandError if a /NoRestart qualifier was used with any axis.

Definition at line 15 of file getRestart.py.

Variable Documentation

list tcc.parse.getRestart.__all__ = ["getRestart"]

Definition at line 5 of file getRestart.py.

tuple tcc.parse.getRestart._AllAxesList = ("azimuth", "altitude", "rotator")

Definition at line 13 of file getRestart.py.

dictionary tcc.parse.getRestart._TranslateDict

Initial value:

= {
    "tel1": "azimuth",
    "tel2": "altitude",
}

Definition at line 7 of file getRestart.py.