#include <ScalarPortReference.hpp>

Inheritance diagram for torc::generic::ScalarPortReference::Factory:

Collaboration diagram for torc::generic::ScalarPortReference::Factory:

Public Types
typedef ScalarPortReference	Type

typedef SelfReferencing< Type > ::Pointer	Pointer

typedef SelfReferencing< Type > ::WeakPointer	WeakPointer

Public Member Functions
virtual ScalarPortReferenceSharedPtr	newScalarPortReferencePtr (const InstanceSharedPtr &inInstancePtr, const PortSharedPtr &inPortPtr, const PortBundleReferenceSharedPtr &inParentCollection=PortBundleReferenceSharedPtr()) throw (Error)

virtual void	create (Pointer &outPointer) throw (Error)

Detailed Description

Convenience class to create a scalar port ref.

Definition at line 53 of file ScalarPortReference.hpp.

Member Typedef Documentation

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

inherited

A pointer to an object of type Type

Definition at line 45 of file FactoryType.hpp.

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

inherited

A rename of the parameter type

Definition at line 40 of file FactoryType.hpp.

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

ScalarPortReferenceSharedPtr torc::generic::ScalarPortReference::Factory::newScalarPortReferencePtr	(	const InstanceSharedPtr &	inInstancePtr,
		const PortSharedPtr &	inPortPtr,
		const PortBundleReferenceSharedPtr &	inParentCollection = `PortBundleReferenceSharedPtr()`
	)
throw	(	Error
	)

virtual

Create a scalar port ref.

Parameters

[in]	inInstancePtr	Pointer to parented(Instance) object.
[in]	inPortPtr	Pointer to master(Port) object.
[in]	inParentCollection	Pointer to parent bundle.

Returns: Pointer to created scalar port ref.

Create a scalar port ref.

Parameters

[in]	inInstancePtr	Pointer to parented(Instance) object.
[in]	inPortPtr	Pointer to master(Port) object.

Returns: Pointer to created scalar port ref.

Definition at line 46 of file ScalarPortReference.cpp.

                                                                           {
     try {
         ScalarPortReferenceSharedPtr newScalarPortReference;
         create(newScalarPortReference);
         newScalarPortReference->bindToMasterPort(inPortPtr);
         if(inParentCollection) {
             inParentCollection->addChild(newScalarPortReference);
         } else {
             inInstancePtr->addPortReference(newScalarPortReference);
         }
         return newScalarPortReference;
     } 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:

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Member Function Documentation