generic_dataset::get_stream_info

Source: dataset/generic/generic_dataset__get_stream_info.pro

 generic_dataset::get_stream_info
        Return info about the streams attached to a particular
        dataset.

 Usage:
        info=dsref -> get_stream_info(<key>)

 Keywords:
        index   int     Set this key to return properties for just one
                        stream rather than for all streams.
        count           If set, then return how many streams there are.
        panel_count     If set, then return how many streams in each
                        panel of the dataset (returns 0 for simple datasets).
        n_panel         If set, then return how many panels the datset
                        has (returns 0 for simple datasets)
        names           If set, then return the names of the streams.
        channel         If set, then return the names of the channels.
        type            If set, then return the types of stream.
        references      If set, then return the object references (use
                        with care, destroying the objects will break
                        the whole dataset).
        description     If set, then get the IDF description of the stream
        id              If set, then get the quick type ID of the stream.
        derived         If set, then get whether the stream(s) are
                        derived or not.
        support_ephemeris       If set, then return whether the
                                streams can be plotted against
                                ephemeris quantities.
        hidden          If set, then return the state of the hidden
                        flag for the stream(s).
        visible_only    If set, then only return values for visible
                        streams.


 History:
        Initial version: 18/11/99; SJT
        Add new keys: 7/12/99; SJT
        Add description key: 18/1/00; SJT
        Add ID key: 2/2/00; SJT
        Add derived key: 17/7/00; SJT
        Add hiding stuff: 10/4/01; SJT



James Tappin 2005-02-04