torc::generic::Design Class Reference

#include <Design.hpp>

Inheritance diagram for torc::generic::Design:

Collaboration diagram for torc::generic::Design:

Data Structures
class	Factory

Public Types
typedef VisitorType< Design >	Visitor
typedef std::string	Name
typedef Design	Type
typedef boost::shared_ptr< Type >	Pointer
typedef boost::weak_ptr< Type >	WeakPointer

Public Member Functions
virtual void	accept (BaseVisitor &inoutVisitor) throw (Error)
const std::string	getCellRefName () const
void	setCellRefName (const std::string &inCellRefName)
const std::string	getLibraryRefName () const
void	setLibraryRefName (const std::string &inLibraryRefName)
virtual	~Design () throw ()
virtual const std::string	getName () const
void	setName (const std::string &inSource) throw (Error)
void	addComment (const std::string &comment)
const std::vector< std::string > &	getComments () const
void	setComments (const std::vector< std::string > &inSource)
PropertySharedPtr	getProperty (const std::string &inName)
bool	setProperty (const std::string &inName, const PropertySharedPtr &inProperty)
void	getProperties (std::map< std::string, PropertySharedPtr > &outProperties) const
void	setProperties (const std::map< std::string, PropertySharedPtr > &inSource)
template<typename _Action >
void	applyOnAllProperties (const _Action &action) throw (Error)
virtual Name	getOriginalName () const
virtual void	setOriginalName (const Name &inSource)
const boost::shared_ptr< Root >	getParent () const
virtual void	setParent (const boost::shared_ptr< Root > &inSource)
void	setWeakThis (const WeakPointer &inWeakThis)
Pointer	getSharedThis () const
void	getUserData (std::list< std::string > &outUserData) const
void	setUserData (const std::list< std::string > &inSource)
void	addUserData (const std::string &inSource)
void	getStatuses (std::vector< StatusSharedPtr > &outStatus) const
void	setStatuses (const std::vector< StatusSharedPtr > &inStatus)
void	addStatus (const StatusSharedPtr &inStatus) throw (Error)
template<typename _Action >
void	applyOnAllStatuses (const _Action &action) throw (Error)

Protected Member Functions
	Design ()
	Design (const std::string &inCellRefName, const std::string &inLibraryRefName)

Private Member Functions
	Design (const Design &inSource)
Design &	operator= (const Design &inSource)

Private Attributes
std::string	mCellRefName
std::string	mLibraryRefName

Friends
class	FactoryType< Design >

Detailed Description

The Design class identifies the Cell at the top level of the hierarchy of a particular design within a library.

Definition at line 44 of file generic/Design.hpp.

Member Typedef Documentation

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

inherited

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

typedef boost::shared_ptr<Type> torc::generic::SelfReferencing< Design >::Pointer

inherited

Definition at line 36 of file SelfReferencing.hpp.

typedef Design torc::generic::SelfReferencing< Design >::Type

inherited

Definition at line 35 of file SelfReferencing.hpp.

typedef VisitorType<Design> torc::generic::Design::Visitor

Convenience typedef for visiting a design

Definition at line 54 of file generic/Design.hpp.

typedef boost::weak_ptr<Type> torc::generic::SelfReferencing< Design >::WeakPointer

inherited

Definition at line 37 of file SelfReferencing.hpp.

Constructor & Destructor Documentation

torc::generic::Design::~Design ( ) throw ( )

virtual

Definition at line 62 of file generic/Design.cpp.

{}

torc::generic::Design::Design ( )

protected

Definition at line 53 of file generic/Design.cpp.

               : Nameable(), Commentable(), PropertyContainer(), Renamable(), Visitable(),
    ParentedObject<Root>(), SelfReferencing<Design>(), UserDataContainer(), StatusContainer(),
    mCellRefName(), mLibraryRefName() {}

torc::generic::Design::Design ( const std::string &  inCellRefName, const std::string &  inLibraryRefName  )

protected

Definition at line 57 of file generic/Design.cpp.

                                                                                : Nameable(),
    Commentable(), PropertyContainer(), Renamable(), Visitable(), ParentedObject<Root>(),
    SelfReferencing<Design>(), UserDataContainer(), StatusContainer(), mCellRefName(inCellRefName),
    mLibraryRefName(inLibraryRefName) {}

torc::generic::Design::Design ( const Design &  inSource )

private

Member Function Documentation

void torc::generic::Design::accept ( BaseVisitor &  inoutVisitor ) throw ( Error )

virtual

Implements torc::generic::Visitable.

Definition at line 44 of file generic/Design.cpp.

                                                           {
    try {
        runVisitor(*this, inoutVisitor);
    } catch(Error& e) {
        e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
        throw;
    }
}

Here is the call graph for this function:

void torc::generic::Commentable::addComment ( const std::string &  comment )

inherited

Add a comment to the object

Parameters

[in]

comment

The comment to add to an existing list of comments

Definition at line 36 of file Commentable.cpp.

                                                     {
    mComments.push_back(comment);
}

void torc::generic::StatusContainer::addStatus ( const StatusSharedPtr &  inStatus ) throw ( Error )

inherited

Add a status to the vector of statuses. If an empty pointer is supplied, it returns without doing anything.

Parameters

[in]

inStatus

A pointer to a status object.

Exceptions

Error

Status could not be added.

Add a status to the list of statuses. If an empty pointer is supplied, it returns without doing anything.

Parameters

[in]

inStatus

A pointer to a status object.

Exceptions

Error

Status could not be added.

Definition at line 47 of file StatusContainer.cpp.

                                                                             {
    mStatuses.push_back(inStatus);
}

void torc::generic::UserDataContainer::addUserData ( const std::string &  inSource )

inherited

Add an user data to the list of user data

Parameters

[in]

inSource

An user data as string

Definition at line 34 of file UserDataContainer.cpp.

                                                             {
    mUserData.push_back(inSource);
}

template<typename _Action >

void torc::generic::PropertyContainer::applyOnAllProperties ( const _Action &  action ) throw ( Error )

inlineinherited

Apply action on all properties.

Parameters

[in]

action

Action to be applied

Definition at line 113 of file PropertyContainer.hpp.

                                         {
    try {
        mProperties.applyOnAll(action);
    } catch(Error& e) {
        e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
        throw;
    }
}

Here is the call graph for this function:

template<typename _Action >

void torc::generic::StatusContainer::applyOnAllStatuses ( const _Action &  action ) throw ( Error )

inlineinherited

Apply action on all statuses.

Parameters

[in]

action

Action to be applied

Definition at line 95 of file StatusContainer.hpp.

                  {
    try {
        std::vector<StatusSharedPtr>::iterator it = mStatuses.begin();
        for(; it != mStatuses.end(); ++it) {
            action(*it);
        }
    } catch(Error& e) {
        e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
        throw;
    }
}

Here is the call graph for this function:

const std::string torc::generic::Design::getCellRefName ( ) const

inline

Get the top cell ref name for this Design.

Returns

The top cell ref name for this Design.

Definition at line 130 of file generic/Design.hpp.

                                                    {
    return mCellRefName;
}

const std::vector< std::string > & torc::generic::Commentable::getComments ( ) const

inlineinherited

Get the list of all comments

Returns

A list of all comments on this object

Definition at line 85 of file Commentable.hpp.

                                                                  {
    return mComments;
}

const std::string torc::generic::Design::getLibraryRefName ( ) const

inline

Get the top Library ref name for this Design.

Returns

The top Library ref name for this Design.

Definition at line 139 of file generic/Design.hpp.

                                                       {
    return mLibraryRefName;
}

const std::string torc::generic::Nameable::getName ( void  ) const

inlinevirtualinherited

Get the object name

Returns

Name of the object

Definition at line 89 of file Nameable.hpp.

                                               {
    return mName;
}

Here is the caller graph for this function:

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

inlinevirtualinherited

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:

const boost::shared_ptr<Root > torc::generic::ParentedObject< Root >::getParent ( ) const

inlineinherited

Get a pointer to the parent object

Returns

Pointer to parent

void torc::generic::PropertyContainer::getProperties ( std::map< std::string, PropertySharedPtr > &  outProperties ) const

inlineinherited

Get the map of all properties

Parameters

[out]

outProperties

The map of properties

Get the map of all properties

Returns

The map of properties

Definition at line 107 of file PropertyContainer.hpp.

                                                               {
    mProperties.getValueMap(outProperties);
    return;
}

Here is the call graph for this function:

PropertySharedPtr torc::generic::PropertyContainer::getProperty ( const std::string &  inName )

inherited

Get a property

Parameters

[in]

inName

Name of the property to be retreived

Returns

Pointer to the property object if present, empty pointer otherwise.

Get a property

Parameters

[in]

name

Name of the property to be retreived

Returns

Pointer to the property object if present, empty pointer otherwise.

Definition at line 37 of file PropertyContainer.cpp.

                                                                        {
    PropertySharedPtr property;
    if(!inName.empty()) {
        mProperties.get(inName, property);
    }
    return property;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Pointer torc::generic::SelfReferencing< Design >::getSharedThis ( ) const

inlineinherited

Get a shared pointer to this object. A valid pointer is returned if weakThis was set. Otherwise this returns a NULL pointer. For Vector types, the second scenario is an exception condition and should be treated as such.

Returns

A shared pointer to this object

Get a shared pointer to this object. A valid pointer is returned if weakThis was set. Otherwise this returns a NULL pointer. For Vector types, the second scenario is an exception condition and should be treated as such.

Parameters

[out]

ptr

Set to a shared pointer to this object

void torc::generic::StatusContainer::getStatuses ( std::vector< StatusSharedPtr > &  outStatus ) const

inlineinherited

Get a vector of pointer to Status object

Parameters

[out]

outStatus

The vector of pointer to Status object

Definition at line 86 of file StatusContainer.hpp.

                                                                                    {
    outStatus.insert(outStatus.end(), mStatuses.begin(), mStatuses.end());
}

void torc::generic::UserDataContainer::getUserData ( std::list< std::string > &  outUserData ) const

inlineinherited

Get the list of all userData

Parameters

[out]

outUserData

The list of all userData

Definition at line 78 of file UserDataContainer.hpp.

                                                                                {
    outUserData.insert(outUserData.end(), mUserData.begin(), mUserData.end());
    return;
}

Design& torc::generic::Design::operator= ( const Design &  inSource )

private

void torc::generic::Design::setCellRefName

(

const std::string &

inCellRefName

)

Set the top cell ref name for this Design.

Parameters

[in]

inCellRefName

The top level cell ref name for this design.

Definition at line 64 of file generic/Design.cpp.

                                                          {
    mCellRefName = inCellRefName;
}

void torc::generic::Commentable::setComments ( const std::vector< std::string > &  inSource )

inherited

Get the list of all comments

Parameters

[in]

inSource

A list of all comments to be set on this object

Definition at line 45 of file Commentable.cpp.

                                                                  {
    mComments.insert(mComments.end(), inSource.begin(), inSource.end());
}

void torc::generic::Design::setLibraryRefName

(

const std::string &

inLibraryRefName

)

Set the top Library ref name for this Design.

Parameters

[in]

inLibraryRefName

The top level Library ref name for this design.

Definition at line 68 of file generic/Design.cpp.

                                                                {
    mLibraryRefName = inLibraryRefName;
}

void torc::generic::Nameable::setName ( const std::string &  inSource ) throw ( Error )

inherited

Set a name for this object

Parameters

[in]

inSource

Name of the object

Exceptions

Error

Could not set name, because name is empty (Will be used by array members) Id : eMessageIdErrorEmptyItemName Context Data Nameable - String

Set a name for this object

Parameters

[in]

inSource

Name of the object

Exceptions

Error

Could not set name, because name is empty (Will be used by array members)

Definition at line 41 of file Nameable.cpp.

                                                              {
    if(inSource.empty()) {
        Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
        e.saveContextData("Nameable", inSource);
        throw e;
    }
    mName = inSource;
}

Here is the call graph for this function:

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

virtualinherited

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;
}

virtual void torc::generic::ParentedObject< Root >::setParent ( const boost::shared_ptr< Root > &  inSource )

virtualinherited

Set a pointer to the parent

Parameters

[in]

inSource

Set a pointer to the parent

void torc::generic::PropertyContainer::setProperties ( const std::map< std::string, PropertySharedPtr > &  inSource )

inherited

Set the map of properties

Parameters

[in]

inSource

The map of properties

Definition at line 66 of file PropertyContainer.cpp.

                                                                                          {
    std::map<std::string, PropertySharedPtr>::const_iterator it = inSource.begin();
    for(; it != inSource.end(); it++) {
        setProperty((*it).first, (*it).second);
    }
}

Here is the call graph for this function:

bool torc::generic::PropertyContainer::setProperty ( const std::string &  inName, const PropertySharedPtr &  inProperty  )

inherited

Save the inSource of a property

Parameters

[in]	inName	Name of the property to be saved
[in]	inProperty	Pointer to the property object if present, empty pointer otherwise.

Returns

bool True if saved, false otherwise.

Save the inSource of a property

Parameters

[in]	inName	Name of the property to be saved
[in]	inPoperty	Pointer to the property object if present, empty pointer otherwise.

Returns

bool True if saved, false otherwise.

Definition at line 53 of file PropertyContainer.cpp.

                                         {
    if(!inName.empty()) {
        return mProperties.set(inName, inProperty);
    }
    return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::generic::StatusContainer::setStatuses ( const std::vector< StatusSharedPtr > &  inStatus )

inherited

Set a vector of pointer to Status object

Parameters

[in]

inStatus

The vector of pointer to Status object

Definition at line 32 of file StatusContainer.cpp.

                                                                            {
    std::vector<StatusSharedPtr>::const_iterator it = inStatus.begin();
    for(; it != inStatus.end(); it++) {
        mStatuses.push_back(*it);
    }
}

void torc::generic::UserDataContainer::setUserData ( const std::list< std::string > &  inSource )

inherited

Set the list of userData

Parameters

[in]

inSource

The list of UserData

Definition at line 26 of file UserDataContainer.cpp.

                                                                      {
    mUserData.insert(mUserData.end(), inSource.begin(), inSource.end());
}

void torc::generic::SelfReferencing< Design >::setWeakThis ( const WeakPointer &  inWeakThis )

inlineinherited

Set a weak pointer to this object. This will be used later to get a shared pointer to this object from within other member methods if required. This should be called by the Factory creating the object.

Parameters

[in]

weakThis

A weak pointer to this object

Friends And Related Function Documentation

friend class FactoryType< Design >

friend

Definition at line 48 of file generic/Design.hpp.

Field Documentation

std::string torc::generic::Design::mCellRefName

private

Definition at line 121 of file generic/Design.hpp.

std::string torc::generic::Design::mLibraryRefName

private

Definition at line 122 of file generic/Design.hpp.

---

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

• generic/Design.hpp
• generic/Design.cpp