MultiAgentDecisionProcess
SimulationAgent Class Referenceabstract

SimulationAgent represents an agent in for class Simulation. More...

#include <SimulationAgent.h>

Inheritance diagram for SimulationAgent:
[legend]

Public Member Functions

virtual Index GetIndex () const
 Retrieves the index of this agent. More...
 
virtual bool GetVerbose () const
 If true, the agent will report more. More...
 
void Print () const
 Print out some information about this agent. More...
 
virtual void ResetEpisode ()=0
 Will be called before an episode, to reinitialize the agent. More...
 
virtual void SetIndex (Index id)
 Sets the index of this agent. More...
 
virtual void SetVerbose (bool verbose)
 Set whether this agent should be verbose. More...
 
 SimulationAgent (Index id, bool verbose=false)
 (default) Constructor More...
 
virtual std::string SoftPrint () const
 Return some information about this agent. More...
 
virtual ~SimulationAgent ()
 Destructor. More...
 

Private Attributes

Index _m_id
 The index of this SimulationAgent, should be unique. More...
 
bool _m_verbose
 Whether we want the agent to be verbose. More...
 

Detailed Description

SimulationAgent represents an agent in for class Simulation.

Constructor & Destructor Documentation

SimulationAgent::SimulationAgent ( Index  id,
bool  verbose = false 
)
inline

(default) Constructor

virtual SimulationAgent::~SimulationAgent ( )
inlinevirtual

Destructor.

Member Function Documentation

virtual Index SimulationAgent::GetIndex ( ) const
inlinevirtual
virtual bool SimulationAgent::GetVerbose ( ) const
inlinevirtual

If true, the agent will report more.

void SimulationAgent::Print ( ) const
inline

Print out some information about this agent.

References SoftPrint().

virtual void SimulationAgent::ResetEpisode ( )
pure virtual

Will be called before an episode, to reinitialize the agent.

Implemented in AgentQLearner, AgentBG, AgentMDP, AgentPOMDP, AgentQMDP, AgentRandom, and AgentOnlinePlanningMDP.

virtual void SimulationAgent::SetIndex ( Index  id)
inlinevirtual

Sets the index of this agent.

virtual void SimulationAgent::SetVerbose ( bool  verbose)
inlinevirtual

Set whether this agent should be verbose.

virtual std::string SimulationAgent::SoftPrint ( void  ) const
inlinevirtual

Return some information about this agent.

References GetIndex().

Referenced by Print().

Member Data Documentation

Index SimulationAgent::_m_id
private

The index of this SimulationAgent, should be unique.

bool SimulationAgent::_m_verbose
private

Whether we want the agent to be verbose.