LIGO.gif

The getFrameCache User Command (Meta Macro)

All user commands have the form:

ldasJob { -name {} -password {} -email {} } { userCmd -opt1 {} ... }

Which is in the format of a Tcl command, ldasJob, with two required arguments:

  1. A Tcl list of user information consisting of username, password, and e-mail address. All fields must be filled or the command will be rejected.
    Client software which would like to receive responses from the LDAS system on a port instead of through email can provide a hostname:port combination as the email argument. A further feature of this method is that the hostname can be replaced with the magic key !host!, and the LDAS system will use the IP address it finds by doing a peername lookup on the connected socket.
  2. A user command in the form of a Tcl list, for which there exists a "meta" macro file which can be expanded into Tcl code which can then be evaluated by the LDAS system.
    An argument need not be provided for every option. Some options have default values and these are described below as appropriate.
    Meta macros consist of a prototype declaration of the arguments for the given user command, and a template describing the calling order of API specific blocks of Tcl code which are concatenated into a larger block comprising the complete request, which can then be distributed by the assistant manager for interpretation by the low level API's.
    These API specific blocks are maintained as API specific macro files consisting of immediately interpretable Tcl code.
There are individual API specific getData user commands for retrieving frame data, metadata, and LIGO lightweight data:

getFrameCache arrow_right.gif