Page History

...

This class allows iteration over a collection of "odfInXtcs" (odf = online data flow)Xtc" objects. An "event" generated from DataFlow consists of data described by a collection of "odfInXtcsXtc" objects. Therefore, this class is instrumental in the navigation of an event's data. The set of "odfInXtcsXtc"s is determined by passing (typically to the constructor) a root "odfInXtcXtc" which describes the collection of "odfInXtcsXtc"s to process. This root, for example is provided by an event's datagram. As this is an Abstract-Base-Class, it is expected that an application will subclass from this class, providing an implementation of the "process" method. This method will be called back for each "odfInXtcXtc" in the collection. Note that the "odfInXtcXtc" to process is passed as an argument. If the "process" method wishes to abort the iteration a zero (0) value is returned. The iteration is initiated by calling the "iterate" member function.

...

    XtcIterator(Xtc* root); 
    XtcIterator() {}
    virtual ~XtcIterator() {}

...

    void      iterate();     

This function commences iteration over the collection specified by the constructor.

...

    const Xtc* root()  const; 

This function returns the collection specified by the constructor.