#include <Teuchos_LabeledObject.hpp>
Public Member Functions | |
LabeledObject () | |
Construct with an empty label. | |
virtual | ~LabeledObject () |
| |
virtual void | setObjectLabel (const std::string &objectLabel) |
Set the object label (see LabeledObject). | |
virtual std::string | getObjectLabel () const |
Get the object label (see LabeledObject). |
The object label std::string objectLabel
set in setObjectLabel()
should be a simple one-line label given to an object to differentiate it from all other objects. A subclass implementation can define a default label in some cases but typically this label is designed for end users to set to give the object a name that is meaningful to the user. The label should not contain any information about the actual type of the object. Adding type information is appropriate in the Describable
interface, which inherits from this interface.
This base class provides a default implementation for the functions setObjectLabel()
and getObjectLabel()
as well as private data to hold the label. Subclasses can override these functions but general, there should be no need to do so.
Definition at line 55 of file Teuchos_LabeledObject.hpp.
Teuchos::LabeledObject::LabeledObject | ( | ) |
Teuchos::LabeledObject::~LabeledObject | ( | ) | [virtual] |
std::string Teuchos::LabeledObject::getObjectLabel | ( | ) | const [virtual] |
void Teuchos::LabeledObject::setObjectLabel | ( | const std::string & | objectLabel | ) | [virtual] |