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

#include <time_pseudocode.h>

Inheritance diagram for TemporaryEvent:
Inheritance graph
Collaboration diagram for TemporaryEvent:
Collaboration graph

Public Member Functions

 TemporaryEvent (ReferenceNode *ref_node, bool is_top)
 
const std::wstring to_string ()
 
ReferenceNodeget_ref_node ()
 
bool is_top ()
 
- Public Member Functions inherited from Event
 Event ()
 
virtual ~Event ()
 
virtual Eventclone ()
 
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
 

Private Attributes

ReferenceNodem_ref_node
 
bool m_is_top
 

Additional Inherited Members

- 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 ()
 
- 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

Definition at line 1401 of file time_pseudocode.h.

Constructor & Destructor Documentation

TemporaryEvent::TemporaryEvent ( ReferenceNode ref_node,
bool  is_top 
)
inline

Definition at line 1407 of file time_pseudocode.h.

References is_top(), m_is_top, and m_ref_node.

Member Function Documentation

ReferenceNode* TemporaryEvent::get_ref_node ( )
inline

Definition at line 1418 of file time_pseudocode.h.

References m_ref_node.

Referenced by HMscConsistencyChecker::make_counter_example().

bool TemporaryEvent::is_top ( )
inline

Definition at line 1423 of file time_pseudocode.h.

References m_is_top.

Referenced by HMscConsistencyChecker::make_counter_example(), and TemporaryEvent().

const std::wstring TemporaryEvent::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 1413 of file time_pseudocode.h.

Member Data Documentation

bool TemporaryEvent::m_is_top
private

Definition at line 1404 of file time_pseudocode.h.

Referenced by is_top(), and TemporaryEvent().

ReferenceNode* TemporaryEvent::m_ref_node
private

Definition at line 1403 of file time_pseudocode.h.

Referenced by get_ref_node(), and TemporaryEvent().


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

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