---

ogs::core::details::Description Class Reference

A detail that describes some aspect of an object. More...

#include <Description.h>

Inheritance diagram for ogs::core::details::Description:

[legend]Collaboration diagram for ogs::core::details::Description:

[legend]List of all members.

Public Types
enum	Aspect { NAME, PERSONALITY, APPEARANCE, BACKGROUND }
	An enumerated type that represents the aspect of a description.
Public Member Functions
	Description (Aspect aspect, const std::string &text)
	Create a new description.
Aspect	getAspect () const
	Determine the aspect of this description.
std::string	getText () const
	Determine the text of this description.
void	setText (const std::string &text)
	Change the text of this description.

---

Detailed Description

Predefined aspects include personality, appearance, and background. These aspects are not validated in any way; nonstandard aspects can also be substituted.

---

Constructor & Destructor Documentation

ogs::core::details::Description::Description (  Aspect  aspect, const std::string &  text )  [inline]

Parameters: aspect  Aspect of description. text  Text of description.

---

Member Function Documentation

Description::Aspect ogs::core::details::Description::getAspect (   )  const [inline]

Returns: Aspect of this description.

std::string ogs::core::details::Description::getText (   )  const [inline]

Returns: Text of this description.

void ogs::core::details::Description::setText (  const std::string &  text  )  [inline]

Parameters: text  Text of this description.

---

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

• Description.h

---