The getFrameElements 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 must be provided to every option field for any given command or the command will be rejected.
   Some option fields will accept a "null" argument consisting of a matching pair of braces "{}" with no interposed space.
   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.

• getFrameElements

• getFrameElements

  Returns data extracted from frames in several formats.

  Calling convention (all on a single line):

  ldasJob   { -name   "username"   -password   "********"   -email   "user@foobar.edu"}   {getFrameElements   -returnprotocol   URL   -outputformat   {Tcl list}   -frametarget   name_of_an_api   -framequery   {Tcl list} }

  Option Descriptions:

  -outputformat:     frame ilwd LIGO_LW

  Default: "{ilwd binary}"
  The argument of the -returnformat option is the data type to use in formatting the result of the user request.
  The possible output formats which the system can produce, which include binary frames, ilwd ascii, ilwd binary and LIGO_LW (an XML format) can be specified, i.e. {ilwd ascii}.

  -frametarget:     {}

  Optional: defaults to null string
  The argument of the -target option is the name of a known LDAS API. The result output from the frame API will be registered with the named API to be used as input data for the code with the same job i.d. that the data is tagged with.
  
  List of frame accessors

  Return to Top