torc::generic::Root Class Reference

Root of the EDIF Object Model. More...

#include <Root.hpp>

Inheritance diagram for torc::generic::Root:

Collaboration diagram for torc::generic::Root:

Data Structures
class	Factory

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

Public Member Functions
virtual void	addLibrary (const LibrarySharedPtr &inLibrary) throw (Error)
virtual void	removeLibrary (const std::string &inName) throw (Error)
virtual LibrarySharedPtr	findLibrary (const std::string &inName)
virtual void	getLibraries (std::vector< LibrarySharedPtr > &outLibraries)
template<typename _Action >
void	applyOnAllLibraries (const _Action &action) throw (Error)
virtual void	addDesign (const DesignSharedPtr &inDesign) throw (Error)
virtual void	removeDesign (const std::string &inName) throw (Error)
virtual DesignSharedPtr	findDesign (const std::string &inName)
virtual void	getDesigns (std::vector< DesignSharedPtr > &outDesigns)
template<typename _Action >
void	applyOnAllDesigns (const _Action &action) throw (Error)
virtual void	accept (BaseVisitor &inoutVisitor) throw (Error)
const EdifVersion	getVersion () const
void	setVersion (const EdifVersion &inSource)
const EdifLevel	getLevel () const
void	setLevel (const EdifLevel &inSource)
virtual	~Root () throw ()
void	addComment (const std::string &comment)
const std::vector< std::string > &	getComments () const
void	setComments (const std::vector< std::string > &inSource)
virtual const std::string	getName () const
void	setName (const std::string &inSource) 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
	Root ()

Private Member Functions
	Root (const Root &source)
Root &	operator= (const Root &source)

Private Attributes
EdifLevel	mLevel
SymTab< std::string, LibrarySharedPtr >	mLibraries
SymTab< std::string, DesignSharedPtr >	mDesignSymTab
EdifVersion	mVersion

Friends
class	FactoryType< Root >

Detailed Description

Root of the EDIF Object Model.

The Root class represents and EDIF hierarchy. All parsed EDIF files contribute to the growth of the object tree rooted here. At the top level, it provides access to the libraries present in the design.

Note

In case the tree has been programatically created, clients need to decompile this tree, a name has to be given to the tree, otherwise an exception will be generated. This name will become the design name of the decompiled output file. For parser generated trees, the design name of the last file parsed becomes the name of the root. This can obviously be changed by the client, by calling the set_name() method.

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

inherited

Definition at line 36 of file SelfReferencing.hpp.

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

inherited

Definition at line 35 of file SelfReferencing.hpp.

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

Convenience typedef for visiting the root

Definition at line 78 of file Root.hpp.

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

inherited

Definition at line 37 of file SelfReferencing.hpp.

Constructor & Destructor Documentation

torc::generic::Root::~Root ( ) throw ( )

virtual

Definition at line 281 of file Root.cpp.

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

Here is the call graph for this function:

torc::generic::Root::Root ( )

protected

Definition at line 274 of file Root.cpp.

           : Commentable(), Nameable(), Renamable(), Visitable(), SelfReferencing<Root>(),
    UserDataContainer(), StatusContainer(), mLevel(), mLibraries(), mDesignSymTab(), mVersion()
#ifdef GENOM_SERIALIZATION
, mDumpRestoreData(), mDumpedLibraries()
#endif //GENOM_SERIALIZATION
{}

torc::generic::Root::Root ( const Root &  source )

private

Member Function Documentation

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

virtual

Implements torc::generic::Visitable.

Definition at line 226 of file Root.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::Root::addDesign ( const DesignSharedPtr &  inDesign ) throw ( Error )

virtual

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

Parameters

[in]

inDesign

A pointer to a design object.

Exceptions

Error	Design could not be added. because design name is empty Id : eMessageIdErrorEmptyItemName
Error	Design could not be added. because Library name is already exists Id : eMessageIdErrorItemAlreadyExists

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

Definition at line 143 of file Root.cpp.

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

Here is the call graph for this function:

void torc::generic::Root::addLibrary ( const LibrarySharedPtr &  inLibrary ) throw ( Error )

virtual

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

Parameters

[in]

inLibrary

A pointer to a library object.

Exceptions

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

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

Parameters

[in]

inLibrary

A pointer to a library object.

Exceptions

Error	Library could not be added. because Library name is empty
Error	Library could not be added. because Library name is already exists

Definition at line 48 of file Root.cpp.

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

Here is the call graph for this function:

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

inline

Apply action on all Designs.

Parameters

[in]

action

Action to be applied

Definition at line 360 of file Root.hpp.

                  {
    try {
        mDesignSymTab.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::Root::applyOnAllLibraries ( const _Action &  action ) throw ( Error )

inline

Apply action on all Libraries.

Parameters

[in]

action

Action to be applied

Note

If some libraries 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 libraries under the root.

Apply action on all Libraries.

Parameters

[in]

action

Action to be applied

Definition at line 342 of file Root.hpp.

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

DesignSharedPtr torc::generic::Root::findDesign ( const std::string &  inName )

virtual

Find a design by name, in the list of designs.

Parameters

[in]

inName

String specifying the name of the design.

Returns

A pointer to the design if found, an empty pointer otherwise.

Find a Design by name, in the list of libraries.

Parameters

[in]

inName

String inSource specifying the name of the Design.

Returns

A pointer to the design if found, an empty pointer otherwise.

Definition at line 196 of file Root.cpp.

                                                        {
    DesignSharedPtr design;
    mDesignSymTab.get(inName, design);
    return design;
}

Here is the call graph for this function:

LibrarySharedPtr torc::generic::Root::findLibrary ( const std::string &  inName )

virtual

Find a library by name, in the list of libraries.

Parameters

[in]

inName

String specifying the name of the library.

Returns

A pointer to the libary if found, an empty pointer otherwise.

Note

If some libraries 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 library by name, in the list of libraries.

Parameters

[in]

inName

String inSource specifying the name of the library.

Returns

A pointer to the libary if found, an empty pointer otherwise.

Definition at line 129 of file Root.cpp.

                                                          {
    LibrarySharedPtr library;
    mLibraries.get(inName, library);
#ifdef GENOM_SERIALIZATION
    if(!library && !mDumpedLibraries.empty()) {
        library = restoreSingleLibrary(inName);
    }
#endif //GENOM_SERIALIZATION
    return library;
}

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

void torc::generic::Root::getDesigns ( std::vector< DesignSharedPtr > &  outDesigns )

virtual

Get the list of designs.

Parameters

[out]

outDesigns

List of designs contained in the root

Get the list of designs.

Parameters

[out]

outDesigns

List of libraries

Definition at line 185 of file Root.cpp.

                                                            {
    mDesignSymTab.getValues(outDesigns);
}

Here is the call graph for this function:

const EdifLevel torc::generic::Root::getLevel ( ) const

inline

The the level of EDIF file.

Returns

The EDIF level for this file

Definition at line 384 of file Root.hpp.

                                            {
    return mLevel;
}

void torc::generic::Root::getLibraries ( std::vector< LibrarySharedPtr > &  outLibraries )

virtual

Get the list of libraries.

Parameters

[out]

outLibraries

List of libraries contained in the root

Note

If some libraries 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 libraries.

Parameters

[out]

outLibraries

List of libraries

Definition at line 115 of file Root.cpp.

                                                                 {
#ifdef GENOM_SERIALIZATION
    restoreAllLibraries();
#endif //GENOM_SERIALIZATION
    mLibraries.getValues(outLibraries);
}

Here is the call graph for this function:

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:

Pointer torc::generic::SelfReferencing< Root >::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;
}

const EdifVersion torc::generic::Root::getVersion ( ) const

inline

Get the version of EDIF present in the tree.

Returns

Version of edif

Definition at line 375 of file Root.hpp.

                                                {
    return mVersion;
}

Root& torc::generic::Root::operator= ( const Root &  source )

private

void torc::generic::Root::removeDesign ( const std::string &  inName ) throw ( Error )

virtual

Remove the specified design from the list of designs.

Parameters

inName

Name of the object to be delete

Exceptions

Error	Empty design name Id : eMessageIdErrorEmptyItemName
Error	design not preset in collection Id : eMessageIdErrorItemNotFound

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

Definition at line 166 of file Root.cpp.

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

Here is the call graph for this function:

void torc::generic::Root::removeLibrary ( const std::string &  inName ) throw ( Error )

virtual

Remove the specified library from the list of libraries.

Parameters

inName

Name of the object to be delete

Exceptions

Error	Empty Library name Id : eMessageIdErrorEmptyItemName Context Data Library name - String
Error	Library not preset in collection Id : eMessageIdErrorItemNotFound Context Data Library name - String

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

Parameters

inName

Name of the object to be delete

Exceptions

Error	Empty Library name
Error	Library not preset in collection

Definition at line 85 of file Root.cpp.

                                                              {
    if(inName.empty()) {
        Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
        e.saveContextData("Library name", inName);
        throw e;
    }
#ifdef GENOM_SERIALIZATION
    std::list< std::string >::iterator it = std::find(mDumpedLibraries.begin(),
        mDumpedLibraries.end(), inName);
    if(it == mDumpedLibraries.end()) {
        Error e(eMessageIdErrorItemNotFound, __FUNCTION__, __FILE__, __LINE__);
        e.saveContextData("Library name", inName);
        throw e;
    } else {
        mDumpedLibraries.erase(it);
    }
#endif //GENOM_SERIALIZATION    
    if(false == mLibraries.remove(inName)) {
        Error e(eMessageIdErrorItemNotFound, __FUNCTION__, __FILE__, __LINE__);
        e.saveContextData("Library 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::Root::setLevel

(

const EdifLevel &

inSource

)

Set the EDIF level.

Note

Current parser supports LEVEL_0 edif only.

Parameters

[in]

inSource

EdifLevel object

Set the EDIF level.

Note

Current parser supports LEVEL_1 edif only.

Parameters

[in]

inSource

EdifLevel object

Definition at line 251 of file Root.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;
}

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::Root::setVersion

(

const EdifVersion &

inSource

)

Set the version of EDIF being used. This should be 2 0 0 for the current EOM version.

Parameters

[in]

inSource

An object of type EdifVersion.

Definition at line 240 of file Root.cpp.

                                                 {
    mVersion = inSource;
}

void torc::generic::SelfReferencing< Root >::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< Root >

friend

Definition at line 72 of file Root.hpp.

Field Documentation

SymTab<std::string, DesignSharedPtr> torc::generic::Root::mDesignSymTab

private

Definition at line 329 of file Root.hpp.

EdifLevel torc::generic::Root::mLevel

private

Definition at line 327 of file Root.hpp.

SymTab<std::string, LibrarySharedPtr> torc::generic::Root::mLibraries

private

Definition at line 328 of file Root.hpp.

EdifVersion torc::generic::Root::mVersion

private

Definition at line 330 of file Root.hpp.

---

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

• Root.hpp
• Root.cpp