Represents and EDIF View. More...

#include <View.hpp>

Inheritance diagram for torc::generic::View:

Collaboration diagram for torc::generic::View:

Data Structures
class	Factory

Public Types
enum	Type { eTypeMaskLayout = 0, eTypePCBLayout, eTypeNetlist, eTypeSchematic, eTypeSymbolic, eTypeBehavior, eTypeLogicModel, eTypeDocument, eTypeGraphic, eTypeStranger }

typedef VisitorType< View >	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)

ParameterContext	getParameterContext () const

ParameterMapSharedPtr	getParameters () throw (Error)

void	setParameters (const ParameterMapSharedPtr &inSource)

const Type	getType () const

void	setType (const Type &inSource)

void	getInstances (std::vector< InstanceSharedPtr > &outInstances) const

void	setInstances (const std::vector< InstanceSharedPtr > &inSource) throw (Error)

void	addInstance (const InstanceSharedPtr &inInstance) throw (Error)

InstanceSharedPtr	findInstance (const std::string &inName)

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

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

void	getNets (std::vector< NetSharedPtr > &outNets) const

void	setNets (const std::vector< NetSharedPtr > &inSource) throw (Error)

void	addNet (const NetSharedPtr &inNet) throw (Error)

NetSharedPtr	findNet (const std::string &inName)

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

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

void	getPorts (std::vector< PortSharedPtr > &outPorts) const

void	setPorts (const std::vector< PortSharedPtr > &inSource) throw (Error)

void	addPort (const PortSharedPtr &inPort) throw (Error)

PortSharedPtr	findPort (const std::string &inName)

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

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

void	getPermutables (std::vector< PermutableSharedPtr > &outPermutables) const

void	setPermutables (const std::vector< PermutableSharedPtr > &inSource) throw (Error)

bool	addPermutable (const PermutableSharedPtr &inPermutable) throw (Error)

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

void	getInterfaceJoinedInfos (std::vector< InterfaceJoinedInfoSharedPtr > &outJoinedInfos) const

void	setInterfaceJoinedInfos (const std::vector< InterfaceJoinedInfoSharedPtr > &inSource) throw (Error)

bool	addInterfaceJoinedInfo (const InterfaceJoinedInfoSharedPtr &inJoinedInfo) throw (Error)

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

const InterfaceAttributesSharedPtr	getInterfaceAttributes () const

void	setInterfaceAttributes (const InterfaceAttributesSharedPtr &inSource)

const std::string &	getNonNetlistViewData () const

void	setNonNetlistViewData (const std::string &inData)

const SimulateSharedPtr	getSimulate () const

void	setSimulate (const SimulateSharedPtr &inSource)

const TimingSharedPtr	getTiming () const

void	setTiming (const TimingSharedPtr &inSource)

virtual	~View () 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< Cell >	getParent () const

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

Private Attributes
ParameterMapSharedPtr	mParameters

ParameterContext	mMyContext

SymTab< std::string, InstanceSharedPtr >	mInstanceSymTab

SymTab< std::string, NetSharedPtr >	mNetSymTab

SymTab< std::string, PortSharedPtr >	mPortSymTab

std::string	mNonNetlistViewData

Type	mType

std::vector< PermutableSharedPtr >	mPermutables

std::vector < InterfaceJoinedInfoSharedPtr >	mInterfaceJoinedInfos

InterfaceAttributesSharedPtr	mAttributes

SimulateSharedPtr	mSimulate

TimingSharedPtr	mTiming

Friends
class	FactoryType< View >

Detailed Description

Represents and EDIF View.

The View class represents an EDIF view. A view can be conrete or extern (black-box).

Note: Only views of type NETLIST are supported.

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

inherited

Definition at line 36 of file SelfReferencing.hpp.

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

Convenience

Definition at line 84 of file View.hpp.

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

inherited

Definition at line 37 of file SelfReferencing.hpp.

Member Enumeration Documentation

enum torc::generic::View::Type

Type of the view

Enumerator
eTypeMaskLayout
eTypePCBLayout
eTypeNetlist
eTypeSchematic
eTypeSymbolic
eTypeBehavior
eTypeLogicModel
eTypeDocument
eTypeGraphic
eTypeStranger

Definition at line 76 of file View.hpp.

               {
         eTypeMaskLayout = 0, eTypePCBLayout, eTypeNetlist, eTypeSchematic, eTypeSymbolic,
         eTypeBehavior, eTypeLogicModel, eTypeDocument, eTypeGraphic, eTypeStranger
     };

Constructor & Destructor Documentation

torc::generic::View::~View	(	)
throw	(
	)

virtual

Definition at line 504 of file View.cpp.

                      {
     if(!getName().empty()) {
         log("View %s is being destroyed.\n", getName().c_str());
     }
     mNetSymTab.applyOnAll(boost::bind(boost::mem_fn(&Net::disconnect), _1));
     mNetSymTab.clear();
     mPortSymTab.clear();
     mInstanceSymTab.clear();
     mPermutables.clear();
     mInterfaceJoinedInfos.clear();
 }

Here is the call graph for this function:

torc::generic::View::View ( )

protected

Definition at line 498 of file View.cpp.

            : Commentable(), Extern(), Nameable(), ParentedObject<Cell>(), PropertyContainer(),
     Renamable(), SelfReferencing<View>(), Visitable(), UserDataContainer(), StatusContainer(),
     mParameters(new ParameterMap()), mMyContext(mParameters->getNewContext()), mInstanceSymTab(),
     mNetSymTab(), mPortSymTab(), mType(eTypeNetlist), mPermutables(), mInterfaceJoinedInfos(),
     mAttributes(), mSimulate(), mTiming() {}

Member Function Documentation

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

virtual

Implements torc::generic::Visitable.

Definition at line 89 of file View.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::View::addInstance	(	const InstanceSharedPtr &	inInstance	)
throw	(	Error
	)

Add an instance to the list of instances. Empty pointer is ignored.

Parameters

[in] inInstance Pointer to instance to be added.

Exceptions

Error	Could not add instance because pointer to the Instance does not exist Id : eMessageIdErrorPointerToItemDoesNotExist Context Data Pointer to Instance - boost::shared_ptr
Error	Could not add instance because Instance name is empty Id : eMessageIdErrorEmptyItemName Context Data Instance name - String
Error	Could not add instance because Instance name already exists Id : eMessageIdErrorItemAlreadyExists Context Data Instance name - String

Add an instance to the list of instances. Empty pointer is ignored.

Parameters

[in] inInstance Pointer to instance to be added.

Exceptions

Error	Could not add instance because pointer to the Instance does not exist
Error	Could not add instance because Instance name is empty
Error	Could not add instance because Instance name already exists

Definition at line 141 of file View.cpp.

                                                                         {
     if(!inInstance) {
         Error e(eMessageIdErrorPointerToItemDoesNotExist, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Pointer to the instance object does not exist", inInstance);
         throw e;
     }
     std::string name = inInstance->getName();
     if(name.empty()) {
         Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Empty Instance name", name);
         throw e;
     }
     if(false == mInstanceSymTab.set(name, inInstance)) {
         Error e(eMessageIdErrorItemAlreadyExists, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Instance name", name);
         throw e;
     }
     inInstance->setParent(getSharedThis());
 }

Here is the call graph for this function:

bool torc::generic::View::addInterfaceJoinedInfo	(	const InterfaceJoinedInfoSharedPtr &	inJoinedInfo	)
throw	(	Error
	)

Add a joined info to this view.

Parameters

[in] inJoinedInfo Pointer to joined info to be added.

Exceptions

Error Could not add joined info because pointer to the joined info does not exist

Definition at line 455 of file View.cpp.

                                                                                                 {
     if(!inJoinedInfo) {
         Error e(eMessageIdErrorPointerToItemDoesNotExist, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Pointer to the joined info object does not exist", inJoinedInfo);
         throw e;
     }
     if(inJoinedInfo) {
         mInterfaceJoinedInfos.push_back(inJoinedInfo);
         return true;
     } else {
         return false;
     }
 }

Here is the call graph for this function:

void torc::generic::View::addNet	(	const NetSharedPtr &	inNet	)
throw	(	Error
	)

Add a net to the list of nets. Empty pointer is ignored.

Parameters

[in] inNet Pointer to net to be added.

Exceptions

Error	Could not add Net, because Net name is empty Id : eMessageIdErrorEmptyItemName Context Data Net name - String
Error	Could not add Net, because Net name already exists Id : eMessageIdErrorItemAlreadyExists Context Data Net name - String

Add a net to the list of nets. Empty pointer is ignored.

Parameters

[in] inNet Pointer to net to be added.

Exceptions

Error	Could not add Net, because Net name is empty
Error	Could not add Net, because Net name already exists

Definition at line 240 of file View.cpp.

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

Here is the call graph for this function:

bool torc::generic::View::addPermutable	(	const PermutableSharedPtr &	inPermutable	)
throw	(	Error
	)

Add a permutable to this view.

Parameters

[in] inPermutable Pointer to permutable to be added.

Exceptions

Error Could not add permutable because pointer to the permutable does not exist

Definition at line 415 of file View.cpp.

                                                                               {
     if(!inPermutable) {
         Error e(eMessageIdErrorPointerToItemDoesNotExist, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Pointer to the permutable object does not exist", inPermutable);
         throw e;
     }
     if(inPermutable) {
         mPermutables.push_back(inPermutable);
         return true;
     } else {
         return false;
     }
 }

Here is the call graph for this function:

void torc::generic::View::addPort	(	const PortSharedPtr &	inPort	)
throw	(	Error
	)

Add a port to the list of ports. Empty pointer is ignored.

Parameters

[in] inPort Pointer to port to be added.

Exceptions

Error	Could not add port, because Port name is empty Id : eMessageIdErrorEmptyItemName Context Data Port name - String
Error	Could not add port, because Port name already exists Id : eMessageIdErrorItemAlreadyExists Context Data Port name - View

Add a port to the list of ports. Empty pointer is ignored.

Parameters

[in] inPort Pointer to port to be added.

Exceptions

Error Could not add port, because Port name is empty

Definition at line 325 of file View.cpp.

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

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

inline

Apply action on all Instances.

Parameters

[in] action Action to be applied

Definition at line 638 of file View.hpp.

                   {
     try {
         mInstanceSymTab.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::View::applyOnAllInterfaceJoinedInfos	(	const _Action &	action	)
throw	(	Error
	)

inline

Apply action on all joined info.

Parameters

[in] action Action to be applied

Definition at line 722 of file View.hpp.

                   {
     try {
         std::vector<InterfaceJoinedInfoSharedPtr>::iterator it = mInterfaceJoinedInfos.begin();
         for(; it != mInterfaceJoinedInfos.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::View::applyOnAllNets	(	const _Action &	action	)
throw	(	Error
	)

inline

Apply action on all Nets.

Parameters

[in] action Action to be applied

Definition at line 652 of file View.hpp.

                                                                                                 {
     try {
         mNetSymTab.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::View::applyOnAllPermutables	(	const _Action &	action	)
throw	(	Error
	)

inline

Apply action on all Permutables.

Parameters

[in] action Action to be applied

Apply action on all children.

Parameters

[in] action Action to be applied

Definition at line 693 of file View.hpp.

                   {
     try {
         std::vector<PermutableSharedPtr>::iterator it = mPermutables.begin();
         for(; it != mPermutables.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::View::applyOnAllPorts	(	const _Action &	action	)
throw	(	Error
	)

inline

Apply action on all Ports.

Parameters

[in] action Action to be applied

Definition at line 665 of file View.hpp.

                                                                                                  {
     try {
         mPortSymTab.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::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:

InstanceSharedPtr torc::generic::View::findInstance ( const std::string & inName )

Find an instance by name, in the list of instances.

Parameters

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

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

Exceptions

Error

Empty Instance name

Id : eMessageIdErrorEmptyItemName
Context Data
- Instance name - String

Find an instance by name, in the list of instances.

Parameters

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

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

Exceptions

Error Empty Instance name

Definition at line 170 of file View.cpp.

                                                             {
     if(inName.empty()) {
         Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Instance name", inName);
         throw e;
     }
     InstanceSharedPtr instance;
     mInstanceSymTab.get(inName, instance);
     return instance;
 }

Here is the call graph for this function:

NetSharedPtr torc::generic::View::findNet ( const std::string & inName )

Find a net by name, in the list of net.

Parameters

[in] inName String inSource specifying the name of the Net

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

Exceptions

Error

Empty Net name

Id : eMessageIdErrorEmptyItemName
Context Data
- Net name - String

Find a net by name, in the list of net.

Parameters

[in] inName String inSource specifying the name of the Net

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

Exceptions

Error Empty Net name

Definition at line 266 of file View.cpp.

                                                   {
     if(inName.empty()) {
         Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Net name not found", inName);
         throw e;
     }
     NetSharedPtr net;
     mNetSymTab.get(inName, net);
     return net;
 }

Here is the call graph for this function:

PortSharedPtr torc::generic::View::findPort ( const std::string & inName )

Find a port by name, in the list of ports.

Parameters

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

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

Exceptions

Error

Empty Port name

Id : eMessageIdErrorEmptyItemName
Context Data
- Port Name - String

Find a port by name, in the list of ports.

Parameters

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

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

Exceptions

Error Empty Port name

Definition at line 352 of file View.cpp.

                                                     {
     if(inName.empty()) {
         Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Port name", inName);
         throw e;
     }
     PortSharedPtr port;
     mPortSymTab.get(inName, port);
     return port;
 }

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::View::getInstances ( std::vector< InstanceSharedPtr > & outInstances ) const

inline

Get the list of instances for this view.

Parameters

[out] outInstances List of instances to be appended to

Definition at line 634 of file View.hpp.

                                                                                {
     mInstanceSymTab.getValues(outInstances);
 }

Here is the call graph for this function:

const InterfaceAttributesSharedPtr torc::generic::View::getInterfaceAttributes ( ) const

inline

Get the attributes of a view interface. Attributes include designator, simulate, timing, comments, userdata etc. This will decompile within (contents ...) construct.

Returns: Pointer to InterfaceAttributes object.

Get the attributes of a view interface. Attributes include designator, comments, userdata etc.

Returns: Pointer to InterfaceAttributes object.

Definition at line 740 of file View.hpp.

                                                                              {
     return mAttributes;
 }

void torc::generic::View::getInterfaceJoinedInfos ( std::vector< InterfaceJoinedInfoSharedPtr > & outJoinedInfos ) const

inline

Get the vector of joined info for this view.

Parameters

[out] outJoinedInfos Vector of joined info to be appended to

Definition at line 711 of file View.hpp.

                                                                    {
     outJoinedInfos.insert(outJoinedInfos.end(), mInterfaceJoinedInfos.begin(),
         mInterfaceJoinedInfos.end());
 }

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:

void torc::generic::View::getNets ( std::vector< NetSharedPtr > & outNets ) const

inline

Get the list of nets for this view.

Parameters

[out] outNets List of nets to be appended to

Definition at line 648 of file View.hpp.

                                                                 {
     mNetSymTab.getValues(outNets);
 }

Here is the call graph for this function:

const std::string & torc::generic::View::getNonNetlistViewData ( ) const

inline

Definition at line 674 of file View.hpp.

                                                           {
     return mNonNetlistViewData;
 }

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:

ParameterContext torc::generic::View::getParameterContext ( ) const

inline

Returns the context that will be used to get parameters from the parameter map. For an unbound instance, this will return an invalid value

Definition at line 621 of file View.hpp.

                                                         {
     return mMyContext;
 }

ParameterMapSharedPtr torc::generic::View::getParameters	(		)
throw	(	Error
	)

Get the ParameterMap corresponding to this cell

Returns: A ParameterMap consisiting of only the overridden parameters.

Definition at line 98 of file View.cpp.

                                                         {
     if(!mParameters->isContextRegistered(mMyContext)) {
         mParameters->registerContext(mMyContext);
     }
     return mParameters;
 }

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

inlineinherited

Get a pointer to the parent object

Returns: Pointer to parent

void torc::generic::View::getPermutables ( std::vector< PermutableSharedPtr > & outPermutables ) const

inline

Get the vector of permutables for this view.

Parameters

[out] outPermutables Vector of permutable to be appended to

Definition at line 684 of file View.hpp.

                                                                                      {
     outPermutables.insert(outPermutables.end(), mPermutables.begin(), mPermutables.end());
 }

void torc::generic::View::getPorts ( std::vector< PortSharedPtr > & outPorts ) const

inline

Get the list of ports for this view.

Parameters

[out] outPorts List of ports to be appended to

Definition at line 661 of file View.hpp.

                                                                    {
     mPortSymTab.getValues(outPorts);
 }

Here is the call graph for this function:

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< View >::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 SimulateSharedPtr torc::generic::View::getSimulate ( ) const

inline

Get the pointer to the simulate.

Returns: Pointer to the simulatie

Definition at line 749 of file View.hpp.

                                                        {
     return mSimulate;
 }

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 TimingSharedPtr torc::generic::View::getTiming ( ) const

inline

Get the pointer to the timing object

Returns: Pointer to the timing object

Definition at line 758 of file View.hpp.

                                                    {
     return mTiming;
 }

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

inline

Get the type of view.

Returns: Type of view

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

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

void torc::generic::View::removeInstance	(	const std::string &	inName	)
throw	(	Error
	)

Remove the specified instance from the list of cells.

Parameters

inName Name of the object to be delete

Exceptions

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

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

Parameters

inInstance Pointer to an instance object.

Exceptions

Error	Empty Instance name
Error	Instance name not preset in collection.

Definition at line 190 of file View.cpp.

                                                                {
     if(inName.empty()) {
         Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Instance name", inName);
         throw e;
     }
     InstanceSharedPtr instance = findInstance(inName);
     if(instance) {
         std::vector<PortReferenceSharedPtr> refs;
         instance->getPortReferences(refs);
         for_each(refs.begin(), refs.end(),
             boost::bind(boost::mem_fn(&Connectable::disconnect), _1));
         if(false == mInstanceSymTab.remove(inName)) {
             Error e(eMessageIdErrorItemNotFound, __FUNCTION__, __FILE__, __LINE__);
             e.saveContextData("Instance name", inName);
             throw e;
         }
     } else {
         Error e(eMessageIdErrorItemNotFound, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Instance name", inName);
         throw e;
     }
 }

Here is the call graph for this function:

void torc::generic::View::removeNet	(	const std::string &	inName	)
throw	(	Error
	)

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

Parameters

inName Name of the object to be delete

Exceptions

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

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

Parameters

inNet Pointer to a net object.

Exceptions

Error	Empty Net name
Error	Net not preset in collection.

Definition at line 286 of file View.cpp.

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

Here is the call graph for this function:

void torc::generic::View::removePort	(	const std::string &	inName	)
throw	(	Error
	)

Remove the specified port from the list of ports.

Parameters

inName Name of the port to be removed

Exceptions

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

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

Parameters

inName Name of the port to be removed

Exceptions

Error	Empty Port name
Error	Port not preset in collection.

Definition at line 372 of file View.cpp.

                                                            {
     if(inName.empty()) {
         Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Port name", inName);
         throw e;
     }
     if(false == mPortSymTab.remove(inName)) {
         Error e(eMessageIdErrorItemNotFound, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Port 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::View::setInstances	(	const std::vector< InstanceSharedPtr > &	inSource	)
throw	(	Error
	)

Set the list of instances to this view. It will lead to a linear traversal on the list. So usage of this API is not recommended.

Parameters

[in] inSource List of instances.

Set the list of instances to this view.

Parameters

[in] inSource List of instances.

Definition at line 119 of file View.cpp.

                                                                                   {
     std::vector<InstanceSharedPtr>::const_iterator instance = inSource.begin();
     std::vector<InstanceSharedPtr>::const_iterator end = inSource.end();
     for(; instance != end; ++instance) {
         try {
             addInstance(*instance);
         } catch(Error& e) {
             e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
             throw;
         }
     }
 }

Here is the call graph for this function:

void torc::generic::View::setInterfaceAttributes ( const InterfaceAttributesSharedPtr & inSource )

Set the attributes of a view interface. Attributes include designator, simulate, timing, comments, userdata etc. This will decompile within (contents ...) construct.

Parameters

[in] inSource Pointer to InterfaceAttributes object.

Definition at line 476 of file View.cpp.

                                                                               {
     mAttributes = inSource;
 }

void torc::generic::View::setInterfaceJoinedInfos	(	const std::vector< InterfaceJoinedInfoSharedPtr > &	inSource	)
throw	(	Error
	)

Set the vector of joined info for this view.

Parameters

[in] inSource Vector of joined info to this view.

Exceptions

Error Could not add joined info because pointer to the joined info does not exist

Definition at line 435 of file View.cpp.

                   {
     std::vector<InterfaceJoinedInfoSharedPtr>::const_iterator entry = inSource.begin();
     std::vector<InterfaceJoinedInfoSharedPtr>::const_iterator end = inSource.end();
     for(; entry != end; ++entry) {
         try {
             addInterfaceJoinedInfo(*entry);
         } catch(Error& e) {
             e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
             throw;
         }
     }
 }

Here is the call graph for this function:

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::View::setNets	(	const std::vector< NetSharedPtr > &	inSource	)
throw	(	Error
	)

Set the list of nets to this view. It will lead to a linear traversal on the list. So usage of this API is not recommended.

Parameters

[in] inSource List of nets.

Set the list of nets to this view.

Parameters

[in] inSource List of nets.

Definition at line 219 of file View.cpp.

                                                                         {
     std::vector<NetSharedPtr>::const_iterator net = inSource.begin();
     std::vector<NetSharedPtr>::const_iterator end = inSource.end();
     for(; net != end; ++net) {
         try {
             addNet(*net);
         } catch(Error& e) {
             e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
             throw;
         }
     }
 }

Here is the call graph for this function:

void torc::generic::View::setNonNetlistViewData ( const std::string & inData )

Definition at line 385 of file View.cpp.

                                                         {
     mNonNetlistViewData = inData;
 }

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::View::setParameters ( const ParameterMapSharedPtr & inSource )

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

virtualinherited

Set a pointer to the parent

Parameters

[in] inSource Set a pointer to the parent

void torc::generic::View::setPermutables	(	const std::vector< PermutableSharedPtr > &	inSource	)
throw	(	Error
	)

Set the vector of permutables to this view. It will lead to a linear traversal on the list.

Parameters

[in] inSource Vector of permutables to this view.

Exceptions

Error Could not add permutable because pointer to the permutable does not exist

Set the vector of permutables to this view. It will lead to a linear traversal on the list. So usage of this API is not recommended.

Parameters

[in] inSource Vector of permutables to this view.

Exceptions

Error Could not add permutable because pointer to the permutable does not exist

Definition at line 396 of file View.cpp.

                                                                                       {
     std::vector<PermutableSharedPtr>::const_iterator entry = inSource.begin();
     std::vector<PermutableSharedPtr>::const_iterator end = inSource.end();
     for(; entry != end; ++entry) {
         try {
             addPermutable(*entry);
         } catch(Error& e) {
             e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
             throw;
         }
     }
 }

Here is the call graph for this function:

void torc::generic::View::setPorts	(	const std::vector< PortSharedPtr > &	inSource	)
throw	(	Error
	)

Set the list of ports to this view. It will lead to a linear traversal on the list. So usage of this API is not recommended.

Parameters

[in] inSource List of ports

Set the list of ports to this view.

Parameters

[in] inSource List of ports

Definition at line 304 of file View.cpp.

                                                                           {
     std::vector<PortSharedPtr>::const_iterator port = inSource.begin();
     std::vector<PortSharedPtr>::const_iterator end = inSource.end();
     for(; port != end; ++port) {
         try {
             addPort(*port);
         } catch(Error& e) {
             e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
             throw;
         }
     }
 
 }

Here is the call graph for this function:

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::View::setSimulate ( const SimulateSharedPtr & inSource )

Set the pointer to the simulate.

Parameters

[in] inSource Pointer to the simulate

Definition at line 485 of file View.cpp.

                                                         {
     mSimulate = 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::View::setTiming ( const TimingSharedPtr & inSource )

Set the pointer to the timing object

Parameters

[in] inSource Pointer to the timing object

Definition at line 494 of file View.cpp.

                                                     {
     mTiming = inSource;
 }

void torc::generic::View::setType ( const Type & inSource )

Set the type of view

Parameters

[in] inSource Type of view

Definition at line 110 of file View.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< View >::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< View >

friend

Definition at line 69 of file View.hpp.

Field Documentation

InterfaceAttributesSharedPtr torc::generic::View::mAttributes

private

Definition at line 616 of file View.hpp.

SymTab<std::string, InstanceSharedPtr> torc::generic::View::mInstanceSymTab

private

Definition at line 609 of file View.hpp.

std::vector<InterfaceJoinedInfoSharedPtr> torc::generic::View::mInterfaceJoinedInfos

private

Definition at line 615 of file View.hpp.

ParameterContext torc::generic::View::mMyContext

private

Definition at line 608 of file View.hpp.

SymTab<std::string, NetSharedPtr> torc::generic::View::mNetSymTab

private

Definition at line 610 of file View.hpp.

std::string torc::generic::View::mNonNetlistViewData

private

Definition at line 612 of file View.hpp.

ParameterMapSharedPtr torc::generic::View::mParameters

private

Definition at line 607 of file View.hpp.

std::vector<PermutableSharedPtr> torc::generic::View::mPermutables

private

Definition at line 614 of file View.hpp.

SymTab<std::string, PortSharedPtr> torc::generic::View::mPortSymTab

private

Definition at line 611 of file View.hpp.

SimulateSharedPtr torc::generic::View::mSimulate

private

Definition at line 617 of file View.hpp.

TimingSharedPtr torc::generic::View::mTiming

private

Definition at line 618 of file View.hpp.

Type torc::generic::View::mType

private

Definition at line 613 of file View.hpp.

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

Data Structures

Public Types

Public Member Functions

Protected 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