torc::generic::Renamable Class Reference

Represents objects that can be renamed. More...

#include <Renamable.hpp>

Inheritance diagram for torc::generic::Renamable:

Collaboration diagram for torc::generic::Renamable:

Public Types
typedef std::string	Name

Public Member Functions
virtual Name	getOriginalName () const
virtual void	setOriginalName (const Name &inSource)
virtual	~Renamable () throw ()

Protected Member Functions
	Renamable ()

Private Member Functions
	Renamable (const Renamable &)
Renamable &	operator= (const Renamable &)

Private Attributes
Name	mOriginalName

Detailed Description

Represents objects that can be renamed.

EDIF provides a way to store displayable string values with different objects using the (rename ...) construct. The Renamable interface will be generalized by objects that need to support this feature.

Definition at line 35 of file generic/Renamable.hpp.

Member Typedef Documentation

typedef std::string torc::generic::Renamable::Name

Definition at line 40 of file generic/Renamable.hpp.

Constructor & Destructor Documentation

torc::generic::Renamable::Renamable ( )

protected

Definition at line 39 of file generic/Renamable.cpp.

                     :
    mOriginalName() {}

torc::generic::Renamable::~Renamable ( ) throw ( )

virtual

Definition at line 42 of file generic/Renamable.cpp.

{}

torc::generic::Renamable::Renamable ( const Renamable &  )

private

Member Function Documentation

Renamable::Name torc::generic::Renamable::getOriginalName ( ) const

inlinevirtual

Get the new name provided for the object.

Returns

Name of the object

Definition at line 78 of file generic/Renamable.hpp.

                                                      {
    return mOriginalName;
}

Here is the caller graph for this function:

Renamable& torc::generic::Renamable::operator= ( const Renamable &  )

private

void torc::generic::Renamable::setOriginalName ( const Name &  inSource )

virtual

Set the new name provided for the object.

Parameters

[in]

inSource

Name of the object

Definition at line 35 of file generic/Renamable.cpp.

                                                             {
    mOriginalName = inSource;
}

Field Documentation

Name torc::generic::Renamable::mOriginalName

private

Definition at line 70 of file generic/Renamable.hpp.

---

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

• generic/Renamable.hpp
• generic/Renamable.cpp