PlaceRep.h

Go to the documentation of this file.

#ifndef OPAL_PlaceRep_HH
#define OPAL_PlaceRep_HH

// ------------------------------------------------------------------------
// $RCSfile: PlaceRep.h,v $
// ------------------------------------------------------------------------
// $Revision: 1.2 $
// ------------------------------------------------------------------------
// Copyright: see Copyright.readme
// ------------------------------------------------------------------------
//
// Class: PlaceRep
//
// ------------------------------------------------------------------------
//
// $Date: 2001/08/24 19:35:03 $
// $Author: jsberg $
//
// ------------------------------------------------------------------------

#include <string>
#include <vector>
#include <iosfwd>//tream>

class FlaggedElmPtr;


// Class PlaceRep
// ------------------------------------------------------------------------
//  This representation holds data to keep track wether the place was
//  already passed when tracking through the line.  The place may be
//  one of the following:
//  [ul]
//  [li]"#S", the start of the beam line.
//  [li]"#E", the end of the beam line.
//  [li]"SELECTED", all selected positions (flag set in FlaggedElmPtr).
//  [li]name[occurrence]::name[occurrence]..., denoting a specific place.
//  [/ul]

class PlaceRep {

public:

    //  Constructs undefined place.
    PlaceRep();

    //  Used for places like "#S", "#E", "SELECTED".
    explicit PlaceRep(const std::string &);

    PlaceRep(const PlaceRep &);
    ~PlaceRep();
    const PlaceRep &operator=(const PlaceRep &);

    void append(const std::string &, int occur);

    //  Sets the internal state to the beginning of the line.
    void initialize();

    //  Sets the internal state to active, when the specified place is
    //  entered.
    void enter(const FlaggedElmPtr &) const;

    //  Sets the internal state to inactive, when the specified place is
    //  left.
    void leave(const FlaggedElmPtr &) const;

    //  Returns true, if we are at the specified place.
    bool isActive() const;

    //  Returns true, if the place has the value "SELECTED".
    bool isSelected() const;

    void print(std::ostream &os) const;

private:

    typedef std::vector<std::pair<std::string, int> > Data;
    Data data;

    // If true, this place refers to "SELECTED"
    bool is_selected;

    // If true, we are at this position.
    mutable bool status;

    // Ancillary variable, keeps track of levels seen.
    mutable Data::size_type seen;
};


inline std::ostream &operator<<(std::ostream &os, const PlaceRep &data) {
    data.print(os);
    return os;
}

#endif // OPAL_PlaceRep_HH