Represents a bundle of nets. More...

#include <NetBundle.hpp>

Inheritance diagram for torc::generic::NetBundle:

Collaboration diagram for torc::generic::NetBundle:

Data Structures
class	Factory

Public Types
typedef VisitorType< NetBundle >	Visitor

typedef std::list < NetSharedPtr >::iterator	Connection

typedef boost::signals2::signal< void(const NetSharedPtr &)>	Connected

typedef boost::signals2::signal< void(const NetSharedPtr &)>	Disconnected

typedef std::string	Name

typedef Net	Type

typedef boost::shared_ptr< Type >	Pointer

typedef boost::weak_ptr< Type >	WeakPointer

typedef std::vector< Pointer >	List

typedef size_t	SizeType

typedef Composite< Net >	BaseType

typedef BaseType::Type	Type

typedef BaseType::Pointer	Pointer

typedef BaseType::List	List

typedef BaseType::SizeType	SizeType

typedef Type	ChildType

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

virtual void	setParent (const ViewSharedPtr &inParent)

virtual Connection	connect (const NetSharedPtr &inNet) throw (Error)

void	disconnect (const Connection &inConnection) throw (Error)

void	disconnect () throw (Error)

virtual	~NetBundle () throw ()

void	addSubnet (const NetSharedPtr &inSubnet) throw (Error)

NetSharedPtr	findSubnet (const std::string &inName) throw (Error)

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

void	getSubnets (std::vector< NetSharedPtr > &outSubnets) const

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

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

NetSharedPtr	getParentNet () const

void	setParentNet (const NetSharedPtr &inParent)

const NetAttributesSharedPtr	getAttributes () const

void	setAttributes (const NetAttributesSharedPtr &inSource)

PortSharedPtr	findConnectedPort (const std::string &inName) throw (Error)

virtual void	getConnectedPorts (std::vector< PortSharedPtr > &outPort, bool inSkipChildConnections=false) const

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

virtual void	getConnectedPortLists (std::vector< PortListSharedPtr > &outPortList) const

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

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

void	disconnect (const NetSharedPtr &net) throw (Error)

PortReferenceSharedPtr	findConnectedPortReference (const std::string &inName) throw (Error)

virtual void	getConnectedPortRefs (std::vector< PortReferenceSharedPtr > &outPortRefs, bool inSkipChildConnections=false) const

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

void	addComment (const std::string &comment)

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

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

Connected &	signalNetConnected ()

Disconnected &	signalNetDisconnected ()

virtual void	getConnectedNets (std::vector< NetSharedPtr > &outNets, bool inSkipChildConnections=false) const throw (Error)

virtual const std::string	getName () const

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

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)

virtual CompositionType	getCompositionType () const =0

virtual size_t	getSize () const =0

virtual void	getChildren (List &outChildren) const =0 throw (Error)

virtual const Pointer	get (const std::vector< SizeType > &inIndices) const =0 throw (Error)

virtual void	setParentCollection (const Pointer &inParentCollection)

virtual Pointer	getParentCollection () const

void	setWeakThis (const WeakPointer &inWeakThis)

Pointer	getSharedThis () const

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

virtual void	setParent (const boost::shared_ptr< View > &inSource)

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

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

void	addUserData (const std::string &inSource)

virtual CompositionType	getCompositionType () const

virtual SizeType	getSize () const

virtual void	addChild (const boost::shared_ptr< Type > &child) throw (Error)

virtual void	getChildren (List &outChildren) const throw (Error)

void	applyOnAllChildren (const _Action &action) throw (Error)

virtual const Pointer	get (const std::vector< SizeType > &indices) const throw (Error)

Protected Member Functions
	NetBundle ()

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

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

void	addConnectedPortList (const PortListSharedPtr &inPort) throw (Error)

void	removeConnectedPortList (const PortListSharedPtr &inList) throw (Error)

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

void	addConnectedPortReference (const PortReferenceSharedPtr &portRef) throw (Error)

void	removeConnectedPortReference (const PortReferenceSharedPtr &inPortRef) throw (Error)

void	setConnectedPortRefs (const std::vector< PortReferenceSharedPtr > &inSource) throw (Error)

virtual void	onConnect () throw (Error)

virtual void	onDisconnect () throw (Error)

Friends
class	FactoryType< NetBundle >

Detailed Description

Represents a bundle of nets.

The NetBundle class represents an EDIF net bundle. NetBundles are ordered collection of scalar and vector nets and can be created using the (nettBundle ...) syntax.

Definition at line 43 of file NetBundle.hpp.

Member Typedef Documentation

typedef Composite<Net > torc::generic::Bundle< Net >::BaseType

inherited

Definition at line 48 of file Bundle.hpp.

typedef Type torc::generic::Bundle< Net >::ChildType

inherited

Definition at line 53 of file Bundle.hpp.

typedef boost::signals2::signal<void(const NetSharedPtr&)> torc::generic::Connectable::Connected

inherited

A signal to indicate that a new connection has been made

Definition at line 57 of file Connectable.hpp.

typedef std::list<NetSharedPtr>::iterator torc::generic::Connectable::Connection

inherited

A connection between a net and this object

Definition at line 52 of file Connectable.hpp.

typedef boost::signals2::signal<void(const NetSharedPtr&)> torc::generic::Connectable::Disconnected

inherited

A signal to indicate that a connection has been removed

Definition at line 62 of file Connectable.hpp.

typedef BaseType::List torc::generic::Bundle< Net >::List

inherited

Definition at line 51 of file Bundle.hpp.

typedef std::vector<Pointer> torc::generic::Composite< Net >::List

inherited

List of Shared Pointers to objects of type Type

Definition at line 61 of file Composite.hpp.

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

inherited

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

typedef BaseType::Pointer torc::generic::Bundle< Net >::Pointer

inherited

Definition at line 50 of file Bundle.hpp.

typedef boost::shared_ptr<Type> torc::generic::Composite< Net >::Pointer

inherited

Shared Pointer to object of type Type

Definition at line 55 of file Composite.hpp.

typedef BaseType::SizeType torc::generic::Bundle< Net >::SizeType

inherited

Definition at line 52 of file Bundle.hpp.

typedef size_t torc::generic::Composite< Net >::SizeType

inherited

Definition at line 62 of file Composite.hpp.

typedef BaseType::Type torc::generic::Bundle< Net >::Type

inherited

Definition at line 49 of file Bundle.hpp.

typedef Net torc::generic::Composite< Net >::Type

inherited

Definition at line 50 of file Composite.hpp.

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

Definition at line 50 of file NetBundle.hpp.

typedef boost::weak_ptr<Type> torc::generic::Composite< Net >::WeakPointer

inherited

Definition at line 56 of file Composite.hpp.

Constructor & Destructor Documentation

torc::generic::NetBundle::~NetBundle	(	)
throw	(
	)

virtual

Definition at line 150 of file NetBundle.cpp.

150 {}

torc::generic::NetBundle::NetBundle ( )

protected

Definition at line 148 of file NetBundle.cpp.

148 : Net(), Bundle<Net>() {}

torc::generic::Net::Net

Net()

Definition: generic/Net.cpp:43

Member Function Documentation

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

virtual

Implements torc::generic::Visitable.

Definition at line 67 of file NetBundle.cpp.

                                                               {
     runVisitor(*this, inoutVisitor);
 }

Here is the call graph for this function:

virtual void torc::generic::Bundle< Net >::addChild	(	const boost::shared_ptr< Type > &	child	)
throw	(	Error
	)

virtualinherited

Add a child to the bundle. Note that, the new element is added to the end of the array.

Parameters

[in] child A pointer to a child

Exceptions

Error The composition is not a container or the child type is not proper

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::Net::addConnectedPort	(	const PortSharedPtr &	inPort	)
throw	(	Error
	)

protectedinherited

Connect a port to this net.

Parameters

[in] inPort port to be added. Empty pointer is ignored.

Exceptions

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

Definition at line 147 of file generic/Net.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;
     }
     mConnectedPorts.push_back(inPort);
     return;
 }

Here is the call graph for this function:

void torc::generic::Net::addConnectedPortList	(	const PortListSharedPtr &	inPort	)
throw	(	Error
	)

protectedinherited

Definition at line 218 of file generic/Net.cpp.

                                                                                 {
     if(!inPortList) {
         return;
     }
     mConnectedPortLists.push_back(inPortList);
     return;
 }

void torc::generic::Net::addConnectedPortReference	(	const PortReferenceSharedPtr &	inPortRef	)
throw	(	Error
	)

protectedinherited

Connect a port reference to this net.

Parameters

[in] inPortRef Port reference to be added

Exceptions

Error Could not add port reference

Definition at line 247 of file generic/Net.cpp.

                                                                                          {
     if(!inPortRef) {
         return;
     }
     std::string name = inPortRef->getName();
     if(name.empty()) {
         Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("PortReference name", name);
         throw e;
     }
     mConnectedPortRefs.push_back(inPortRef);
     return;
 }

Here is the call graph for this function:

void torc::generic::Net::addSubnet	(	const NetSharedPtr &	inSubnet	)
throw	(	Error
	)

inherited

Add a subnet to this net.

Parameters

[in] inSubnet Subnet to be added

Exceptions

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

Add a subnet to this net.

Parameters

[in] inSubnet Subnet to be added

Exceptions

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

Definition at line 63 of file generic/Net.cpp.

                                                               {
     std::string name = inSubnet->getName();
     if(name.empty()) {
         Error e(eMessageIdErrorEmptyItemName, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Subnet name", name);
         throw e;
     }
     if(false == mSubnets.set(name, inSubnet)) {
         Error e(eMessageIdErrorItemAlreadyExists, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Subnet name", name);
         throw e;
     }
     inSubnet->setParentNet(getSharedThis());
     return;
 }

Here is the call graph for this function:

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

inherited

Add an user data to the list of user data

Parameters

[in] inSource An user data as string

Definition at line 34 of file UserDataContainer.cpp.

                                                              {
     mUserData.push_back(inSource);
 }

void torc::generic::Bundle< Net >::applyOnAllChildren	(	const _Action &	action	)
throw	(	Error
	)

inherited

Here is the caller graph for this function:

template<typename _Action >

void torc::generic::Net::applyOnAllConnectedPortLists	(	const _Action &	action	)
throw	(	Error
	)

inlineinherited

Apply action on all connected port lists.

Parameters

[in] action Action to be applied

Definition at line 317 of file generic/Net.hpp.

                   {
     try {
         std::for_each(mConnectedPortLists.begin(), mConnectedPortLists.end(), action);
     } catch(Error& e) {
         e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
         throw;
     }
 }

Here is the call graph for this function:

template<typename _Action >

void torc::generic::Net::applyOnAllConnectedPortRefs	(	const _Action &	action	)
throw	(	Error
	)

inlineinherited

Apply action on all connected port refs.

Parameters

[in] action Action to be applied

Definition at line 327 of file generic/Net.hpp.

                   {
     try {
         std::for_each(mConnectedPortRefs.begin(), mConnectedPortRefs.end(), action);
     } catch(Error& e) {
         e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
         throw;
     }
 }

Here is the call graph for this function:

template<typename _Action >

void torc::generic::Net::applyOnAllConnectedPorts	(	const _Action &	action	)
throw	(	Error
	)

inlineinherited

Apply action on all connected ports.

Parameters

[in] action Action to be applied

Definition at line 307 of file generic/Net.hpp.

                   {
     try {
         std::for_each(mConnectedPorts.begin(), mConnectedPorts.end(), 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::Net::applyOnAllSubnets	(	const _Action &	action	)
throw	(	Error
	)

inlineinherited

Apply action on all Subnets.

Parameters

[in] action Action to be applied

Definition at line 284 of file generic/Net.hpp.

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

Here is the call graph for this function:

Connectable::Connection torc::generic::NetBundle::connect	(	const NetSharedPtr &	inNet	)
throw	(	Error
	)

virtual

Connect the given net with this net. During connection, a none-to-one correspondence is maintained, and all children of the given net are connected to the children of the current net. As a result, if the given net is a preserved vector, it will be exploded.

Parameters

[in] inNet Net to be connected to the current net

Exceptions

Error	Provided connection is invalid, because pointer to the Net does not exist Id : eMessageIdErrorPointerToItemDoesNotExist Context Data Pointer to Net - boost::shared_ptr
Error	Net size does not match with NetBundle size Id : eMessageIdErrorItemSizeMismatch Context Data Net Size - SizeType NetBundle Size - SizeType

Implements torc::generic::Connectable.

Definition at line 77 of file NetBundle.cpp.

                                                                                 {
     if(!inNet) {
         Error e(eMessageIdErrorPointerToItemDoesNotExist, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Pointer to Net", inNet);
         throw e;
     }
     if(inNet->getSize() != getSize()) {
         Error e(eMessageIdErrorItemSizeMismatch, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Net Size", inNet->getSize());
         e.saveContextData("NetBundle Size", getSize());
         throw e;
     }
     Bundle<Net>::List children;
     getChildren(children);
     Bundle<Net>::List netChildren;
     inNet->getChildren(netChildren);
     Bundle<Net>::List::iterator childNet = children.begin();
     Bundle<Net>::List::iterator childEnd = children.end();
     Bundle<Net>::List::iterator net = netChildren.begin();
     for(; childNet != childEnd; ++childNet, ++net) {
         try {
             (*childNet)->connect(*net);
         } catch(Error& e) {
             e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
             throw;
         }
     }
     return Connectable::connect(inNet);
 }

Here is the call graph for this function:

void torc::generic::NetBundle::disconnect	(	const Connection &	inConnection	)
throw	(	Error
	)

virtual

Implements torc::generic::Connectable.

Definition at line 107 of file NetBundle.cpp.

                                                                        {
     NetSharedPtr connNet = *inConnection;
     Bundle<Net>::List children;
     getChildren(children);
     Bundle<Net>::List netChildren;
     connNet->getChildren(netChildren);
     Bundle<Net>::List::iterator childNet = children.begin();
     Bundle<Net>::List::iterator childEnd = children.end();
     Bundle<Net>::List::iterator net = netChildren.begin();
     //We find all bits from the connected net and remove them
     //from the children nets. This disconnect is a little slow
     //as lookup is performed for each net. Otherwise we
     //would have to save the iterators (Connection objects)
     //for each child connection
     for(; childNet != childEnd; ++childNet, ++net) {
         try {
             (*childNet)->Connectable::disconnect(*net);
         } catch(Error& e) {
             e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
             throw;
         }
     }
     Connectable::disconnect(inConnection);
 }

Here is the call graph for this function:

void torc::generic::NetBundle::disconnect	(		)
throw	(	Error
	)

virtual

Reimplemented from torc::generic::Net.

Definition at line 132 of file NetBundle.cpp.

                                          {
     Bundle<Net>::List children;
     getChildren(children);
     Bundle<Net>::List::iterator childNet = children.begin();
     Bundle<Net>::List::iterator childEnd = children.end();
     for(; childNet != childEnd; ++childNet) {
         try {
             (*childNet)->disconnect();
         } catch(Error& e) {
             e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
             throw;
         }
     }
     Net::disconnect();
 }

Here is the call graph for this function:

void torc::generic::Connectable::disconnect	(	const std::string &	inName	)
throw	(	Error
	)

inherited

Disconnect the named Net from this object.

Note: This metod can be overridden by derived classes. However, the method must call the on_connected() method after this. The sigConnected_ signal must also be invoked in the overriding method.

Parameters

[in] inName Name of the net to be Disconnected

Exceptions

Error Provided net was not found

Disconnect the named Net from this object.

Note: This metod can be overridden by derived classes. However, the method must call the on_connected() method after this. The sigConnected_ signal must also be invoked in the overriding method.

Parameters

[in] inNname Name of the net to be Disconnected

Exceptions

Error Provided net was not found

Definition at line 111 of file Connectable.cpp.

                                                                   {
     disconnect(std::find_if(mConnectedNets.begin(), mConnectedNets.end(),
         boost::bind<bool>(std::equal_to<std::string>(),
         boost::bind(boost::mem_fn(&Net::getName), _1), inName)));
 }

Here is the call graph for this function:

void torc::generic::Connectable::disconnect	(	const NetSharedPtr &	inNet	)
throw	(	Error
	)

inherited

Disconnect the given Net from this object.

Note: This metod can be overridden by derived classes. However, the method must call the on_disconnected() method after this. The sigDisconnected_ signal must also be invoked in the overriding method.

Parameters

[in] net Pointer to a net

Exceptions

Error Provided net was not found

Disconnect the given Net from this object.

Note: This metod can be overridden by derived classes. However, the method must call the on_disconnected() method after this. The sigDisconnected_ signal must also be invoked in the overriding method.

Parameters

[in] inNet Pointer to a net

Exceptions

Error Provided net was not found

Definition at line 128 of file Connectable.cpp.

                                                                     {
     disconnect(std::find(mConnectedNets.begin(), mConnectedNets.end(), inNet));
 }

PortSharedPtr torc::generic::Net::findConnectedPort	(	const std::string &	inName	)
throw	(	Error
	)

inherited

Find a port connected to this net.

Parameters

[in] inName Name of the port. If not found, empty pointer is returned

Definition at line 166 of file generic/Net.cpp.

                                                                           {
     PortSharedPtr port;
     std::list<PortSharedPtr>::iterator it = find_if(
         mConnectedPorts.begin(),
         mConnectedPorts.end(),
         boost::bind<bool>(std::equal_to<std::string>(),
             boost::bind(boost::mem_fn(&Port::getName), _1), inName));
     if(it != mConnectedPorts.end()) {
         port = *it;
     }
     return port;
 }

Here is the call graph for this function:

PortReferenceSharedPtr torc::generic::Net::findConnectedPortReference	(	const std::string &	inName	)
throw	(	Error
	)

inherited

Find a port reference connected to this net.

Parameters

[in] inName Name of the port reference. If not found, empty pointer is returned

Definition at line 266 of file generic/Net.cpp.

                                                                                             {
     PortReferenceSharedPtr portRef;
     std::list<PortReferenceSharedPtr>::iterator it = find_if(
         mConnectedPortRefs.begin(),
         mConnectedPortRefs.end(),
         boost::bind<bool>(std::equal_to<std::string>(),
             boost::bind(boost::mem_fn(&PortReference::getName), _1), inName));
     if(it != mConnectedPortRefs.end()) {
         portRef = *it;
     }
     return portRef;
 }

Here is the call graph for this function:

NetSharedPtr torc::generic::Net::findSubnet	(	const std::string &	inName	)
throw	(	Error
	)

inherited

Find a subnet from belonging to this net.

Parameters

[in] inName Name of the subnet. If not found, empty pointer is returned

Definition at line 85 of file generic/Net.cpp.

                                                                   {
     NetSharedPtr subnet;
     mSubnets.get(inName, subnet);
     return subnet;
 }

virtual const Pointer torc::generic::Bundle< Net >::get	(	const std::vector< SizeType > &	indices	)	const
throw	(	Error
	)

virtualinherited

Get a specific member of this composition.

Returns: An empty pointer is returned

Exceptions

Error Index dimensions mismatch

Implements torc::generic::Composite< Net >.

virtual const Pointer torc::generic::Composite< Net >::get	(	const std::vector< SizeType > &	inIndices	)	const
throw	(	Error
	)

pure virtualinherited

Get a specific member of this composition.

Note: This is relevant for Vector composition only. Other compositions return a NULL pointer

Parameters

[in] inIndices A list of indices to be accessed. The number of indices must be equal to the number of dimensions.

Returns: A pointer to the child situated at the specified indices. For non-relevant types a NULL pointer is returned

Exceptions

Error Index dimensions mismatch

Implemented in torc::generic::Vector< Net, VectorNetBit, VectorNetBit::Factory, true >, torc::generic::Bundle< Net >, torc::generic::VectorBit< Net >, and torc::generic::Scalar< Net >.

const NetAttributesSharedPtr torc::generic::Net::getAttributes ( ) const

inlineinherited

Get the attributes of the net. Attributes include criticality, netDelay etc.

Returns: Pointer to NetAttributes object.

Definition at line 303 of file generic/Net.hpp.

                                                              {
     return mAttributes;
 }

virtual void torc::generic::Bundle< Net >::getChildren	(	List &	outChildren	)	const
throw	(	Error
	)

virtualinherited

Get children of this composition.

Parameters

[out] outChildren A list of all children for this composition

Here is the caller graph for this function:

virtual void torc::generic::Composite< Net >::getChildren	(	List &	outChildren	)	const
throw	(	Error
	)

pure virtualinherited

Get children of this composition.

Note: This is relevant for Vector and Bundle compositions only. Other compositions return a NULL pointer

Parameters

[out] outChildren A list of all children for this composition

Implemented in torc::generic::Vector< Net, VectorNetBit, VectorNetBit::Factory, true >, torc::generic::Scalar< Net >, and torc::generic::VectorBit< Net >.

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

virtual CompositionType torc::generic::Bundle< Net >::getCompositionType ( ) const

virtualinherited

Get composition type for this object

Returns: The CompositionType inSource VECTOR is returned

Implements torc::generic::Composite< Net >.

virtual CompositionType torc::generic::Composite< Net >::getCompositionType ( ) const

pure virtualinherited

Get the type of this composition.

Returns: Composition type for this object

Implemented in torc::generic::Vector< Net, VectorNetBit, VectorNetBit::Factory, true >, torc::generic::Bundle< Net >, torc::generic::VectorBit< Net >, and torc::generic::Scalar< Net >.

void torc::generic::Connectable::getConnectedNets	(	std::vector< NetSharedPtr > &	outNets,
		bool	inSkipChildConnections = `false`
	)		const
throw	(	Error
	)

virtualinherited

Get the vector of Nets that are Connected to the current object. The connected elements are appended to the given vector

Parameters

[out] outNets A vector of Connected nets

Get the vector of Nets that are Connected to the current object. The connected elements are appended to the given vector

Returns: A vector of Connected nets

Reimplemented in torc::generic::VectorPortReference, torc::generic::VectorNet, torc::generic::VectorPort, torc::generic::VectorNetBit, torc::generic::VectorPortBit, and torc::generic::VectorPortBitReference.

Definition at line 45 of file Connectable.cpp.

                         {
     outNets.insert(outNets.end(), mConnectedNets.begin(), mConnectedNets.end());
 }

Here is the caller graph for this function:

void torc::generic::Net::getConnectedPortLists ( std::vector< PortListSharedPtr > & outPortList ) const

virtualinherited

Appends vector of connected port lists

Parameters

[in] outPortList vector of port lists to be appended to

Definition at line 213 of file generic/Net.cpp.

                                                                                {
     outPortList.insert(outPortList.end(), mConnectedPortLists.begin(), mConnectedPortLists.end());
     return;
 }

Here is the caller graph for this function:

void torc::generic::Net::getConnectedPortRefs	(	std::vector< PortReferenceSharedPtr > &	outPortRefs,
		bool	inSkipChildConnections = `false`
	)		const

virtualinherited

Appends vector of connected port references

Parameters

[in] outPortRefs vector of port refs to be appended to

Reimplemented in torc::generic::VectorNet, and torc::generic::VectorNetBit.

Definition at line 279 of file generic/Net.cpp.

                                        {
     outPortRefs.insert(outPortRefs.end(), mConnectedPortRefs.begin(), mConnectedPortRefs.end());
     return;
 }

Here is the caller graph for this function:

void torc::generic::Net::getConnectedPorts	(	std::vector< PortSharedPtr > &	outPort,
		bool	inSkipChildConnections = `false`
	)		const

virtualinherited

Appends vector of connected ports

Parameters

[in]	outPort	vector of port to be appended to
[in]	inSkipChildConnections	Return only ports connected to this port and skip returning elements that have been connected to the child

Reimplemented in torc::generic::VectorNet, and torc::generic::VectorNetBit.

Definition at line 179 of file generic/Net.cpp.

                                        {
     outPorts.insert(outPorts.end(), mConnectedPorts.begin(), mConnectedPorts.end());
     return;
 }

Here is the caller 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:

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

inlineinherited

Get a pointer to the parent object

Returns: Pointer to parent

Here is the caller graph for this function:

virtual Pointer torc::generic::Composite< Net >::getParentCollection ( ) const

inlinevirtualinherited

Get a pointer to the parent collection

Returns: A pointer to the parent collection if present, empty pointer otherwise

Here is the caller graph for this function:

NetSharedPtr torc::generic::Net::getParentNet ( ) const

inlineinherited

Definition at line 294 of file generic/Net.hpp.

                                             {
     return mParentNet;
 }

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

Here is the caller graph for this function:

virtual SizeType torc::generic::Bundle< Net >::getSize ( void ) const

virtualinherited

Get the total number of bits of the composition

Returns: Number of bits

Implements torc::generic::Composite< Net >.

virtual size_t torc::generic::Composite< Net >::getSize ( void ) const

pure virtualinherited

Get the total number of bits of the composition

Returns: Number of bits

Implemented in torc::generic::Vector< Net, VectorNetBit, VectorNetBit::Factory, true >, torc::generic::Bundle< Net >, torc::generic::VectorBit< Net >, and torc::generic::Scalar< Net >.

void torc::generic::Net::getSubnets ( std::vector< NetSharedPtr > & outSubnets ) const

inlineinherited

Definition at line 279 of file generic/Net.hpp.

                                                                      {
     mSubnets.getValues(outSubnets);
     return;
 }

Here is the call graph for this function:

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

inlineinherited

Get the list of all userData

Parameters

[out] outUserData The list of all userData

Definition at line 78 of file UserDataContainer.hpp.

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

void torc::generic::Connectable::onConnect	(		)
throw	(	Error
	)

protectedvirtualinherited

A polymorphic function that is called after a net is Connected to this object

Definition at line 144 of file Connectable.cpp.

144 {}

void torc::generic::Connectable::onDisconnect	(		)
throw	(	Error
	)

protectedvirtualinherited

A polymorphic function that is called after a net is Disconnected from this object

Definition at line 149 of file Connectable.cpp.

149 {}

void torc::generic::Net::removeConnectedPort	(	const PortSharedPtr &	inPort	)
throw	(	Error
	)

protectedinherited

Definition at line 185 of file generic/Net.cpp.

                                                                        {
     std::list<PortSharedPtr>::iterator it = find(mConnectedPorts.begin(), mConnectedPorts.end(),
         inPort);
     if(it != mConnectedPorts.end()) {
         mConnectedPorts.erase(it);
     } else {
         Error e(eMessageIdErrorItemNotFound, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Name", inPort->getName());
         throw e;
     }
     return;
 
 }

Here is the call graph for this function:

void torc::generic::Net::removeConnectedPortList	(	const PortListSharedPtr &	inList	)
throw	(	Error
	)

protectedinherited

Definition at line 226 of file generic/Net.cpp.

                                                                                    {
     std::list<PortListSharedPtr>::iterator it = find(mConnectedPortLists.begin(),
         mConnectedPortLists.end(), inPortList);
     if(it != mConnectedPortLists.end()) {
         mConnectedPortLists.erase(it);
     } else {
         Error e(eMessageIdErrorItemNotFound, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Name", std::string("PortList"));
         throw e;
     }
     return;
 
 }

Here is the call graph for this function:

void torc::generic::Net::removeConnectedPortReference	(	const PortReferenceSharedPtr &	inPortRef	)
throw	(	Error
	)

protectedinherited

Definition at line 285 of file generic/Net.cpp.

                                                                                             {
     std::list<PortReferenceSharedPtr>::iterator it = find(mConnectedPortRefs.begin(),
         mConnectedPortRefs.end(), inPortRef);
     if(it != mConnectedPortRefs.end()) {
         mConnectedPortRefs.erase(it);
     } else {
         Error e(eMessageIdErrorItemNotFound, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("PortReference name", inPortRef->getName());
         throw e;
     }
     return;
 }

Here is the call graph for this function:

void torc::generic::Net::removeSubnet	(	const std::string &	inName	)
throw	(	Error
	)

inherited

Remove a subnet from this net.

Parameters

inName Name of the object to be delete

Exceptions

Error	Could not remove subnet, because subnet name is empty Id : eMessageIdErrorEmptyItemName Context Data Subnet name - String
Error	Could not remove subnet, because subnet not present. Id : eMessageIdErrorItemNotFound Context Data Subnet name - String

Remove a subnet from this net.

Parameters

inName Name of the object to be delete

Exceptions

Error	Could not remove subnet, because subnet name is empty
Error	Could not remove subnet, because subnet not present.

Definition at line 99 of file generic/Net.cpp.

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

Here is the call graph for this function:

void torc::generic::Net::setAttributes ( const NetAttributesSharedPtr & inSource )

inherited

Set the attributes of the net. Attributes include criticality, netDelay etc.

Parameters

[in] inSource Pointer to NetAttributes object.

Definition at line 122 of file generic/Net.cpp.

                                                               {
     mAttributes = inSource;
 }

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::Net::setConnectedPortRefs	(	const std::vector< PortReferenceSharedPtr > &	inSource	)
throw	(	Error
	)

protectedinherited

Definition at line 298 of file generic/Net.cpp.

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

Here is the call graph for this function:

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

protectedinherited

Definition at line 199 of file generic/Net.cpp.

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

Here is the call graph for this function:

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

virtualinherited

Set a pointer to the parent

Parameters

[in] inSource Set a pointer to the parent

Here is the caller graph for this function:

void torc::generic::NetBundle::setParent ( const ViewSharedPtr & inParent )

virtual

Definition at line 71 of file NetBundle.cpp.

                                                        {
     ParentedObject<View>::setParent(inParent);
     applyOnAllChildren(boost::bind(boost::mem_fn(&Net::setParent), _1, getParent()));
 }

Here is the call graph for this function:

virtual void torc::generic::Composite< Net >::setParentCollection ( const Pointer & inParentCollection )

inlinevirtualinherited

Set a pointer to a parnt composition.

Parameters

[in] inParentCollection pointer to the parent collection (Vector/Bundle)

Set a pointer to a parnt composition.

Parameters

[in] parentCollection pointer to the parent collection (Vector/Bundle)

void torc::generic::Net::setParentNet ( const NetSharedPtr & inParent )

inherited

Definition at line 113 of file generic/Net.cpp.

                                                    {
     mParentNet = inParent;
 }

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

inherited

Definition at line 126 of file generic/Net.cpp.

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

Here is the call graph for this function:

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

Connectable::Connected & torc::generic::Connectable::signalNetConnected ( )

inlineinherited

A signal to indicate that a new connection has been made

Definition at line 167 of file Connectable.hpp.

                                                              {
     return mSigNetConnected;
 }

Connectable::Disconnected & torc::generic::Connectable::signalNetDisconnected ( )

inlineinherited

A signal to indicate that a new connection has been made

Definition at line 174 of file Connectable.hpp.

                                                                    {
     return mSigNetDisconnected;
 }

Friends And Related Function Documentation

friend class FactoryType< NetBundle >

friend

Definition at line 47 of file NetBundle.hpp.

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

Data Structures

Public Types

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation