MultiAgentDecisionProcess  Release 0.2.1
NamedDescribedEntity Class Reference

NamedDescribedEntity represents named entities. More...

#include <NamedDescribedEntity.h>

+ Inheritance diagram for NamedDescribedEntity:
+ Collaboration diagram for NamedDescribedEntity:

Public Member Functions

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

Protected Attributes

std::string * _m_description
 Pointer to the description.
std::string * _m_name
 Pointer to the name.

Detailed Description

NamedDescribedEntity represents named entities.

For example actions and observations in a decision process.

Definition at line 39 of file NamedDescribedEntity.h.

Constructor & Destructor Documentation

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

(default) Constructor

Definition at line 35 of file NamedDescribedEntity.cpp.

NamedDescribedEntity::NamedDescribedEntity ( const NamedDescribedEntity a)

copy constructor.

Copy assignment constructor.

Definition at line 41 of file NamedDescribedEntity.cpp.

References DEBUG_NDE, GetDescription(), and GetName().

NamedDescribedEntity::~NamedDescribedEntity ( )
virtual

Destructor.

Definition at line 47 of file NamedDescribedEntity.cpp.

References DEBUG_NDE.

Member Function Documentation

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

Prints the name and description (by default).

Reimplemented in TransitionObservationIndependentMADPDiscrete, MultiAgentDecisionProcessDiscrete, TOIDecPOMDPDiscrete, and MultiAgentDecisionProcess.

Definition at line 79 of file NamedDescribedEntity.h.

References SoftPrint().

void NamedDescribedEntity::PrintBrief ( ) const
inline

Prints the name (by default).

Definition at line 81 of file NamedDescribedEntity.h.

References SoftPrintBrief().

void NamedDescribedEntity::SetDescription ( std::string  description)
inline
void NamedDescribedEntity::SetName ( std::string  name)
inline

Member Data Documentation

std::string* NamedDescribedEntity::_m_description
protected

Pointer to the description.

Definition at line 47 of file NamedDescribedEntity.h.

Referenced by GetDescription(), and SetDescription().

std::string* NamedDescribedEntity::_m_name
protected

Pointer to the name.

Definition at line 45 of file NamedDescribedEntity.h.

Referenced by GetName(), and SetName().


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