NamedDescribedEntity Class Reference

NamedDescribedEntity represents named entities. More...

#include <NamedDescribedEntity.h>

Inheritance diagram for NamedDescribedEntity:

Public Member Functions
std::string	GetDescription () const
	Get the description of the NamedDescribedEntity. More...
std::string	GetName () const
	Get the name of the NamedDescribedEntity. More...
	NamedDescribedEntity (const std::string &name=std::string("undefined"), const std::string &description=std::string("undefined"))
	(default) Constructor More...
void	Print () const
	Prints the name and description (by default). More...
void	PrintBrief () const
	Prints the name (by default). More...
void	SetDescription (const std::string &description)
	Set the description. More...
void	SetName (const std::string &name)
	Set the name. More...
virtual std::string	SoftPrint () const
	Returns the name and description (if not reimplemented). More...
virtual std::string	SoftPrintBrief () const
	Returns the name (if not reimplemented). More...
virtual	~NamedDescribedEntity ()
	Destructor. More...

Protected Attributes
std::string	_m_description
	The description. More...
std::string	_m_name
	The name. More...

Detailed Description

NamedDescribedEntity represents named entities.

For example actions and observations in a decision process.

Constructor & Destructor Documentation

NamedDescribedEntity::NamedDescribedEntity	(	const std::string &	name = std::string("undefined"),
		const std::string &	description = std::string("undefined")
	)

(default) Constructor

virtual NamedDescribedEntity::~NamedDescribedEntity ( )

inlinevirtual

Destructor.

Member Function Documentation

std::string NamedDescribedEntity::GetDescription ( ) const

inline

Get the description of the NamedDescribedEntity.

References _m_description.

Referenced by MultiAgentDecisionProcess::GetDescription(), SoftPrint(), StateFactorDiscrete::SoftPrint(), and MultiAgentDecisionProcess::SoftPrint().

std::string NamedDescribedEntity::GetName ( ) const

inline

Get the name of the NamedDescribedEntity.

References _m_name.

Referenced by TransitionObservationIndependentMADPDiscrete::CreateJointStates(), FactoredDecPOMDPDiscrete::ExportSpuddFile(), MultiAgentDecisionProcess::GetName(), TransitionObservationIndependentMADPDiscrete::GetState(), MultiAgentDecisionProcessDiscreteFactoredStates::Initialize2DBN(), PlanningUnitMADPDiscrete::PolicyToDotGraph(), SoftPrint(), StateFactorDiscrete::SoftPrint(), MultiAgentDecisionProcess::SoftPrint(), SoftPrintBrief(), PlanningUnitMADPDiscrete::SoftPrintObservationHistory(), and MADPComponentFactoredStates::SoftPrintPartialState().

void NamedDescribedEntity::Print ( ) const

inline

Prints the name and description (by default).

References SoftPrint().

void NamedDescribedEntity::PrintBrief ( ) const

inline

Prints the name (by default).

References SoftPrintBrief().

void NamedDescribedEntity::SetDescription ( const std::string &  description )

inline

Set the description.

Referenced by TransitionObservationIndependentMADPDiscrete::CreateJointStates(), MADPComponentFactoredStates::GetState(), TransitionObservationIndependentMADPDiscrete::GetState(), and MultiAgentDecisionProcess::SetDescription().

void NamedDescribedEntity::SetName ( const std::string &  name )

inline

Set the name.

Referenced by TransitionObservationIndependentMADPDiscrete::CreateJointStates(), MADPComponentFactoredStates::GetState(), TransitionObservationIndependentMADPDiscrete::GetState(), and MultiAgentDecisionProcess::SetName().

string NamedDescribedEntity::SoftPrint ( ) const

virtual

Returns the name and description (if not reimplemented).

Reimplemented in StateFactorDiscrete.

References GetDescription(), and GetName().

Referenced by TOICompactRewardDecPOMDPDiscrete::GetReward(), Print(), and TransitionObservationIndependentMADPDiscrete::SoftPrintActionSets().

string NamedDescribedEntity::SoftPrintBrief ( ) const

virtual

Returns the name (if not reimplemented).

References GetName().

Referenced by PlanningUnitDecPOMDPDiscrete::ExportDecPOMDPFile(), AlphaVectorPlanning::ExportPOMDPFile(), PrintBrief(), ProblemFireFighting::ProblemFireFighting(), SimulationDecPOMDPDiscrete::RunSimulations(), ActionObservationHistory::SoftPrint(), ObservationHistory::SoftPrint(), SimulationFactoredDecPOMDPDiscrete::Step(), SimulationDecPOMDPDiscrete::Step(), and SimulationTOIDecPOMDPDiscrete::Step().

Member Data Documentation

std::string NamedDescribedEntity::_m_description

protected

The description.

Referenced by GetDescription().

std::string NamedDescribedEntity::_m_name

protected

The name.

Referenced by GetName().