MultiAgentDecisionProcess  Release 0.2.1
SimulationAgent Class Reference

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

#include <SimulationAgent.h>

+ Inheritance diagram for SimulationAgent:

Public Member Functions

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

Private Attributes

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

Detailed Description

SimulationAgent represents an agent in for class Simulation.

Definition at line 37 of file SimulationAgent.h.

Constructor & Destructor Documentation

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

(default) Constructor

Definition at line 52 of file SimulationAgent.h.

virtual SimulationAgent::~SimulationAgent ( )
inlinevirtual

Destructor.

Definition at line 56 of file SimulationAgent.h.

Member Function Documentation

virtual Index SimulationAgent::GetIndex ( ) const
inlinevirtual

Retrieves the index of this agent.

Definition at line 59 of file SimulationAgent.h.

References _m_id.

Referenced by AgentRandom::Act(), AgentQMDP::Act(), AgentPOMDP::Act(), AgentBG::Act(), AgentBG::AgentBG(), AgentBG::GetMaximizingBGIndex(), and SoftPrint().

virtual bool SimulationAgent::GetVerbose ( ) const
inlinevirtual

If true, the agent will report more.

Definition at line 68 of file SimulationAgent.h.

References _m_verbose.

void SimulationAgent::Print ( ) const
inline

Print out some information about this agent.

Definition at line 82 of file SimulationAgent.h.

References SoftPrint().

virtual void SimulationAgent::ResetEpisode ( )
pure virtual

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

Implemented in AgentBG, AgentPOMDP, AgentQMDP, and AgentRandom.

virtual void SimulationAgent::SetIndex ( Index  id)
inlinevirtual

Sets the index of this agent.

Definition at line 62 of file SimulationAgent.h.

References _m_id.

virtual void SimulationAgent::SetVerbose ( bool  verbose)
inlinevirtual

Set whether this agent should be verbose.

Definition at line 65 of file SimulationAgent.h.

References _m_verbose.

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

Return some information about this agent.

Definition at line 74 of file SimulationAgent.h.

References GetIndex().

Referenced by Print().

Member Data Documentation

Index SimulationAgent::_m_id
private

The index of this SimulationAgent, should be unique.

Definition at line 42 of file SimulationAgent.h.

Referenced by GetIndex(), and SetIndex().

bool SimulationAgent::_m_verbose
private

Whether we want the agent to be verbose.

Definition at line 45 of file SimulationAgent.h.

Referenced by GetVerbose(), and SetVerbose().


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