Sequence Chart Studio  svn HEAD revision
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Protected Member Functions | List of all members
LocalActionEvent Class Reference

An event caused by a local action. More...

#include <LocalActionEvent.h>

Inheritance diagram for LocalActionEvent:
Inheritance graph
Collaboration diagram for LocalActionEvent:
Collaboration graph

Public Member Functions

 LocalActionEvent ()
 
Eventclone ()
 
const std::wstring to_string ()
 
void set_local_action (const LocalActionPtr &local_action)
 
const LocalActionPtrget_local_action () const
 
- Public Member Functions inherited from EventTmpl< LocalAction >
 EventTmpl ()
 
const boost::intrusive_ptr
< LocalAction > & 
get_element () const
 
void set_element (const boost::intrusive_ptr< LocalAction > &element)
 
- Public Member Functions inherited from Event
 Event ()
 
virtual ~Event ()
 
Instanceget_instance () const
 
EventAreaget_area () const
 
EventAreaPtrList::const_iterator get_area_iterator () const
 
void set_area (EventArea *area)
 
const MscPointget_position () const
 
void set_position (const MscPoint &position)
 
bool is_minimal () const
 Finds out whether this event is minimal within its area. This is just a convenience method. The call is delegated to the area. More...
 
bool is_maximal () const
 Finds out whether this event is maximal within its area. This is just a convenience method. The call is delegated to the area. More...
 
EventPSet get_predecessor_events () const
 Returns the set of predecessors of this event within the same area. This is just a convenience method. The call is delegated to the area. More...
 
EventPSet get_successor_events () const
 Returns the set of successors of this event within the same area. This is just a convenience method. The call is delegated to the area. More...
 
EventP get_predecessor_event () const
 Returns any single predecessor of this event within the same area, or NULL if there isn't any. Suitable for situations where it is irrelevant which predecessor is to be taken, or if there may be just one. This is just a convenience method. The call is delegated to the area. More...
 
EventP get_successor_event () const
 Returns any single successor of this event within the same area, or NULL if there isn't any. Suitable for situations where it is irrelevant which successor is to be taken, or if there may be just one. This is just a convenience method. The call is delegated to the area. More...
 
bool has_predecessor_events () const
 Finds out whether this event has any predecessors within the same area. This is just a convenience method. The call is delegated to the area. More...
 
bool has_successor_events () const
 Finds out whether this event has any successors within the same area. This is just a convenience method. The call is delegated to the area. More...
 
bool in_coregion_area () const
 Finds out whether the event is in a coregion area. NOTE: Should only be used where it is not obvious in what type of area this event is, and only for printing/formatting purposes. More...
 
bool in_strict_order_area () const
 Finds out whether the event is in a strict-order area. NOTE: Should only be used where it is not obvious in what type of area this event is, and only for printing/formatting purposes. More...
 
void add_time_relation (const TimeRelationEventPtr &relation)
 
void remove_time_relation (const TimeRelationEventPtr &relation)
 
void set_time_relations (const TimeRelationEventPtrList &list)
 
const TimeRelationEventPtrListget_time_relations () const
 
void clear_time_relations ()
 
void add_absolut_time (MscTimeIntervalSetD absolut_time)
 
void remove_absolut_time (const MscTimeIntervalSetD &absolute_time)
 
void set_absolut_time (const std::list< AbsoluteTimePtr > &list)
 
const AbsoluteTimePtrListget_absolut_times () const
 
void clear_absolut_times ()
 
- Public Member Functions inherited from MscElementTmpl< Event >
int get_visual_style () const
 
void set_visual_style (int visual_style)
 
MscElementget_general_original () const
 See MscElementTmpl for details about attribute original. More...
 
void set_general_original (MscElement *original)
 See MscElementTmpl for details about attribute original. More...
 
Eventget_original () const
 
void set_original (Event *e)
 
void set_original (boost::intrusive_ptr< Event > &e)
 
virtual ~MscElementTmpl ()
 
- Public Member Functions inherited from MscElement
bool is_attribute_set (const std::string &name) const
 Finds out whether attribute with specified name is set or not. More...
 
template<class T >
T & get_attribute (const std::string &name, const T &def)
 Returns dynamic attribute of MscElement. More...
 
template<class T >
T & get_attribute (const std::string &name, const T &def, bool &status)
 Returns dynamic attribute of MscElement. More...
 
template<class T >
void set_attribute (const std::string &name, const T &val)
 Sets dynamic attribute of MscElement. More...
 
template<class T >
void remove_attribute (const std::string &name)
 Removes attribute of MscElement. More...
 
std::set< std::stringget_attribute_names () const
 List all attributes of MscElement. More...
 
enum MarkType get_marked () const
 
void set_marked (enum MarkType marked=MARKED)
 
MscColor get_color () const
 
void set_color (MscColor color)
 
void clear_color ()
 
virtual ~MscElement ()
 
- Public Member Functions inherited from Commentable
virtual ~Commentable ()
 
void add_comment (CommentPtr comment)
 
const CommentPtrSetget_comments () const
 

Protected Member Functions

 LocalActionEvent (LocalActionEvent *original)
 
- Protected Member Functions inherited from EventTmpl< LocalAction >
 EventTmpl (EventTmpl< LocalAction > *original)
 
- Protected Member Functions inherited from Event
 Event (Event *original)
 
- Protected Member Functions inherited from MscElementTmpl< Event >
 MscElementTmpl ()
 
 MscElementTmpl (Event *original)
 Creates MscElement referencing the original one. More...
 
- Protected Member Functions inherited from MscElement
 MscElement ()
 

Additional Inherited Members

- Protected Attributes inherited from MscElementTmpl< Event >
int m_visual_style
 Visual style of the shape. More...
 
boost::intrusive_ptr< Eventm_original
 Pointer to original version of MscElement. More...
 
- Protected Attributes inherited from Commentable
CommentPtrSet m_comments
 

Detailed Description

An event caused by a local action.

Definition at line 30 of file LocalActionEvent.h.

Constructor & Destructor Documentation

LocalActionEvent::LocalActionEvent ( LocalActionEvent original)
inlineprotected

Definition at line 33 of file LocalActionEvent.h.

LocalActionEvent::LocalActionEvent ( )
inline

Definition at line 39 of file LocalActionEvent.h.

Member Function Documentation

Event* LocalActionEvent::clone ( )
inlinevirtual

Duplicates the event. Returns a new, dynamically allocated object. NOTE: Especially useful for creating dynamic clones. NOTE: override in a subclass which has some additional attributes to be cloned (as, e.g., EventTmpl does) NOTE: for why this is a good idea, see, e.g., http://www.agiledeveloper.com/articles/cloning072002.htm

Reimplemented from Event.

Definition at line 43 of file LocalActionEvent.h.

const LocalActionPtr& LocalActionEvent::get_local_action ( ) const
inline
void LocalActionEvent::set_local_action ( const LocalActionPtr local_action)
inline

Sets the local action this event is attached to. Just a convenience method - alias for set_element().

Definition at line 60 of file LocalActionEvent.h.

References EventTmpl< TMscElement >::set_element().

Referenced by LocalAction::glue_event().

const std::wstring LocalActionEvent::to_string ( )
inlinevirtual

Returns a textual identification of the event (label of the attached message, local action contents, etc.). No strict format is enforced, just a free-form text for the user to identify an event (e.g. in an error message).

Reimplemented from Event.

Definition at line 48 of file LocalActionEvent.h.


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

SourceForge.net Logo
Generated on Fri Jan 15 2016 16:26:58 for Sequence Chart Studio by  doxygen