LocFieldSubSet.hpp

Go to the documentation of this file.

#ifndef LocFieldSubSet_H
#define LocFieldSubSet_H

#include "LocSubSet.hpp"

namespace OA {

class LocFieldSubSet : public LocSubSet {
  public:
    LocFieldSubSet(OA_ptr<Location> loc, std::string fieldName)
        : LocSubSet(loc), mFieldName(fieldName) { }

    LocFieldSubSet(LocFieldSubSet &other) 
        : LocSubSet(other), mFieldName(other.mFieldName) {}

    ~LocFieldSubSet() { }

    void acceptVisitor(LocationVisitor& pVisitor);

    //*****************************************************************
    // LocSubSet subclass type methods 
    //*****************************************************************
    bool isaFieldSubSet() { return true; }
    
    //*****************************************************************
    // Info methods 
    //*****************************************************************
    bool isFull() { return false; }
    string getFieldName() { return mFieldName;}

    //*****************************************************************
    // Relationship methods, will be defined in subclasses 
    //*****************************************************************
    bool operator<(Location & other);
    bool operator==(Location& other);
    
    bool mayOverlap(Location& other);

    bool mustOverlap(Location& other);

    bool subSetOf(Location& other);

    //*****************************************************************
    // Annotation Interface
    //*****************************************************************
    void output(IRHandlesIRInterface& ir);

    //*****************************************************************
    // Debugging
    //*****************************************************************
    void dump(std::ostream& os);
    void dump(std::ostream& os, OA_ptr<IRHandlesIRInterface> pIR);

    std::string toString(OA_ptr<IRHandlesIRInterface> pIR);

    virtual int getOrder() { return sOrder; }

  private:
    string mFieldName;
    static const int sOrder = 500;
};

} // end namespace
#endif