Base class for objects that contain a std::string label.
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
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 56 of file Teuchos_LabeledObject.hpp.