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>
Public Types | |
| typedef VisitorType < ForbiddenEvent > | Visitor |
Public Member Functions | |
| virtual void | accept (BaseVisitor &inoutVisitor) throw (Error) |
| const EventSharedPtr | getStartTimeInterval () const throw () |
| void | setStartTimeInterval (const EventSharedPtr &inSource) throw () |
| const EventSharedPtr | getEndTimeInterval () const throw () |
| void | setEndTimeInterval (const EventSharedPtr &inSource) throw () |
| const Value | getDuration () const throw () |
| void | setDuration (const Value &inValue) throw () |
| void | getEvents (std::list< EventSharedPtr > &outEvents) const throw () |
| void | setEvents (const std::list< EventSharedPtr > &inEvents) throw () |
| void | addEvent (const EventSharedPtr &inSource) throw () |
Private Member Functions | |
| ForbiddenEvent (const ForbiddenEvent &source) throw () | |
| ForbiddenEvent & | operator= (const ForbiddenEvent &source) throw () |
Private Attributes | |
| EventSharedPtr | mStartTimeInterval |
| EventSharedPtr | mEndTimeInterval |
| Value | mDuration |
| std::list< EventSharedPtr > | mEvents |
Friends | |
| class | FactoryType< ForbiddenEvent > |
Classes | |
| class | Factory |
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 41 of file ForbiddenEvent.hpp.
Member Typedef Documentation
Convenience class to visit an ForbiddenEvent.
Definition at line 51 of file ForbiddenEvent.hpp.
Member Function Documentation
| void torc::generic::ForbiddenEvent::accept | ( | BaseVisitor & | inoutVisitor | ) | throw (Error) [virtual] |
Recive a inoutVisitor to this class. The visit method of the inoutVisitor is called and a reference to this object is passed as a parameter. It has to be noted however, that a dynamic_cast is performed inside this method. If the cast fails, an appropriate exception is thrown by this method. This sitation can arise when the passed Visitor object does not inherit from the appropriate inoutVisitor specialization. See Visitor documentation for more details.
- Parameters:
-
[in,out] inoutVisitor A reference to the inoutVisitor object
- Exceptions:
-
Error Visitor type inappropriate for visiting this object or any other error thrown by the Visitor::throw() method.
Implements torc::generic::Visitable.
Definition at line 70 of file ForbiddenEvent.cpp.
| const EventSharedPtr torc::generic::ForbiddenEvent::getStartTimeInterval | ( | ) | const throw () [inline] |
Get the pointer to start event/offsetEvent of timeInterval
- Returns:
- Pointer to start event/offsetEvent of timeInterval
Definition at line 175 of file ForbiddenEvent.hpp.
| void torc::generic::ForbiddenEvent::setStartTimeInterval | ( | const EventSharedPtr & | inSource | ) | throw () |
Set the pointer to start event/offsetEvent of timeInterval
- Parameters:
-
[in] inSource Pointer to start event/offsetEvent of timeInterval
Definition at line 88 of file ForbiddenEvent.cpp.
| const EventSharedPtr torc::generic::ForbiddenEvent::getEndTimeInterval | ( | ) | const throw () [inline] |
Get the pointer to end event/offsetEvent of timeInterval
- Returns:
- Pointer to end event/offsetEvent of timeInterval
Definition at line 184 of file ForbiddenEvent.hpp.
| void torc::generic::ForbiddenEvent::setEndTimeInterval | ( | const EventSharedPtr & | inSource | ) | throw () |
Set the pointer to end event/offsetEvent of timeInterval
- Parameters:
-
[in] inSource Pointer to end event/offsetEvent of timeInterval
Definition at line 97 of file ForbiddenEvent.cpp.
| const Value torc::generic::ForbiddenEvent::getDuration | ( | ) | const throw () [inline] |
Get the duration of timeInterval, if end event is absent.
- Returns:
- Value duration of timeInterval, if end event is absent.
Definition at line 193 of file ForbiddenEvent.hpp.
| void torc::generic::ForbiddenEvent::setDuration | ( | const Value & | inValue | ) | throw () |
Set the duration of timeInterval, if end event is absent.
- Parameters:
-
[in] inValue Duration of timeInterval, if end event is absent.
Definition at line 106 of file ForbiddenEvent.cpp.
| void torc::generic::ForbiddenEvent::getEvents | ( | std::list< EventSharedPtr > & | outEvents | ) | const throw () [inline] |
Get all the events of this forbiddenEvent.
- Parameters:
-
[out] outEvents List of events to be appended to
Definition at line 203 of file ForbiddenEvent.hpp.
| void torc::generic::ForbiddenEvent::setEvents | ( | const std::list< EventSharedPtr > & | inEvents | ) | throw () |
Set all the events of this forbiddenEvent.
- Parameters:
-
[in] inEvents List of events to be appended to
- Parameters:
-
[out] inEvents List of events to be appended to
Definition at line 116 of file ForbiddenEvent.cpp.
| void torc::generic::ForbiddenEvent::addEvent | ( | const EventSharedPtr & | inSource | ) | throw () |
Add an event to the list of events
- Parameters:
-
[in] inSource Pointer to event to be appended to
Definition at line 138 of file ForbiddenEvent.cpp.
The documentation for this class was generated from the following files:
- torc/generic/om/ForbiddenEvent.hpp
- torc/generic/om/ForbiddenEvent.cpp
