GAMS  1.4.0
gams::auctions::AuctionMinimumBidFactory Class Reference

Factory for creating minimum-bid auctions. More...

#include <AuctionMinimumBid.h>

Inheritance diagram for gams::auctions::AuctionMinimumBidFactory:
gams::auctions::AuctionFactory

Public Member Functions

 AuctionMinimumBidFactory ()
 Constructor. More...
 
virtual ~AuctionMinimumBidFactory ()
 Destructor. More...
 
virtual AuctionBasecreate (const std::string &auction_prefix="", const std::string &agent_prefix="", madara::knowledge::KnowledgeBase *knowledge=0)
 Creates a minimum-bid auction. More...
 
void set_agent_prefix (const std::string &prefix)
 Sets the prefix for the current bidding agent. More...
 
void set_knowledge (madara::knowledge::KnowledgeBase *knowledge)
 Sets the knowledge base. More...
 

Protected Attributes

std::string agent_prefix_
 self prefix of the agent More...
 
madara::knowledge::KnowledgeBase * knowledge_
 knowledge base containing variables More...
 

Detailed Description

Factory for creating minimum-bid auctions.

Definition at line 101 of file AuctionMinimumBid.h.

Constructor & Destructor Documentation

◆ AuctionMinimumBidFactory()

gams::auctions::AuctionMinimumBidFactory::AuctionMinimumBidFactory ( )

Constructor.

◆ ~AuctionMinimumBidFactory()

virtual gams::auctions::AuctionMinimumBidFactory::~AuctionMinimumBidFactory ( )
virtual

Destructor.

Member Function Documentation

◆ create()

virtual AuctionBase* gams::auctions::AuctionMinimumBidFactory::create ( const std::string &  auction_prefix = "",
const std::string &  agent_prefix = "",
madara::knowledge::KnowledgeBase *  knowledge = 0 
)
virtual

Creates a minimum-bid auction.

Parameters
auction_prefixthe name of the auction(e.g. auction.position)
agent_prefixthe name of this bidder(e.g. agent.0)
knowledgethe knowledge base to use for syncing
Returns
the new group

Implements gams::auctions::AuctionFactory.

◆ set_agent_prefix()

void gams::auctions::AuctionFactory::set_agent_prefix ( const std::string &  prefix)
inherited

Sets the prefix for the current bidding agent.

Parameters
prefixthe name of the agent(e.g. agent.0)

◆ set_knowledge()

void gams::auctions::AuctionFactory::set_knowledge ( madara::knowledge::KnowledgeBase *  knowledge)
inherited

Sets the knowledge base.

Parameters
knowledgethe knowledge base to use

Member Data Documentation

◆ agent_prefix_

std::string gams::auctions::AuctionFactory::agent_prefix_
protectedinherited

self prefix of the agent

Definition at line 112 of file AuctionFactory.h.

◆ knowledge_

madara::knowledge::KnowledgeBase* gams::auctions::AuctionFactory::knowledge_
protectedinherited

knowledge base containing variables

Definition at line 115 of file AuctionFactory.h.


The documentation for this class was generated from the following file: