torc::generic::Event::Factory Class Reference

#include <Event.hpp>

Inheritance diagram for torc::generic::Event::Factory:

Collaboration diagram for torc::generic::Event::Factory:

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

Public Member Functions
virtual EventSharedPtr	newEventPtr (const Event::Type &inEventType, const std::list< PortSharedPtr > &inPorts, const std::list< PortReferenceSharedPtr > &inPortReferences, const std::list< NetSharedPtr > &inNets, const LogicElementSharedPtr &inTransition=LogicElementSharedPtr(), const PortListSharedPtr &inPortList=PortListSharedPtr(), const Value &inOffsetTime=Value()) throw (Error)
virtual void	create (Pointer &outPointer) throw (Error)

Detailed Description

Convenience class to create an Event.

Definition at line 67 of file Event.hpp.

Member Typedef Documentation

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

inherited

A pointer to an object of type Type

Definition at line 45 of file FactoryType.hpp.

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

inherited

A rename of the parameter type

Definition at line 40 of file FactoryType.hpp.

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

EventSharedPtr torc::generic::Event::Factory::newEventPtr ( const Event::Type &  inEventType, const std::list< PortSharedPtr > &  inPorts, const std::list< PortReferenceSharedPtr > &  inPortReferences, const std::list< NetSharedPtr > &  inNets, const LogicElementSharedPtr &  inTransition = LogicElementSharedPtr(), const PortListSharedPtr &  inPortList = PortListSharedPtr(), const Value &  inOffsetTime = Value()  ) throw ( Error )

virtual

Create an event.

Parameters

[in]	inEventType	Event type.
[in]	inPorts	List of ports to this composition.
[in]	inPortReferences	List of port references to this composition.
[in]	inNets	List of nets to this composition.
[in]	inTransition	Pointer to logic state value(transition/becomes) [optional]. If no transition are specified, then the default meaning is any logic state change.
[in]	inPortList	Connected Port list to this event [optional].
[in]	inOffsetTime	Offset time retative to an event [optional]. This is must for OffsetEvent, but optional for normal Event.

Returns

Pointer to created event.

Definition at line 38 of file Event.cpp.

                                                                                  {
    try {
        EventSharedPtr newEvent;
        create(newEvent);
        newEvent->setType(inEventType);
        std::list<PortSharedPtr>::const_iterator portIt = inPorts.begin();
        for(; portIt != inPorts.end(); portIt++) {
            newEvent->addPort(*portIt);
        }

        std::list<PortReferenceSharedPtr>::const_iterator portRefIt = inPortReferences.begin();
        for(; portRefIt != inPortReferences.end(); portRefIt++) {
            newEvent->addPortReference(*portRefIt);
        }

        std::list<NetSharedPtr>::const_iterator netIt = inNets.begin();
        for(; netIt != inNets.end(); netIt++) {
            newEvent->addNet(*netIt);
        }
        if(inTransition) {
            newEvent->setTransition(inTransition);
        }
        if(inPortList) {
            newEvent->setPortList(inPortList);
        }
        if(Event::eTypeOffsetEvent == inEventType) {
            if(inOffsetTime.getIsSet()) {
                newEvent->setOffsetTime(inOffsetTime);
            }
        }
        return newEvent;
    } 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:

• Event.hpp
• Event.cpp