Represents an EDIF cell. More...

#include <Cell.hpp>

Inheritance diagram for torc::generic::Cell:

Collaboration diagram for torc::generic::Cell:

Data Structures
class	Factory

Public Types
enum	Type { eTypeTie = 0, eTypeRipper, eTypeGeneric }

typedef VisitorType< Cell >	Visitor

typedef std::string	Name

typedef boost::shared_ptr< Type >	Pointer

typedef boost::weak_ptr< Type >	WeakPointer

Public Member Functions
virtual void	accept (BaseVisitor &inoutVisitor) throw (Error)

const Type	getType () const

void	setType (const Type &inSource)

void	addView (const ViewSharedPtr &inView) throw (Error)

ViewSharedPtr	findView (const std::string &inName)

void	removeView (const std::string &inName) throw (Error)

void	getViews (std::vector< ViewSharedPtr > &outViews) const

template<typename _Action >
void	applyOnAllViews (const _Action &action) throw (Error)

virtual	~Cell () throw ()

void	addComment (const std::string &comment)

const std::vector< std::string > &	getComments () const

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

bool	getIsExtern () const

bool	isExtern () const

void	setIsExtern (bool inIsExtern)

virtual const std::string	getName () const

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

const boost::shared_ptr< Library >	getParent () const

virtual void	setParent (const boost::shared_ptr< Library > &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)

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
	Cell ()

Private Member Functions
	Cell (const Cell &rhs)

Cell &	operator= (const Cell &rhs)

Private Attributes
SymTab< std::string, ViewSharedPtr >	mViewSymTab

Type	mType

ParameterMapSharedPtr	mParameters

Friends
class	FactoryType< Cell >

Detailed Description

Represents an EDIF cell.

The Cell class is used to implement an EDIF cell object. It contains the different views of a cell. A cell can be concrete or extern (black-box).

Note: Currently parser performs semantic checks for GENERIC type only. Programattic creation may be achieved. However, a warning may be emitted when cell type is set to TIE or RIPPER.

Definition at line 55 of file Cell.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< Cell >::Pointer

inherited

Definition at line 36 of file SelfReferencing.hpp.

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

Convenience class to visit a Cell.

Definition at line 78 of file Cell.hpp.

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

inherited

Definition at line 37 of file SelfReferencing.hpp.

Member Enumeration Documentation

enum torc::generic::Cell::Type

Type of cell.

Enumerator
eTypeTie
eTypeRipper
eTypeGeneric

Definition at line 71 of file Cell.hpp.

               {
         eTypeTie = 0, eTypeRipper, eTypeGeneric
     };

Constructor & Destructor Documentation

torc::generic::Cell::~Cell	(	)
throw	(
	)

virtual

Definition at line 169 of file Cell.cpp.

169 {}

torc::generic::Cell::Cell ( )

protected

Definition at line 165 of file Cell.cpp.

            : Commentable(), Extern(), Nameable(), ParentedObject<Library>(), PropertyContainer(),
     Renamable(), Visitable(), SelfReferencing<Cell>(), UserDataContainer(), StatusContainer(),
     mViewSymTab(), mType(eTypeGeneric) {}

torc::generic::Cell::Cell ( const Cell & rhs )

private

Member Function Documentation

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

virtual

Implements torc::generic::Visitable.

Definition at line 81 of file Cell.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);
 }

void torc::generic::Cell::addView	(	const ViewSharedPtr &	inView	)
throw	(	Error
	)

Add a view to the list of views. An empty pointer will be ignored. If an view already exists in EDIF file in same cell, parser ignores the view.

Parameters

[in] inView Pointer to a view.

Exceptions

Error	Empty View type Id : eMessageIdErrorEmptyItemName
Error	View name already exists Id : eMessageIdErrorItemAlreadyExists

Add a view to the list of views. An empty pointer will be ignored.

Parameters

[in] inView Pointer to a view.

Exceptions

Error	Empty View type
Error	View name already exists

Definition at line 108 of file Cell.cpp.

                                                             {
     if(!inView) {
         return;
     }
     std::string name = inView->getName();
     if(name.empty()) {
         Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Empty View type", name);
         throw e;
     }
     if(false == mViewSymTab.set(name, inView)) {
         Error e(eMessageIdErrorItemAlreadyExists, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("View name", name);
         throw e;
     }
     inView->setParent(getSharedThis());
 }

Here is the call graph for this function:

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:

template<typename _Action >

void torc::generic::Cell::applyOnAllViews	(	const _Action &	action	)
throw	(	Error
	)

inline

Apply action on all Views.

Parameters

[in] action Action to be applied

Definition at line 224 of file Cell.hpp.

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

Here is the call graph for this function:

ViewSharedPtr torc::generic::Cell::findView ( const std::string & inName )

Find a view by name.

Parameters

[in] inName Name of the cell to be found.

Returns: Pointer to cell if found, empty pointer otherwise.

Exceptions

Error

Empty Cell name

Id : eMessageIdErrorEmptyItemName
Context Data
- Cell name - String

Find a view by name.

Parameters

[in] inName Name of the cell to be found.

Returns: Pointer to cell if found, empty pointer otherwise.

Definition at line 133 of file Cell.cpp.

                                                     {
     if(inName.empty()) {
         Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Empty Cell name", inName);
         throw e;
     }
     ViewSharedPtr view;
     mViewSymTab.get(inName, view);
     return view;
 }

Here is the call graph for this function:

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

bool torc::generic::Extern::getIsExtern ( ) const

inlineinherited

Get whether the item is an extern(placeholder) or an actual item.

Returns: True if extern, false otherwise

Definition at line 86 of file Extern.hpp.

                                       {
     return mIsExtern;
 }

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<Library > torc::generic::ParentedObject< Library >::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< Cell >::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());
 }

const Cell::Type torc::generic::Cell::getType ( void ) const

inline

Get the type of cell

Returns: Type of cell

Definition at line 211 of file Cell.hpp.

                                           {
     return mType;
 }

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

void torc::generic::Cell::getViews ( std::vector< ViewSharedPtr > & outViews ) const

inline

Get the views of this cell.

Parameters

[out] outViews List of views to be appended to

Get the views of this cell.

Returns: A list of views of this cell.

Definition at line 220 of file Cell.hpp.

                                                                    {
     mViewSymTab.getValues(outViews);
 }

Here is the call graph for this function:

bool torc::generic::Extern::isExtern ( ) const

inlineinherited

Get whether the item is an extern(placeholder) or an actual item.

Returns: True if extern, false otherwise

Definition at line 95 of file Extern.hpp.

                                    {
     return mIsExtern;
 }

Cell& torc::generic::Cell::operator= ( const Cell & rhs )

private

void torc::generic::Cell::removeView	(	const std::string &	inName	)
throw	(	Error
	)

Remove the specified pointer from the view. Empty pointer is ignored.

Parameters

[in] inName name of the object to be removed

Exceptions

Error View is not a member of the views list.

Remove the specified pointer from the view. Empty pointer is ignored.

Parameters

[in] inName name of object to be removed

Exceptions

Error View is not a member of the views list.

Definition at line 151 of file Cell.cpp.

                                                            {
     if(inName.empty()) {
         Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("View name", inName);
         throw e;
     }
     if(false == mViewSymTab.remove(inName)) {
         Error e(eMessageIdErrorItemNotFound, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("View name", inName);
         throw e;
     }
     return;
 }

Here is the call graph for this function:

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::Extern::setIsExtern ( bool inIsExtern )

inherited

Set whether an item is extern or not.

Parameters

[in] isExtern True if extern, false otherwise

Definition at line 35 of file Extern.cpp.

                                         {
     mIsExtern = inIsExtern;
 }

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< Library >::setParent ( const boost::shared_ptr< Library > & 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::Cell::setType ( const Type & inSource )

Set the type of cell

Parameters

[in] inSource Type of cell

Definition at line 95 of file Cell.cpp.

                                            {
     mType = inSource;
 }

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< Cell >::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< Cell >

friend

Definition at line 63 of file Cell.hpp.

Field Documentation

ParameterMapSharedPtr torc::generic::Cell::mParameters

private

Definition at line 203 of file Cell.hpp.

Type torc::generic::Cell::mType

private

Definition at line 202 of file Cell.hpp.

SymTab<std::string, ViewSharedPtr> torc::generic::Cell::mViewSymTab

private

Definition at line 201 of file Cell.hpp.

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

Data Structures

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Field Documentation