An EDIF cell library. More...

#include <Library.hpp>

Inheritance diagram for torc::generic::Library:

Collaboration diagram for torc::generic::Library:

Data Structures
class	Factory

Public Types
typedef VisitorType< Library >	Visitor

typedef std::string	Name

typedef Library	Type

typedef boost::shared_ptr< Type >	Pointer

typedef boost::weak_ptr< Type >	WeakPointer

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

const EdifLevel	getLevel () const

void	setLevel (const EdifLevel &inSource)

const std::map< Unit, ScaleFactor >	getScaleFactors () const

bool	findScaleFactor (Unit inUnit, ScaleFactor &outResult) const

bool	setScaleFactor (Unit inUnit, const ScaleFactor &inScale)

void	addCell (const CellSharedPtr &inCell) throw (Error)

virtual CellSharedPtr	findCell (const std::string &inName) throw (Error)

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

virtual void	getCells (std::vector< CellSharedPtr > &outCells)

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

const SimulationInfoSharedPtr	getSimulationInfo () const

void	setSimulationInfo (const SimulationInfoSharedPtr &inSource)

virtual	~Library () 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)

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

Private Member Functions
	Library (const Library &)

Library &	operator= (const Library &)

Private Attributes
SymTab< Unit, ScaleFactor >	mScaleFactors

EdifLevel	mLevel

SymTab< std::string, CellSharedPtr >	mCellSymTab

SimulationInfoSharedPtr	mSimulationInfo

Friends
class	FactoryType< Library >

Detailed Description

An EDIF cell library.

A Library object defines a collection of EDIF libraries

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

inherited

Definition at line 36 of file SelfReferencing.hpp.

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

inherited

Definition at line 35 of file SelfReferencing.hpp.

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

Convenience typedef for visiting a library

Definition at line 73 of file Library.hpp.

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

inherited

Definition at line 37 of file SelfReferencing.hpp.

Constructor & Destructor Documentation

torc::generic::Library::~Library	(	)
throw	(
	)

virtual

Definition at line 247 of file Library.cpp.

                            {
     log("Library destroyed \n");
 }

Here is the call graph for this function:

torc::generic::Library::Library ( )

protected

Definition at line 243 of file Library.cpp.

                  : Commentable(), Extern(), Nameable(), Renamable(), Visitable(),
     ParentedObject<Root>(), SelfReferencing<Library>(), UserDataContainer(), StatusContainer(),
     mScaleFactors(), mLevel(), mCellSymTab(), mSimulationInfo() {}

torc::generic::Library::Library ( const Library & )

private

Member Function Documentation

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

virtual

Implements torc::generic::Visitable.

Definition at line 89 of file Library.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::Library::addCell	(	const CellSharedPtr &	inCell	)
throw	(	Error
	)

Add a cell to the list of cells. If an empty pointer is supplied, it returns without doing anything. If an cell already exists in EDIF file in same library, parser ignores the cell.

Parameters

[in] inCell A pointer to a cell object.

Exceptions

Error	Cell could not be added, because Cell name is empty Id : eMessageIdErrorEmptyItemName Context Data Cell name - String
Error	Cell could not be added, because Cell name is already exists Id : eMessageIdErrorItemAlreadyExists Context Data Cell name - String

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

Parameters

[in] inCell A pointer to a cell object.

Exceptions

Error Cell could not be added.

Definition at line 139 of file Library.cpp.

                                                                {
     if(!inCell) {
         return;
     }
     std::string cellName = inCell->getName();
     if(cellName.empty()) {
         Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Cell name", cellName);
         throw e;
     }
 #ifdef GENOM_SERIALIZATION
     std::list<std::string>::iterator it = std::find(mDumpedCells.begin(), mDumpedCells.end(),
         cellName);
     if(it != mDumpedCells.end()) {
         Error e(eMessageIdErrorItemAlreadyExists, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Cell name", cellName);
         throw e;
     }
 #endif //GENOM_SERIALIZATION    
     if(false == mCellSymTab.set(cellName, inCell)) {
         Error e(eMessageIdErrorItemAlreadyExists, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Cell name", cellName);
         throw e;
     }
     inCell->setParent(getSharedThis());
 }

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::Library::applyOnAllCells	(	const _Action &	action	)
throw	(	Error
	)

inline

Apply action on all Cells.

Parameters

[in] action Action to be applied

Note: If some cells are yet to be restored, this method is not thread safe. For non-serializable mode this is thread safe. For dump mode derived classes can write an appropriate thread safe wrapper method that can be accesed using visitors. However, using this method in dump mode should be avoided unless under dire situations, as it will lead to restoration of all cells under the library.

Apply action on all Cells.

Parameters

[in] action Action to be applied

Definition at line 325 of file Library.hpp.

                   {
     try {
 #ifdef GENOM_SERIALIZATION
         restoreAllCells();
 #endif //GENOM_SERIALIZATION    
         mCellSymTab.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:

CellSharedPtr torc::generic::Library::findCell	(	const std::string &	inName	)
throw	(	Error
	)

virtual

Find a cell by name, in the list of cells.

Parameters

[in] inName String inSource specifying the name of the cell.

Returns: A pointer to the cell if found, an empty pointer otherwise.

Exceptions

Error

Cell could not be found, because Cell name is empty

Id : eMessageIdErrorEmptyItemName
Context Data
- Cell name - String

Note: If some cells are yet to be restored, this method is not thread safe. For non-serializable mode this is thread safe. For dump mode derived classes can override this to make it thread safe by placing appropriate locks.

Find a cell by name, in the list of cells.

Parameters

[in] inName String inSource specifying the name of the cell.

Returns: A pointer to the cell if found, an empty pointer otherwise.

Definition at line 173 of file Library.cpp.

                                                                      {
     if(inName.empty()) {
         Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Cell name", inName);
         throw e;
     }
     CellSharedPtr cell;
     mCellSymTab.get(inName, cell);
 #ifdef GENOM_SERIALIZATION
     if(!cell && !mDumpedCells.empty()) {
         cell = restoreSingleCell(inName);
     }
 #endif //GENOM_SERIALIZATION
     return cell;
 }

Here is the call graph for this function:

bool torc::generic::Library::findScaleFactor	(	Unit	inUnit,
		ScaleFactor &	outResult
	)		const

Find a scale factor for the given unit.

Parameters

[in]	inUnit	Units for which scale factor is to be found.
[out]	outResult	The scale factor if found.

Returns: true if found, false otherwise

Definition at line 117 of file Library.cpp.

                                                                        {
     return mScaleFactors.get(inUnit, outResult);
 }

void torc::generic::Library::getCells ( std::vector< CellSharedPtr > & outCells )

virtual

Get the list of cells. The list of cells is appended to the provided list

Parameters

[out] outCells List of cells to be populated

Returns: List of cells in the library.

Note: If some cells are yet to be restored, this method is not thread safe. For non-serializable mode this is thread safe. For dump mode derived classes can override this to make it thread safe by placing appropriate locks. In dump mode using this method will lead to restoration of all children.

Get the list of cells.

Returns: List of cells in the library.

Definition at line 227 of file Library.cpp.

                                                          {
 #ifdef GENOM_SERIALIZATION
     restoreAllCells();
 #endif //GENOM_SERIALIZATION
     mCellSymTab.getValues(outCells);
 }

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 EdifLevel torc::generic::Library::getLevel ( ) const

inline

The the level of EDIF file.

Returns: The EDIF level for this file

Definition at line 305 of file Library.hpp.

                                                {
     return mLevel;
 }

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

const std::map< Unit, ScaleFactor > torc::generic::Library::getScaleFactors ( ) const

inline

Get scale factors for different units in the library.

Returns: Scale factors

Definition at line 314 of file Library.hpp.

                                                                       {
     std::map<Unit, ScaleFactor> temp;
     mScaleFactors.getValueMap(temp);
     return temp;
 }

Pointer torc::generic::SelfReferencing< Library >::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

const SimulationInfoSharedPtr torc::generic::Library::getSimulationInfo ( ) const

inline

Get the pointer to the simulation info.

Returns: Pointer to the simulation info

Definition at line 343 of file Library.hpp.

                                                                       {
     return mSimulationInfo;
 }

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

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

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

private

void torc::generic::Library::removeCell	(	const std::string &	inName	)
throw	(	Error
	)

Remove the specified cell from the list of cells. If an empty pointer is passed, it returns without doing anything

Parameters

inName Name of the object to be delete

Exceptions

Error	Cell name is empty Id : eMessageIdErrorEmptyItemName Context Data Cell name - String
Error	Cell name not preset in collection. Id : eMessageIdErrorItemNotFound Context Data Cell name - String

Remove the specified cell from the list of cells. If an empty pointer is passed, it returns without doing anything

Parameters

inCell Pointer to a cell object.

Exceptions

Error	Cell name is empty
Error	Cell name not preset in collection.

Definition at line 197 of file Library.cpp.

                                                               {
     if(inName.empty()) {
         Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Cell name", inName);
         throw e;
     }
 
 #ifdef GENOM_SERIALIZATION
     std::list<std::string>::iterator it = std::find(mDumpedCells.begin(), mDumpedCells.end(),
         inName);
     if(it == mDumpedCells.end()) {
         Error e(eMessageIdErrorItemNotFound, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Cell name", inName);
         throw e;
     } else {
         mDumpedCells.erase(it);
     }
 #endif //GENOM_SERIALIZATION    
     if(false == mCellSymTab.remove(inName)) {
         Error e(eMessageIdErrorItemNotFound, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Cell name", inName);
         throw e;
     }
 }

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::Library::setLevel ( const EdifLevel & inSource )

Set the EDIF level.

Note: Current parser supports LEVEL_1 edif only.

Parameters

[in] inSource EdifLevel object

Definition at line 105 of file Library.cpp.

                                                 {
     mLevel = inSource;
 }

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

bool torc::generic::Library::setScaleFactor	(	Unit	inUnit,
		const ScaleFactor &	inScale
	)

Set a scale factor for the given unit.

Parameters

[in]	inUnit	Units for which scale factor is to be set.
[out]	inScale	The scale factor to store.

Returns: True if set

Set a scale factor for the given unit.

Parameters

[in]	inUnit	Units for which scale factor is to be set.
[out]	inScale	The scale factor to store.

Definition at line 128 of file Library.cpp.

                                                                     {
     return mScaleFactors.set(inUnit, inScale);
 }

void torc::generic::Library::setSimulationInfo ( const SimulationInfoSharedPtr & inSource )

Set the pointer to the simulation info.

Parameters

[in] inSource Pointer to the simulation info

Definition at line 239 of file Library.cpp.

                                                                        {
     mSimulationInfo = inSource;
 }

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

friend

Definition at line 67 of file Library.hpp.

Field Documentation

SymTab<std::string, CellSharedPtr> torc::generic::Library::mCellSymTab

private

Definition at line 293 of file Library.hpp.

EdifLevel torc::generic::Library::mLevel

private

Definition at line 292 of file Library.hpp.

SymTab<Unit, ScaleFactor> torc::generic::Library::mScaleFactors

private

Definition at line 291 of file Library.hpp.

SimulationInfoSharedPtr torc::generic::Library::mSimulationInfo

private

Definition at line 294 of file Library.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

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Field Documentation