torc::generic::VectorPortReference::Factory Class Reference

#include <VectorPortReference.hpp>

Inheritance diagram for torc::generic::VectorPortReference::Factory:

Collaboration diagram for torc::generic::VectorPortReference::Factory:

Public Types
typedef VectorPortReference	Type
typedef SelfReferencing< Type > ::Pointer	Pointer
typedef SelfReferencing< Type > ::WeakPointer	WeakPointer

Public Member Functions
virtual VectorPortReferenceSharedPtr	newVectorPortReferencePtr (const InstanceSharedPtr &inInstancePtr, const PortSharedPtr &inPortPtr, const size_t &inSize, const PortBundleReferenceSharedPtr &inParentCollection=PortBundleReferenceSharedPtr(), const ChildFactorySharedPtr &inFactory=BaseType::ChildFactorySharedPtr(new BaseType::ChildFactory())) throw (Error)
virtual VectorPortReferenceSharedPtr	newVectorPortReferencePtr (const InstanceSharedPtr &inInstancePtr, const PortSharedPtr &inPortPtr, const std::vector< size_t > &inLimits, const PortBundleReferenceSharedPtr &inParentCollection=PortBundleReferenceSharedPtr(), const ChildFactorySharedPtr &inFactory=BaseType::ChildFactorySharedPtr(new BaseType::ChildFactory())) throw (Error)
virtual void	create (Pointer &outPointer) throw (Error)

Detailed Description

Convenience class to create a vector port ref.

Definition at line 59 of file VectorPortReference.hpp.

Member Typedef Documentation

typedef SelfReferencing<Type>::Pointer torc::generic::FactoryType< VectorPortReference >::Pointer

inherited

A pointer to an object of type Type

Definition at line 45 of file FactoryType.hpp.

typedef VectorPortReference torc::generic::FactoryType< VectorPortReference >::Type

inherited

A rename of the parameter type

Definition at line 40 of file FactoryType.hpp.

typedef SelfReferencing<Type>::WeakPointer torc::generic::FactoryType< VectorPortReference >::WeakPointer

inherited

A weak pointer to an object of type Type

Definition at line 50 of file FactoryType.hpp.

Member Function Documentation

virtual void torc::generic::FactoryType< VectorPortReference >::create ( Pointer &  outPointer ) throw ( Error )

inlinevirtualinherited

Create an object of the Type specification of Factory. If the object has a boost::weak_ptr to itself, it is the task of this method to set this after the object is created.

Returns

A pointer to the freshly created object.

Definition at line 58 of file FactoryType.hpp.

                                                           {
        try {
            Pointer temp(new _Tp()); //Do not remove
            outPointer = temp;
            WeakPointer weakPtr(outPointer);
            outPointer->setWeakThis(weakPtr);
        } catch(std::exception& e) //May receive std::bad_alloc
        {
            //TBD::ERROR
        }
    }

VectorPortReferenceSharedPtr torc::generic::VectorPortReference::Factory::newVectorPortReferencePtr ( const InstanceSharedPtr &  inInstancePtr, const PortSharedPtr &  inPortPtr, const size_t &  inSize, const PortBundleReferenceSharedPtr &  inParentCollection = PortBundleReferenceSharedPtr(), const ChildFactorySharedPtr &  inFactory = BaseType::ChildFactorySharedPtr(new BaseType::ChildFactory())  ) throw ( Error )

virtual

Create a vector port ref.

Parameters

[in]	inInstancePtr	Pointer to parented(Instance) object.
[in]	inPortPtr	Pointer to master(Port) object.
[in]	inSize	Size of the net array.
[in]	inParentCollection	Pointer to parent bundle.
[in]	inFactory	Factory for the child.

Returns

Pointer to created scalar port ref.

Create a vector port ref.

Parameters

[in]	inInstancePtr	Pointer to parented(Instance) object.
[in]	inPortPtr	Pointer to master(Port) object.
[in]	inSize	Size of the net array.
[in]	inFactory	Factory for the child.

Returns

Pointer to created scalar port ref.

Definition at line 78 of file VectorPortReference.cpp.

                      {
    try {
        std::vector < size_t > limits;
        limits.push_back(inSize);
        return newVectorPortReferencePtr(inInstancePtr, inPortPtr, limits, inParentCollection,
            inFactory);
    } catch(Error& e) {
        e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
        throw;
    }
}

Here is the call graph for this function:

VectorPortReferenceSharedPtr torc::generic::VectorPortReference::Factory::newVectorPortReferencePtr ( const InstanceSharedPtr &  inInstancePtr, const PortSharedPtr &  inPortPtr, const std::vector< size_t > &  inLimits, const PortBundleReferenceSharedPtr &  inParentCollection = PortBundleReferenceSharedPtr(), const ChildFactorySharedPtr &  inFactory = BaseType::ChildFactorySharedPtr(new BaseType::ChildFactory())  ) throw ( Error )

virtual

Create a vector port ref.

Parameters

[in]	inInstancePtr	Pointer to parented(Instance) object.
[in]	inPortPtr	Pointer to master(Port) object.
[in]	inLimits	Dimensions of the vector.
[in]	inParentCollection	Pointer to parent bundle.
[in]	inFactory	Factory for the child.

Returns

Pointer to created scalar port ref.

Create a vector port ref.

Parameters

[in]	inInstancePtr	Pointer to parented(Instance) object.
[in]	inPortPtr	Pointer to master(Port) object.
[in]	inLimits	Dimensions of the vector.
[in]	inFactory	Factory for the child.

Returns

Pointer to created scalar port ref.

Definition at line 103 of file VectorPortReference.cpp.

                                                          {
    try {
        VectorPortReferenceSharedPtr newVectorPortReference;
        create(newVectorPortReference);
        newVectorPortReference->constructChildren(inFactory, inLimits);
        newVectorPortReference->bindToMasterPort(inPortPtr);
        if(inParentCollection) {
            inParentCollection->addChild(newVectorPortReference);
        } else {
            inInstancePtr->addPortReference(newVectorPortReference);
        }
        return newVectorPortReference;
    } catch(Error& e) {
        e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
        throw;
    }
}

Here is the call graph for this function:

---

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

• VectorPortReference.hpp
• VectorPortReference.cpp