Source: stream/helpers/lan/strhelper_lan__get_idf_info.pro
strhelper_lan::get_idf_info
Return some or all of the IDF info on a data stream.
Usage:
info = strref -> get_idf_info(<keys>)
Keywords:
name Get the channel name
description Get a description of the channel
energy Get the mid-point energy
erange Get the minimum & maximum energy
geometry Get the geometry factor.
sectors Get the number of sectors available.
duty Get the nominal duty cycle.
location Get the location in the record.
cadence Get the cadence of the channel
mgroup Get the "mgroup" of the channel
Notes:
If no keys are given, then the whole IDF info structure is
returned. The keys have the priorty as above. Background,
being independently settable has its own get as well.
History:
Original: 20/12/99; SJT
Moved to strhelper_lan class: 21/12/99; SJT
Add cadence: 1/2/00; SJT
Modify energy unit handling: 24/3/00; SJT
Add mgroup key: 14/7/00; SJT
Added _extra key to swallow unused items: 24/7/01; SJT