torc::generic::VectorPort::Factory Class Reference

#include <VectorPort.hpp>

Inheritance diagram for torc::generic::VectorPort::Factory:

Collaboration diagram for torc::generic::VectorPort::Factory:

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

Public Member Functions
virtual VectorPortSharedPtr	newVectorPortPtr (const std::string &inName, const EPortDirection &inDirection, const ViewSharedPtr &inViewPtr, const size_t &inSize, const PortBundleSharedPtr &inParentCollection=PortBundleSharedPtr(), const ChildFactorySharedPtr &inFactory=BaseVectorType::ChildFactorySharedPtr(new BaseVectorType::ChildFactory()), const std::string &inOriginalName=std::string()) throw (Error)
virtual VectorPortSharedPtr	newVectorPortPtr (const std::string &inName, const EPortDirection &inDirection, const ViewSharedPtr &inViewPtr, const std::vector< size_t > &inLimits, const PortBundleSharedPtr &inParentCollection=PortBundleSharedPtr(), const ChildFactorySharedPtr &inFactory=BaseVectorType::ChildFactorySharedPtr(new BaseVectorType::ChildFactory()), const std::string &inOriginalName=std::string()) throw (Error)
virtual void	create (Pointer &outPointer) throw (Error)

Detailed Description

Convenience class to create a vector port.

Definition at line 59 of file VectorPort.hpp.

Member Typedef Documentation

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

inherited

A pointer to an object of type Type

Definition at line 45 of file FactoryType.hpp.

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

inherited

A rename of the parameter type

Definition at line 40 of file FactoryType.hpp.

typedef SelfReferencing<Type>::WeakPointer torc::generic::FactoryType< VectorPort >::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< VectorPort >::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
        }
    }

VectorPortSharedPtr torc::generic::VectorPort::Factory::newVectorPortPtr ( const std::string &  inName, const EPortDirection &  inDirection, const ViewSharedPtr &  inViewPtr, const size_t &  inSize, const PortBundleSharedPtr &  inParentCollection = PortBundleSharedPtr(), const ChildFactorySharedPtr &  inFactory = BaseVectorType::ChildFactorySharedPtr( new BaseVectorType::ChildFactory()), const std::string &  inOriginalName = std::string()  ) throw ( Error )

virtual

Create a vector port.

Parameters

[in]	inName	Name of the vector port to be created.
[in]	inDirection	Direction of port.
[in]	inViewPtr	Pointer to parented(View) object.
[in]	inSize	Size of the port array.
[in]	inParentCollection	Pointer to parent bundle.
[in]	inFactory	Factory for the child.
[in]	inOriginalName	Original name of the vector port [optional].

Returns

Pointer to created vector port.

Create a vector port.

Parameters

[in]	inName	Name of the vector port to be created.
[in]	inDirection	Direction of port.
[in]	inViewPtr	Pointer to parented(View) object.
[in]	inSize	Size of the port array.
[in]	inFactory	Factory for the child.
[in]	inOriginalName	Original name of the vector port [optional].

Returns

Pointer to created vector port.

Definition at line 54 of file VectorPort.cpp.

                                                   {
    try {
        std::vector < size_t > limits;
        limits.push_back(inSize);
        return newVectorPortPtr(inName, inDirection, inViewPtr, limits, inParentCollection,
            inFactory, inOriginalName);
    } catch(Error& e) {
        e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
        throw;
    }
}

Here is the call graph for this function:

VectorPortSharedPtr torc::generic::VectorPort::Factory::newVectorPortPtr ( const std::string &  inName, const EPortDirection &  inDirection, const ViewSharedPtr &  inViewPtr, const std::vector< size_t > &  inLimits, const PortBundleSharedPtr &  inParentCollection = PortBundleSharedPtr(), const ChildFactorySharedPtr &  inFactory = BaseVectorType::ChildFactorySharedPtr(new BaseVectorType::ChildFactory()), const std::string &  inOriginalName = std::string()  ) throw ( Error )

virtual

Create a vector port.

Parameters

[in]	inName	Name of the vector port to be created.
[in]	inDirection	Direction of port.
[in]	inViewPtr	Pointer to parented(View) object.
[in]	inLimits	Dimensions of the vector.
[in]	inParentCollection	Pointer to parent bundle.
[in]	inFactory	Factory for the child.
[in]	inOriginalName	Original name of the vector port [optional].

Returns

Pointer to created vector port.

Create a vector port.

Parameters

[in]	inName	Name of the vector port to be created.
[in]	inDirection	Direction of port.
[in]	inViewPtr	Pointer to parented(View) object.
[in]	inLimits	Dimensions of the vector.
[in]	inFactory	Factory for the child.
[in]	inOriginalName	Original name of the vector port [optional].

Returns

Pointer to created vector port.

Definition at line 81 of file VectorPort.cpp.

                                                                                           {
    try {
        VectorPortSharedPtr newVectorPort;
        create(newVectorPort);
        newVectorPort->setName(inName);
        newVectorPort->setDirection(inDirection);
        newVectorPort->constructChildren(inFactory,
            inLimits);
        newVectorPort->setOriginalName(inOriginalName);
        if(inParentCollection) {
            inParentCollection->addChild(newVectorPort);
        } else {
            inViewPtr->addPort(newVectorPort);
        }
        return newVectorPort;
    } 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:

• VectorPort.hpp
• VectorPort.cpp