tcc.base.loadInst Namespace Reference

Functions
def	loadInst
	Create an instrument block for the specified instrument. More...

Variables
list	__all__ = ["loadInst"]

Function Documentation

def tcc.base.loadInst.loadInst	(		instDir,
			instName,
			gcViewName = None,
			writeToUsers = None,
			cmd = None
	)

Create an instrument block for the specified instrument.

Parameters

[in]	instDir	path to instrument dir (typically tcc.base.getInstDir())
[in]	instName	name of instrument (e.g. "DIS"); case is ignored; may be an abbreviation if unique
[in]	gcViewName	name of guide camera view; unlike instName, this may not be an abbreviation; if "" or None then no guide camera view is loaded
[in]	writeToUsers	tccActor.writeToUsers or a similar function; if None, write to stdout
[in]	cmd	command (twistedActor.BaseCmd) associated with this request, or None

Returns

an Inst

Exceptions

CommandError

if instrument not found or name not unique

Warning

: does not update the AxeLim block (you must do that separately)

Definition at line 12 of file loadInst.py.

Variable Documentation

list tcc.base.loadInst.__all__ = ["loadInst"]

Definition at line 10 of file loadInst.py.