#include <PortListAlias.hpp>

Inheritance diagram for torc::generic::PortListAlias::Factory:

Collaboration diagram for torc::generic::PortListAlias::Factory:

Public Types
typedef PortListAlias	Type

typedef SelfReferencing< Type > ::Pointer	Pointer

typedef SelfReferencing< Type > ::WeakPointer	WeakPointer

Public Member Functions
virtual PortListAliasSharedPtr	newPortListAliasPtr (const std::string &inName, const PortListSharedPtr &inPortList, const SimulateSharedPtr &inSimulate=SimulateSharedPtr()) throw (Error)

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

Detailed Description

Convenience class to create a port list alias.

Definition at line 53 of file PortListAlias.hpp.

Member Typedef Documentation

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

inherited

A pointer to an object of type Type

Definition at line 45 of file FactoryType.hpp.

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

inherited

A rename of the parameter type

Definition at line 40 of file FactoryType.hpp.

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

PortListAliasSharedPtr torc::generic::PortListAlias::Factory::newPortListAliasPtr	(	const std::string &	inName,
		const PortListSharedPtr &	inPortList,
		const SimulateSharedPtr &	inSimulate = `SimulateSharedPtr()`
	)
throw	(	Error
	)

virtual

Create a port list alias

Parameters

[in]	inName	Name of the port list alias to be created.
[in]	inPortList	Pointer to port list object.
[in]	inSimulate	Pointer to parented (Simulate) object [optional]. If not mentioned PortListAlias will not be added to simulate.

Returns: Pointer to created port list alias.

Definition at line 32 of file PortListAlias.cpp.

                                                                                             {
     try {
         PortListAliasSharedPtr newPortListAlias;
         create(newPortListAlias);
         newPortListAlias->setName(inName);
         newPortListAlias->setPortList(inPortList);
         if(inSimulate) {
             inSimulate->addPortListAlias(newPortListAlias);
         }
         return newPortListAlias;
     } 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