torc::generic::ScalarPort::Factory Class Reference

#include <ScalarPort.hpp>

Inheritance diagram for torc::generic::ScalarPort::Factory:

Collaboration diagram for torc::generic::ScalarPort::Factory:

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

Public Member Functions
virtual ScalarPortSharedPtr	newScalarPortPtr (const std::string &inName, const EPortDirection &inDirection, const ViewSharedPtr &inViewPtr, const PortBundleSharedPtr &inParentCollection=PortBundleSharedPtr(), const std::string &inOriginalName=std::string()) throw (Error)
virtual void	create (Pointer &outPointer) throw (Error)

Detailed Description

Convenience class to create a scalar port.

Definition at line 54 of file ScalarPort.hpp.

Member Typedef Documentation

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

inherited

A pointer to an object of type Type

Definition at line 45 of file FactoryType.hpp.

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

inherited

A rename of the parameter type

Definition at line 40 of file FactoryType.hpp.

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

ScalarPortSharedPtr torc::generic::ScalarPort::Factory::newScalarPortPtr ( const std::string &  inName, const EPortDirection &  inDirection, const ViewSharedPtr &  inViewPtr, const PortBundleSharedPtr &  inParentCollection = PortBundleSharedPtr(), const std::string &  inOriginalName = std::string()  ) throw ( Error )

virtual

Create a scalar port.

Parameters

[in]	inName	Name of the scalar port to be created.
[in]	inDirection	Direction of port.
[in]	inViewPtr	Pointer to parented(View) object.
[in]	inParentCollection	Pointer to parent bundle.
[in]	inOriginalName	Original name of the scalar port [optional].

Returns

Pointer to created scalar port.

Create a scalar port.

Parameters

[in]	inName	Name of the scalar port to be created.
[in]	inDirection	Direction of port.
[in]	inViewPtr	Pointer to parented(View) object.
[in]	inOriginalName	Original name of the scalar port [optional].

Returns

Pointer to created scalar port.

Definition at line 50 of file ScalarPort.cpp.

                  {
    try {
        ScalarPortSharedPtr newScalarPort;
        create(newScalarPort);
        newScalarPort->setName(inName);
        newScalarPort->setDirection(inDirection);
        newScalarPort->setOriginalName(inOriginalName);
        if(inParentCollection) {
            inParentCollection->addChild(newScalarPort);
        } else {
            inViewPtr->addPort(newScalarPort);
        }
        return newScalarPort;
    } 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:

• ScalarPort.hpp
• ScalarPort.cpp