torc::physical::Renamable< T > Class Template Reference

Concept for any object that can be renamed. More...

#include <Renamable.hpp>

Inheritance diagram for torc::physical::Renamable< T >:

Collaboration diagram for torc::physical::Renamable< T >:

Public Member Functions
	Renamable (const string &inName)
	Constructor which must specify the object name. More...
void	deprecatedSetName (const string &inName)
	Illegally sets the object name. More...
const string &	getName (void) const
	Returns the object name. More...
bool	operator== (const Named &rhs) const
	Equality operator. More...

Protected Types
typedef std::string	string
	Imported type name. More...

Protected Member Functions
void	setName (const string &inName)
	Sets the object name. More...

Protected Attributes
string	mName
	The name of the object. More...

Friends
class	Progenitor< T >
	The Progenitor class has access to our internals. More...

Detailed Description

template<class T>
class torc::physical::Renamable< T >

Concept for any object that can be renamed.

Definition at line 42 of file physical/Renamable.hpp.

Member Typedef Documentation

template<class T>

typedef std::string torc::physical::Renamable< T >::string

protected

Imported type name.

Definition at line 46 of file physical/Renamable.hpp.

Constructor & Destructor Documentation

template<class T>

torc::physical::Renamable< T >::Renamable ( const string &  inName )

inline

Constructor which must specify the object name.

Parameters

inName

The object name.

Definition at line 57 of file physical/Renamable.hpp.

: Named(inName) {}

Member Function Documentation

template<class T>

void torc::physical::Renamable< T >::deprecatedSetName ( const string &  inName )

inline

Illegally sets the object name.

Deprecated:

.

Definition at line 61 of file physical/Renamable.hpp.

{ mName = inName; }

const string& torc::physical::Named::getName ( void  ) const

inlineinherited

Returns the object name.

Definition at line 51 of file Named.hpp.

{ return mName; }

Here is the caller graph for this function:

bool torc::physical::Named::operator== ( const Named &  rhs ) const

inlineinherited

Equality operator.

Definition at line 54 of file Named.hpp.

{ return mName == rhs.mName; }

template<class T>

void torc::physical::Renamable< T >::setName ( const string &  inName )

inlineprotected

Sets the object name.

Definition at line 52 of file physical/Renamable.hpp.

{ mName = inName; }

Friends And Related Function Documentation

template<class T>

friend class Progenitor< T >

friend

The Progenitor class has access to our internals.

Definition at line 49 of file physical/Renamable.hpp.

Field Documentation

string torc::physical::Named::mName

protectedinherited

The name of the object.

Definition at line 43 of file Named.hpp.

---

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

• physical/Renamable.hpp