World.hpp

Go to the documentation of this file.

#ifndef __OPENTREP_BOM_WORLD_HPP
#define __OPENTREP_BOM_WORLD_HPP

// //////////////////////////////////////////////////////////////////////
// Import section
// //////////////////////////////////////////////////////////////////////
// STL
#include <ostream>
#include <istream>
#include <string>
// OpenTrep
#include <opentrep/OPENTREP_Types.hpp>
#include <opentrep/bom/BomAbstract.hpp>
#include <opentrep/bom/GenericBom.hpp>
#include <opentrep/bom/PlaceList.hpp>

namespace OPENTREP {
  
  class World : public BomAbstract {
    friend class FacWorld;
    friend class DbaWorld;
  public:
    // //////////// Getters /////////////
    const PlaceOrderedList_T& getSimplePlaceList () const {
      return _placeOrderedList;
    }
    
    // //////////// Setters /////////////

    
    // ///////// Display methods ////////
    void toStream (std::ostream&) const;

    void fromStream (std::istream&);

    std::string toString() const;

    std::string describeKey() const;

    std::string describeShortKey() const;
    
    std::string display() const;

    std::string shortDisplay() const;

    GenericBom_T getGenericBom (const XapianDocID_T& iDocID) const;
    
  private:
    World ();
    World (const World&);
    
    virtual ~World();
    
  private:
    GenericBomList_T _genericBomList;
    
    // PlaceDirectList_T _placeList;
    
    PlaceOrderedList_T _placeOrderedList;
  };

  // ///////////// Type definitions ////////////////////
  typedef std::size_t WorldID_T;
  
}
#endif // __OPENTREP_BOM_WORLD_HPP