torc::generic::PortRefCreator< _ReturnType > Class Template Reference

Create port reference. More...

#include <PortRefCreator.hpp>

Inheritance diagram for torc::generic::PortRefCreator< _ReturnType >:

Collaboration diagram for torc::generic::PortRefCreator< _ReturnType >:

Public Member Functions
void	visit (ScalarPort &port) throw (Error)
void	visit (VectorPort &port) throw (Error)
void	visit (PortBundle &port) throw (Error)
_ReturnType	getReturnValue () const
	PortRefCreator (const ObjectFactorySharedPtr &inFactory, const InstanceSharedPtr &inInstance, const PortBundleReferenceSharedPtr &inBundle=PortBundleReferenceSharedPtr())
	~PortRefCreator () throw ()
virtual void	visit (_Tp &client)=0 throw (Error)

Private Member Functions
void	setupCreatedPort (const PortSharedPtr &port, const PortReferenceSharedPtr &inPortRef) throw (Error)

Private Attributes
ObjectFactorySharedPtr	mFactory
InstanceSharedPtr	mInstance
PortBundleReferenceSharedPtr	mBundle
_ReturnType	mReturnValue

Detailed Description

template<typename _ReturnType>
class torc::generic::PortRefCreator< _ReturnType >

Create port reference.

The PortRefCreator class is used to create scalar, vector and bundle port reference

Definition at line 37 of file PortRefCreator.hpp.

Constructor & Destructor Documentation

template<typename _ReturnType >

torc::generic::PortRefCreator< _ReturnType >::PortRefCreator	(	const ObjectFactorySharedPtr &	inFactory,
		const InstanceSharedPtr &	inInstance,
		const PortBundleReferenceSharedPtr &	inBundle = PortBundleReferenceSharedPtr()
	)

Definition at line 110 of file PortRefCreator.hpp.

                                                  :
    mFactory(inFactory), mInstance(inInstance), mBundle(inBundle), mReturnValue() {}

template<typename _ReturnType >

torc::generic::PortRefCreator< _ReturnType >::~PortRefCreator	(		)
throw	(
	)

Definition at line 115 of file PortRefCreator.hpp.

{}

Member Function Documentation

template<typename _ReturnType >

_ReturnType torc::generic::PortRefCreator< _ReturnType >::getReturnValue ( ) const

inline

Definition at line 105 of file PortRefCreator.hpp.

          {
    return mReturnValue;
}

Here is the caller graph for this function:

template<typename _ReturnType >

void torc::generic::PortRefCreator< _ReturnType >::setupCreatedPort ( const PortSharedPtr &  port, const PortReferenceSharedPtr &  inPortRef  ) throw ( Error )

private

Definition at line 117 of file PortRefCreator.hpp.

                                                                                      {
    try {
        inPortRef->bindToMasterPort(port);
        if(mBundle) {
            inPortRef->setParentCollection(mBundle);
            mBundle->addChild(inPortRef);
        } else {
            inPortRef->setParent(mInstance);
            mInstance->addPortReference(inPortRef);
        }
    } catch(Error& e) {
        e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
        throw;
    }
}

Here is the call graph for this function:

template<typename _ReturnType >

void torc::generic::PortRefCreator< _ReturnType >::visit	(	ScalarPort &	port	)
throw	(	Error
	)

Definition at line 62 of file PortRefCreator.hpp.

                  {
    try {
        ScalarPortReferenceSharedPtr scalarPortRef;
        mFactory->create(scalarPortRef);
        setupCreatedPort(port.getSharedThis(), scalarPortRef);
    } catch(Error& e) {
        e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
        throw;
    }
}

Here is the call graph for this function:

template<typename _ReturnType >

void torc::generic::PortRefCreator< _ReturnType >::visit	(	VectorPort &	port	)
throw	(	Error
	)

Definition at line 74 of file PortRefCreator.hpp.

                  {
    try {
        VectorPortReferenceSharedPtr vectorPortRef;
        mFactory->create(vectorPortRef);
        std::vector < size_t > limits;
        port.getLimits(limits);
        vectorPortRef->constructChildren(mFactory, limits);
        setupCreatedPort(port.getSharedThis(), vectorPortRef);
    } catch(Error& e) {
        e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
        throw;
    }
}

Here is the call graph for this function:

template<typename _ReturnType >

void torc::generic::PortRefCreator< _ReturnType >::visit	(	PortBundle &	port	)
throw	(	Error
	)

Definition at line 89 of file PortRefCreator.hpp.

                  {
    try {
        PortBundleReferenceSharedPtr portBundleRef;
        mFactory->create(portBundleRef);
        PortRefCreator<PortReferenceSharedPtr> creator(mFactory, mInstance, portBundleRef);
        VisitorApplier<PortRefCreator<PortReferenceSharedPtr> > applier(creator);
        port.applyOnAllChildren(applier);
        setupCreatedPort(port.getSharedThis(), portBundleRef);
        mReturnValue = portBundleRef;
    } catch(Error& e) {
        e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
        throw;
    }
}

Here is the call graph for this function:

template<typename _Tp >

virtual void torc::generic::VisitorType< _Tp >::visit ( _Tp &  client ) throw ( Error )

pure virtualinherited

Visit the target object. This will typically be a derived leaf type.

Parameters

[in,out]

client

A reference to the target object

Exceptions

Error

Exception generated by any of the functions called from inside visit()

Here is the caller graph for this function:

Field Documentation

template<typename _ReturnType>

PortBundleReferenceSharedPtr torc::generic::PortRefCreator< _ReturnType >::mBundle

private

Definition at line 58 of file PortRefCreator.hpp.

template<typename _ReturnType>

ObjectFactorySharedPtr torc::generic::PortRefCreator< _ReturnType >::mFactory

private

Definition at line 56 of file PortRefCreator.hpp.

template<typename _ReturnType>

InstanceSharedPtr torc::generic::PortRefCreator< _ReturnType >::mInstance

private

Definition at line 57 of file PortRefCreator.hpp.

template<typename _ReturnType>

_ReturnType torc::generic::PortRefCreator< _ReturnType >::mReturnValue

private

Definition at line 59 of file PortRefCreator.hpp.

---

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

• PortRefCreator.hpp