generic_dataset__define

Source: dataset/generic/generic_dataset__define.pro

 GENERIC_DATASET
        Define the characteristics common to all dataset objects. It
        is intended that this class should be inherited by all of the
        more specific datasets, on its own it's not too useful.

 Members:
        Name            string  The name to identify the dataset.
        Type            string  What type of dataset is it (RATE,
                                SPECT, PAD etc. 
        top             object  The hs_container object.
        Tstart          double  Start time, Julian day
        Tstop           double  End time, Julian day
        Nstreams        int     How many streams does it have?
        kev             byte    Does the dataset use energies in
                                keV?
        process_class   long    Flags to indicate any special
                                characteristics of the dataset
        hs_plot         object  A plot-control object specific to the
                                dataset, if it's not a valid object
                                then the environment version is used.
        markers         pointer A pointer to a series of markers to be
                                added to the plot.
        Status:                 Flags to indicate the stauts of the
                                dataset
                Ready   byte    Is the dataset ready to display
                Read    byte    Has raw data been read
                Defined byte    Have the time and streams been defined
                Drawn   byte    Is the display up to date
        Streams         pointer A pointer to an array of object
                                references for the data streams.
        menu_id         long    The widget ID of a menu for the dataset
        changeflag      byte    Has the dataset been changed sinve the
                                last environment save.

 History:
        Pre-experimental version: 16/11/99; SJT
        Add menu id: 21/6/00; SJT
        Add locked flag to status flags: 6/7/00; SJT
        Add member documentation: 1/8/01; SJT
        Remove locked flag: 12/4/02; SJT



James Tappin 2005-02-04