torc::generic::ForbiddenEvent::Factory Class Reference

#include <ForbiddenEvent.hpp>

Inheritance diagram for torc::generic::ForbiddenEvent::Factory:

Collaboration diagram for torc::generic::ForbiddenEvent::Factory:

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

Public Member Functions
virtual ForbiddenEventSharedPtr	newForbiddenEventPtr (const EventSharedPtr &inStartTimeInterval, const EventSharedPtr &inEndTimeInterval, const std::list< EventSharedPtr > &inEvents, const TimingSharedPtr &inTiming=TimingSharedPtr(), const Value &inDuration=Value()) throw (Error)
virtual void	create (Pointer &outPointer) throw (Error)

Detailed Description

Convenience class to create an ForbiddenEvent.

Definition at line 54 of file ForbiddenEvent.hpp.

Member Typedef Documentation

template<typename _Tp>

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

inherited

A pointer to an object of type Type

Definition at line 45 of file FactoryType.hpp.

template<typename _Tp>

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

inherited

A rename of the parameter type

Definition at line 40 of file FactoryType.hpp.

template<typename _Tp>

typedef SelfReferencing<Type>::WeakPointer torc::generic::FactoryType< _Tp >::WeakPointer

inherited

A weak pointer to an object of type Type

Definition at line 50 of file FactoryType.hpp.

Member Function Documentation

template<typename _Tp>

virtual void torc::generic::FactoryType< _Tp >::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
        }
    }

ForbiddenEventSharedPtr torc::generic::ForbiddenEvent::Factory::newForbiddenEventPtr ( const EventSharedPtr &  inStartTimeInterval, const EventSharedPtr &  inEndTimeInterval, const std::list< EventSharedPtr > &  inEvents, const TimingSharedPtr &  inTiming = TimingSharedPtr(), const Value &  inDuration = Value()  ) throw ( Error )

virtual

Create a ForbiddenEvent.

Parameters

[in]	inStartTimeInterval	Pointer to start event/offsetEvent of timeInterval.
[in]	inEndTimeInterval	Pointer to end event/offsetEvent of timeInterval.
[in]	inEvents	List of events which are forbidden during a period of time specified by TimeInterval(StartTimeInterval and EndTimeInterval).
[in]	inTiming	Pointer to parented object (Timing) [optional]. If not mentioned PathDelay will not be added to timing.
[in]	inDuration	Duration of timeInterval, if end event is absent [optional].

Returns

Pointer to created ForbiddenEvent.

Definition at line 36 of file ForbiddenEvent.cpp.

                                           {
    try {
        ForbiddenEventSharedPtr newForbiddenEvent;
        create(newForbiddenEvent);
        newForbiddenEvent->setStartTimeInterval(inStartTimeInterval);
        newForbiddenEvent->setEndTimeInterval(inEndTimeInterval);
        newForbiddenEvent->setEvents(inEvents);
        if(inDuration.getIsSet()) {
            newForbiddenEvent->setDuration(inDuration);
        }
        if(inTiming) {
            inTiming->addForbiddenEvent(newForbiddenEvent);
        }
        return newForbiddenEvent;
    } 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:

• ForbiddenEvent.hpp
• ForbiddenEvent.cpp