AuctionBase.h

Go to the documentation of this file.

#ifndef   _GAMS_AUCTIONS_AUCTION_BASE_H_
#define   _GAMS_AUCTIONS_AUCTION_BASE_H_

#include <vector>
#include <string>
#include <map>

#include "madara/knowledge/KnowledgeBase.h"
#include "madara/knowledge/containers/Map.h"

#include "AuctionTypesEnum.h"
#include "gams/groups/GroupBase.h"
#include "gams/groups/GroupFixedList.h"
#include "gams/GamsExport.h"

#include "gams/auctions/AuctionBid.h"

namespace gams
{
  namespace auctions
  {
    class GAMS_EXPORT AuctionBase
    {
    public:
      AuctionBase (const std::string & auction_prefix = "",
        const std::string & agent_prefix = "",
        madara::knowledge::KnowledgeBase * knowledge = 0);

      virtual ~AuctionBase ();

      virtual void add_group (groups::GroupBase * group);

      virtual void clear_group (void);

      virtual bool is_member (const std::string & agent_prefix) const;

      virtual madara::knowledge::KnowledgeRecord get_bid (
        const std::string & id);

      virtual void set_agent_prefix (const std::string & prefix);

      virtual void set_auction_prefix (const std::string & prefix);

      virtual void set_knowledge_base (
        madara::knowledge::KnowledgeBase * knowledge);

      virtual void sync (void);

      const std::string & get_agent_prefix (void) const;

      const std::string & get_auction_prefix (void) const;

      virtual double get_participation (void) const;

      void bid (const madara::knowledge::KnowledgeRecord & amount);

      virtual void bid (const std::string & agent,
        const madara::knowledge::KnowledgeRecord & amount);

      virtual std::string get_leader (void) = 0;

      virtual void get_bids (AuctionBids & bids,
        bool strip_prefix = true,
        bool include_all_members = false) const;

      virtual void advance_round (void);

      int get_round (void) const;

      virtual void reset_round (void);

      void set_round (int round);

      std::string get_auction_round_prefix (void) const;

    protected:

      void reset_bids_pointer (void);

      mutable madara::knowledge::KnowledgeBase * knowledge_;

      std::string auction_prefix_;

      std::string agent_prefix_;

      int round_;

      madara::knowledge::containers::Map bids_;

      groups::GroupFixedList group_;
    };
  }
}

#include "AuctionBase.inl"

#endif // _GAMS_AUCTIONS_AUCTION_BASE_H_