mfsa_rate_stream::get_idf_info

Source: stream/rate/Mfsa/mfsa_rate_stream__get_idf_info.pro

 mfsa_rate_stream::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
        species         Get the species assumed
        unit            Get the unit for the data.

 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 (after strhelper_lan): 12/6/00; SJT
        Add unit keyword: 27/4/01; SJT
        Added _extra key to swallow unused items: 24/7/01; SJT



James Tappin 2005-02-04