torc::generic::ForbiddenEvent Class Reference

ForbiddenEvent class lists events which are forbidden during a period of times which is specified by time interval. Time interval is used to describe an interval between two times. Times can be described by events or offset events. More...

#include <ForbiddenEvent.hpp>

Inheritance diagram for torc::generic::ForbiddenEvent:

Collaboration diagram for torc::generic::ForbiddenEvent:

Data Structures
class	Factory

Public Types
typedef VisitorType < ForbiddenEvent >	Visitor
typedef ForbiddenEvent	Type
typedef boost::shared_ptr< Type >	Pointer
typedef boost::weak_ptr< Type >	WeakPointer

Public Member Functions
virtual void	accept (BaseVisitor &inoutVisitor) throw (Error)
const EventSharedPtr	getStartTimeInterval () const
void	setStartTimeInterval (const EventSharedPtr &inSource)
const EventSharedPtr	getEndTimeInterval () const
void	setEndTimeInterval (const EventSharedPtr &inSource)
const Value	getDuration () const
void	setDuration (const Value &inValue)
void	getEvents (std::list< EventSharedPtr > &outEvents) const
void	setEvents (const std::list< EventSharedPtr > &inEvents)
void	addEvent (const EventSharedPtr &inSource)
virtual	~ForbiddenEvent () throw ()
void	setWeakThis (const WeakPointer &inWeakThis)
Pointer	getSharedThis () const

Protected Member Functions
	ForbiddenEvent ()

Private Member Functions
	ForbiddenEvent (const ForbiddenEvent &source)
ForbiddenEvent &	operator= (const ForbiddenEvent &source)

Private Attributes
EventSharedPtr	mStartTimeInterval
EventSharedPtr	mEndTimeInterval
Value	mDuration
std::list< EventSharedPtr >	mEvents

Friends
class	FactoryType< ForbiddenEvent >

Detailed Description

ForbiddenEvent class lists events which are forbidden during a period of times which is specified by time interval. Time interval is used to describe an interval between two times. Times can be described by events or offset events.

Definition at line 40 of file ForbiddenEvent.hpp.

Member Typedef Documentation

typedef boost::shared_ptr<Type> torc::generic::SelfReferencing< ForbiddenEvent >::Pointer

inherited

Definition at line 36 of file SelfReferencing.hpp.

typedef ForbiddenEvent torc::generic::SelfReferencing< ForbiddenEvent >::Type

inherited

Definition at line 35 of file SelfReferencing.hpp.

typedef VisitorType<ForbiddenEvent> torc::generic::ForbiddenEvent::Visitor

Convenience class to visit an ForbiddenEvent.

Definition at line 47 of file ForbiddenEvent.hpp.

typedef boost::weak_ptr<Type> torc::generic::SelfReferencing< ForbiddenEvent >::WeakPointer

inherited

Definition at line 37 of file SelfReferencing.hpp.

Constructor & Destructor Documentation

torc::generic::ForbiddenEvent::~ForbiddenEvent ( ) throw ( )

virtual

Definition at line 125 of file ForbiddenEvent.cpp.

{}

torc::generic::ForbiddenEvent::ForbiddenEvent ( )

protected

Definition at line 122 of file ForbiddenEvent.cpp.

                               : Visitable(), SelfReferencing<ForbiddenEvent>(),
    mStartTimeInterval(), mEndTimeInterval(), mDuration(), mEvents() {}

torc::generic::ForbiddenEvent::ForbiddenEvent ( const ForbiddenEvent &  source )

private

Member Function Documentation

void torc::generic::ForbiddenEvent::accept ( BaseVisitor &  inoutVisitor ) throw ( Error )

virtual

Implements torc::generic::Visitable.

Definition at line 59 of file ForbiddenEvent.cpp.

                                                                   {
    try {
        runVisitor(*this, inoutVisitor);
    } catch(Error& e) {
        e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
        throw;
    }
}

Here is the call graph for this function:

void torc::generic::ForbiddenEvent::addEvent

(

const EventSharedPtr &

inSource

)

Add an event to the list of events

Parameters

[in]

inSource

Pointer to event to be appended to

Definition at line 113 of file ForbiddenEvent.cpp.

                                                            {
    try {
        mEvents.push_back(inSource);
    } catch(Error& e) {
        e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
        throw;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

const Value torc::generic::ForbiddenEvent::getDuration ( ) const

inline

Get the duration of timeInterval, if end event is absent.

Returns

Value duration of timeInterval, if end event is absent.

Definition at line 170 of file ForbiddenEvent.hpp.

                                                     {
    return mDuration;
}

const EventSharedPtr torc::generic::ForbiddenEvent::getEndTimeInterval ( ) const

inline

Get the pointer to end event/offsetEvent of timeInterval

Returns

Pointer to end event/offsetEvent of timeInterval

Definition at line 162 of file ForbiddenEvent.hpp.

                                                                     {
    return mEndTimeInterval;
}

void torc::generic::ForbiddenEvent::getEvents ( std::list< EventSharedPtr > &  outEvents ) const

inline

Get all the events of this forbiddenEvent.

Parameters

[out]

outEvents

List of events to be appended to

Definition at line 179 of file ForbiddenEvent.hpp.

                                                                              {
    outEvents.insert(outEvents.end(), mEvents.begin(), mEvents.end());
}

Pointer torc::generic::SelfReferencing< ForbiddenEvent >::getSharedThis ( ) const

inlineinherited

Get a shared pointer to this object. A valid pointer is returned if weakThis was set. Otherwise this returns a NULL pointer. For Vector types, the second scenario is an exception condition and should be treated as such.

Returns

A shared pointer to this object

Get a shared pointer to this object. A valid pointer is returned if weakThis was set. Otherwise this returns a NULL pointer. For Vector types, the second scenario is an exception condition and should be treated as such.

Parameters

[out]

ptr

Set to a shared pointer to this object

const EventSharedPtr torc::generic::ForbiddenEvent::getStartTimeInterval ( ) const

inline

Get the pointer to start event/offsetEvent of timeInterval

Returns

Pointer to start event/offsetEvent of timeInterval

Definition at line 154 of file ForbiddenEvent.hpp.

                                                                       {
    return mStartTimeInterval;
}

ForbiddenEvent& torc::generic::ForbiddenEvent::operator= ( const ForbiddenEvent &  source )

private

void torc::generic::ForbiddenEvent::setDuration

(

const Value &

inValue

)

Set the duration of timeInterval, if end event is absent.

Parameters

[in]

inValue

Duration of timeInterval, if end event is absent.

Definition at line 88 of file ForbiddenEvent.cpp.

                                                     {
    mDuration = inValue;
}

void torc::generic::ForbiddenEvent::setEndTimeInterval

(

const EventSharedPtr &

inSource

)

Set the pointer to end event/offsetEvent of timeInterval

Parameters

[in]

inSource

Pointer to end event/offsetEvent of timeInterval

Definition at line 80 of file ForbiddenEvent.cpp.

                                                                      {
    mEndTimeInterval = inSource;
}

void torc::generic::ForbiddenEvent::setEvents

(

const std::list< EventSharedPtr > &

inEvents

)

Set all the events of this forbiddenEvent.

Parameters

[in]

inEvents

List of events to be appended to

Set all the events of this forbiddenEvent.

Parameters

[out]

inEvents

List of events to be appended to

Definition at line 97 of file ForbiddenEvent.cpp.

                                                                      {
    std::list<EventSharedPtr>::const_iterator it = inEvents.begin();
    for(; it != inEvents.end(); it++) {
        try {
            addEvent(*it);
        } catch(Error& e) {
            e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
        }
    }
}

Here is the call graph for this function:

void torc::generic::ForbiddenEvent::setStartTimeInterval

(

const EventSharedPtr &

inSource

)

Set the pointer to start event/offsetEvent of timeInterval

Parameters

[in]

inSource

Pointer to start event/offsetEvent of timeInterval

Definition at line 72 of file ForbiddenEvent.cpp.

                                                                        {
    mStartTimeInterval = inSource;
}

void torc::generic::SelfReferencing< ForbiddenEvent >::setWeakThis ( const WeakPointer &  inWeakThis )

inlineinherited

Set a weak pointer to this object. This will be used later to get a shared pointer to this object from within other member methods if required. This should be called by the Factory creating the object.

Parameters

[in]

weakThis

A weak pointer to this object

Friends And Related Function Documentation

friend class FactoryType< ForbiddenEvent >

friend

Definition at line 41 of file ForbiddenEvent.hpp.

Field Documentation

Value torc::generic::ForbiddenEvent::mDuration

private

Definition at line 145 of file ForbiddenEvent.hpp.

EventSharedPtr torc::generic::ForbiddenEvent::mEndTimeInterval

private

Definition at line 144 of file ForbiddenEvent.hpp.

std::list<EventSharedPtr> torc::generic::ForbiddenEvent::mEvents

private

Definition at line 146 of file ForbiddenEvent.hpp.

EventSharedPtr torc::generic::ForbiddenEvent::mStartTimeInterval

private

Definition at line 143 of file ForbiddenEvent.hpp.

---

The documentation for this class was generated from the following files:

• ForbiddenEvent.hpp
• ForbiddenEvent.cpp