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 ( )


Member Function Documentation

std::string NamedDescribedEntity::GetDescription ( ) const
void NamedDescribedEntity::Print ( ) const

Prints the name and description (by default).

References SoftPrint().

void NamedDescribedEntity::PrintBrief ( ) const

Prints the name (by default).

References SoftPrintBrief().

string NamedDescribedEntity::SoftPrint ( ) const

Returns the name and description (if not reimplemented).

Reimplemented in StateFactorDiscrete.

References GetDescription(), and GetName().

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

Member Data Documentation

std::string NamedDescribedEntity::_m_description

The description.

Referenced by GetDescription().

std::string NamedDescribedEntity::_m_name

The name.

Referenced by GetName().