Represents areference to a standalone port. More...

#include <ScalarPortReference.hpp>

Inheritance diagram for torc::generic::ScalarPortReference:

Collaboration diagram for torc::generic::ScalarPortReference:

Data Structures
class	Factory

Public Types
typedef VisitorType < ScalarPortReference >	Visitor

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

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

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

typedef PortReference	Type

typedef boost::shared_ptr< Type >	Pointer

typedef boost::weak_ptr< Type >	WeakPointer

typedef std::vector< Pointer >	List

typedef size_t	SizeType

typedef Composite < PortReference >::Type	Type

typedef Composite < PortReference >::Pointer	Pointer

typedef Composite < PortReference >::List	List

typedef Composite < PortReference >::SizeType	SizeType

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

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

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

	~ScalarPortReference () throw ()

PortSharedPtr	getMaster () const

virtual void	bindToMasterPort (const PortSharedPtr &inMaster) throw (Error)

const PortAttributesSharedPtr	getAttributes () const

void	setAttributes (const PortAttributesSharedPtr &inSource)

std::string	getName ()

Connected &	signalNetConnected ()

Disconnected &	signalNetDisconnected ()

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

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

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

virtual void	disconnect () 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 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< Instance >	getParent () const

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

virtual CompositionType	getCompositionType () const

virtual SizeType	getSize () const

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

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

Protected Member Functions
	ScalarPortReference ()

virtual void	onConnect () throw (Error)

virtual void	onDisconnect () throw (Error)

Friends
class	FactoryType< ScalarPortReference >

Detailed Description

Represents areference to a standalone port.

The ScalarPortReference class represents a reference to a a standalone port object.

Definition at line 41 of file ScalarPortReference.hpp.

Member Typedef Documentation

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 Composite<PortReference >::List torc::generic::Scalar< PortReference >::List

inherited

Definition at line 41 of file Scalar.hpp.

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

inherited

List of Shared Pointers to objects of type Type

Definition at line 61 of file Composite.hpp.

typedef Composite<PortReference >::Pointer torc::generic::Scalar< PortReference >::Pointer

inherited

Definition at line 40 of file Scalar.hpp.

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

inherited

Shared Pointer to object of type Type

Definition at line 55 of file Composite.hpp.

typedef Composite<PortReference >::SizeType torc::generic::Scalar< PortReference >::SizeType

inherited

Definition at line 42 of file Scalar.hpp.

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

inherited

Definition at line 62 of file Composite.hpp.

typedef Composite<PortReference >::Type torc::generic::Scalar< PortReference >::Type

inherited

Definition at line 39 of file Scalar.hpp.

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

inherited

Definition at line 50 of file Composite.hpp.

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

Definition at line 48 of file ScalarPortReference.hpp.

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

inherited

Definition at line 56 of file Composite.hpp.

Constructor & Destructor Documentation

torc::generic::ScalarPortReference::~ScalarPortReference	(	)
throw	(
	)

Definition at line 118 of file ScalarPortReference.cpp.

118 {}

torc::generic::ScalarPortReference::ScalarPortReference ( )

protected

Definition at line 116 of file ScalarPortReference.cpp.

116 : PortReference(), Scalar<PortReference>() {}

torc::generic::PortReference::PortReference

PortReference()

Definition: PortReference.cpp:35

Member Function Documentation

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

virtual

Implements torc::generic::Visitable.

Definition at line 65 of file ScalarPortReference.cpp.

                                                                         {
     try {
         runVisitor(*this, inoutVisitor);
     } 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:

void torc::generic::PortReference::bindToMasterPort	(	const PortSharedPtr &	inMaster	)
throw	(	Error
	)

virtualinherited

Set master port.

Parameters

[in] inMaster Set the master port.

Set master port.

Parameters

[in] inSource Set the master port.

Reimplemented in torc::generic::VectorPortReference, and torc::generic::PortBundleReference.

Definition at line 45 of file PortReference.cpp.

                                                                                 {
     mMaster = inMaster;
 }

Here is the caller graph for this function:

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

virtual

Exceptions

Error	Pointer to the Net object does not exists Id : eMessageIdErrorPointerToItemDoesNotExist Context Data Pointe to Net object - Net
Error	Net size does not match with scalar port reference size Id : eMessageIdErrorItemSizeMismatch Context Data Net Size - SizeType Scalar port reference Size - SizeType

Implements torc::generic::Connectable.

Definition at line 74 of file ScalarPortReference.cpp.

                                                                                           {
     if(!inNet) {
         Error e(eMessageIdErrorPointerToItemDoesNotExist, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Pointer to the Net object does not exist", inNet);
         throw e;
     }
     if(inNet->getSize() != getSize()) {
         Error e(eMessageIdErrorItemSizeMismatch, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Net Size", inNet->getSize());
         e.saveContextData("Scalar port reference Size", getSize());
         throw e;
     }
     Connectable::Connection newConnection;
     try {
         ConnectionHandler handler(inNet);
         handler.connectPortRefToNet(getSharedThis());
         newConnection = Connectable::connect(inNet);
     } catch(Error& e) {
         e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
         throw;
     }
     return newConnection;
 }

Here is the call graph for this function:

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

virtual

Implements torc::generic::Connectable.

Definition at line 98 of file ScalarPortReference.cpp.

                                                                                  {
     NetSharedPtr connNet = *inConnection;
     if(!connNet) {
         Error e(eMessageIdErrorConnectionInvalid, __FUNCTION__, __FILE__, __LINE__);
         e.saveContextData("Net is invalid", connNet);
         throw e;
     }
     try {
         ConnectionHandler handler(connNet);
         handler.disconnectPortRefFromNet(getSharedThis());
         Connectable::disconnect(inConnection);
     } catch(Error& e) {
         e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
         throw;
     }
     return;
 }

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

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

virtualinherited

Disconnect all connections to this port.

Reimplemented in torc::generic::Net, torc::generic::VectorNet, and torc::generic::NetBundle.

Definition at line 132 of file Connectable.cpp.

                                            {
     log("Disconnecting all\n");
     std::vector<NetSharedPtr> nets;
     getConnectedNets(nets, true);
     for(std::vector<NetSharedPtr>::iterator it = nets.begin(); it != nets.end(); ++it) {
         disconnect(*it);
     }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

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

virtualinherited

Get a specific member of this composition.

Parameters

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

Returns: An empty pointer is returned

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

virtual const Pointer torc::generic::Composite< PortReference >::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< PortReference, VectorPortBitReference, VectorPortBitReference::Factory, true >, torc::generic::Bundle< PortReference >, torc::generic::VectorBit< PortReference >, and torc::generic::Scalar< PortReference >.

const PortAttributesSharedPtr torc::generic::PortReference::getAttributes ( ) const

inlineinherited

Get the attributes of the port. Attributes include dcFaninLoad, dcFanoutLoad_ etc.

Returns: Pointer to PortAttributes object.

Definition at line 123 of file PortReference.hpp.

                                                                         {
     return mAttributes;
 }

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

virtualinherited

Get children of this composition.

Parameters

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

Note: This wil return empty list for scalar

Get children of this composition.

Parameters

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

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

virtual void torc::generic::Composite< PortReference >::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< PortReference, VectorPortBitReference, VectorPortBitReference::Factory, true >, torc::generic::Bundle< PortReference >, torc::generic::Scalar< PortReference >, and torc::generic::VectorBit< PortReference >.

virtual CompositionType torc::generic::Scalar< PortReference >::getCompositionType ( ) const

virtualinherited

Get composition type for this object

Returns: The CompositionType inSource eCompositionTypeScalar is returned

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

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

pure virtualinherited

Get the type of this composition.

Returns: Composition type for this object

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

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:

PortSharedPtr torc::generic::PortReference::getMaster ( ) const

inlineinherited

Get the master(referred) port.

Returns: The master port.

Definition at line 114 of file PortReference.hpp.

                                                     {
     return mMaster;
 }

std::string torc::generic::PortReference::getName ( void )

inherited

Get name of port-ref. This will return the same name as the master.

Returns: Name of the master if master is set. Otherwise returns empty string.

Definition at line 52 of file PortReference.cpp.

                                  {
     return (mMaster) ? mMaster->getName() : std::string();
 }

Here is the caller graph for this function:

const boost::shared_ptr<Instance > torc::generic::ParentedObject< Instance >::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< PortReference >::getParentCollection ( ) const

inlinevirtualinherited

Get a pointer to the parent collection

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

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

virtual SizeType torc::generic::Scalar< PortReference >::getSize ( void ) const

virtualinherited

Get the total number of bits of the composition

Returns: Number of bits

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

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

pure virtualinherited

Get the total number of bits of the composition

Returns: Number of bits

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

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::PortReference::setAttributes ( const PortAttributesSharedPtr & inSource )

inherited

Set the attributes of the port. Attributes include dcFaninLoad, dcFanoutLoad_ etc.

Note: This method does not check whether prior set of properties exist or not. Newly set property will remove old properties.

Parameters

[in] inSource Pointer to PortAttributes object.

Definition at line 49 of file PortReference.cpp.

                                                                          {
     mAttributes = inSource;
 }

virtual void torc::generic::ParentedObject< Instance >::setParent ( const boost::shared_ptr< Instance > & 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:

virtual void torc::generic::Composite< PortReference >::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::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::SelfReferencing< PortReference >::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< ScalarPortReference >

friend

Definition at line 45 of file ScalarPortReference.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