![]() |
ldasJob { -name {} -password {} -email {} } { userCmd -opt1 {} ... }
Which is in the format of a Tcl command, ldasJob, with two required arguments:
Returns list of channel names and types, and optionally all metadata for the channel types requested. By default the names of all Adc and Proc channels are returned in a 'list of lists' paired with their type as an all uppercase string indicating 'ADC' or 'PROC' as appropriate. In addition to the default Adc and Proc types, SIM and SERIAL channel types are also supported and can be specified using the -channeltypes option.
An exception is generated if the filename provided (or the calcualted filename when no explicit filename is provided) does not exist or is not readable due to permission problems.
An e-mail with a URL pointing to the location of the results file is sent (-returnprotocol http or ftp is supported for retrieval of the file by mailcap/mime-types).
Calling convention (all on a single line):
ldasJob { -name "username" -password "********" -email "user@foobar.edu"} {getChannels -returnprotocol URL -interferometer IFO Abbrev -directory directory under ::MOUNT_PT -filename full path to frame file -frametype frame type -channeltypes list of channel types -metadata boolean (0 or 1) -time GPS time }
Option Descriptions:
-returnprotocol:
http ftp file port
The http, ftp, and file options
cause a URL pointer to the location of the results to be
returned by e-mail. Any directory structure in the location
will be ignored, the filename and extension will be used
unless they are found to break system conventions for
mime typing.
NOTES:
-interferometer: Valid IFO
-directory: {}
-filename: {}
-frametype: {}
-channeltypes: {adc proc}
-metadata: Integer values ( 0,1,2 ) or any combination of the following:
{ {CH_1 ADC} {CH_2 ADC} {CH_3 PROC} }
When it is set to 1 or ALL the command returns a 'list of lists'
of N elements where elements 0 and 1 are the channel name and type
as when the option is 0, and elements 2 through N are each
a list consisting of a name value pair like name=value or
possibly {name=string value}:
{ {CH_1 ADC name1=value {name2=extra value} ... } {CH_2 ADC ... } }
When this option is set to 2 or EXTENDED_ALL,
the result is the same as for option 1
but there may be more entries of the form name=value. Both standard
metadata and extended metadata will be returned.
While this may seem cumbersome it is compact and can be parsed
easily in Tcl.
-time: Valid GPS time
Default: http://some_sensible_name.ext
The argument to -returnprotocol resembles the usual
browser conventions for URL's, but is actually only a
hinting mechanism for the user to get a URL back in e-mail
or in a client.
The possible formats of the argument are:
Optional: defaults to best guess based on other options
The argument of the -interferometers option is an interferometer
(ifo) abbreviation as used in the file naming convention and
corresponding to the file name prefix of the frame files created
from that interferometer.
This option is used together with the -time and -frametype
options to specify a frame file with the desired list of channels.
Optional: defaults to the first directory in the cache
If this argument is provided, then the most recent file in
the directory will be used to generate the list. If the
specified directory contains frames from multiple interferometes,
the -interferometer option can be used to specify which is
wanted.
Optional: defaults to best guess based on directory and ifo
If this argument is provided, the filename given will be used
regardless of other options.
Optional: defaults to R
The argument to the -frametype option is the frame type or comment
field as used in the frame file naming convention. This corresponds
to the second field of the frame file name.
This option is used together with the -time and -interferometer
options to specify a frame file with the desired list of channels.
Optional: defaults to Adc and Proc
The list of channel types to report. The default includes both
Adc and Proc at present.
Supported channel types are Adc, Proc, Sim, and Ser individually
or in any combination.
ADC PROC SIM SER ALL EXTENDED_ADC EXTENDED_PROC EXTENDED_SIM EXTENDED_SER EXTENDED_ALL
Optional: defaults to 0 (off)
When this option is set to 0the command returns a list of
channel names and channel types as a 'list of lists', i.e.:
Note that the channel type will be all uppercase and can be one of
ADC PROC SIM or SERIAL.
Optional: defaults to most recent file in directory
The argument to the -time option is a GPS time for which frame data exists.
This option is used together with the -frametype and -interferometer
options to specify a frame file with the desired list of channels.
Return to Top