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
CompleteMessage Class Reference

#include <CompleteMessage.h>

Inheritance diagram for CompleteMessage:
Inheritance graph
Collaboration diagram for CompleteMessage:
Collaboration graph

Public Member Functions

 CompleteMessage (const std::wstring &label=L"")
 
 CompleteMessage (MessageEvent *sender, MessageEvent *receiver, MscMessage *original)
 
Instanceget_sender () const
 
MessageEventget_send_event () const
 
void glue_send_event (const MessageEventPtr &send_event)
 
Instanceget_receiver () const
 
MessageEventget_receive_event () const
 
void glue_receive_event (const MessageEventPtr &receive_event)
 
void glue_events (const MessageEventPtr &send_event, const MessageEventPtr &receive_event)
 
virtual bool is_glued () const
 
- Public Member Functions inherited from MscMessage
 MscMessage (const std::wstring &label=L"")
 
 MscMessage (MscMessage *original)
 
const std::wstring & get_label () const
 
void set_label (const std::wstring &label)
 
- Public Member Functions inherited from MscElementTmpl< MscMessage >
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...
 
MscMessageget_original () const
 
void set_original (MscMessage *e)
 
void set_original (boost::intrusive_ptr< MscMessage > &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 ()
 

Private Attributes

MessageEventm_send_event
 
MessageEventm_receive_event
 

Additional Inherited Members

- Protected Member Functions inherited from MscElementTmpl< MscMessage >
 MscElementTmpl ()
 
 MscElementTmpl (MscMessage *original)
 Creates MscElement referencing the original one. More...
 
- Protected Member Functions inherited from MscElement
 MscElement ()
 
- Protected Attributes inherited from MscElementTmpl< MscMessage >
int m_visual_style
 Visual style of the shape. More...
 
boost::intrusive_ptr< MscMessagem_original
 Pointer to original version of MscElement. More...
 

Detailed Description

Definition at line 22 of file CompleteMessage.h.

Constructor & Destructor Documentation

CompleteMessage::CompleteMessage ( const std::wstring &  label = L"")
inline
Parameters
label- label of message

Definition at line 44 of file CompleteMessage.h.

CompleteMessage::CompleteMessage ( MessageEvent sender,
MessageEvent receiver,
MscMessage original 
)

Definition at line 61 of file CompleteMessage.cpp.

Member Function Documentation

MessageEvent* CompleteMessage::get_receive_event ( ) const
inline

Getter for m_receive_event.

Definition at line 80 of file CompleteMessage.h.

Referenced by can_reconstruct_message().

Instance * CompleteMessage::get_receiver ( ) const

Retrieves instance of m_receive_event

Definition at line 41 of file CompleteMessage.cpp.

References Event::get_instance(), and m_receive_event.

Referenced by remove_complete_message().

MessageEvent* CompleteMessage::get_send_event ( ) const
inline

Getter for m_send_event.

Definition at line 61 of file CompleteMessage.h.

Referenced by reconstruct_removed_message().

Instance * CompleteMessage::get_sender ( ) const

Retrieves instance of m_send_event

Definition at line 21 of file CompleteMessage.cpp.

References Event::get_instance(), and m_send_event.

Referenced by create_complete_message(), and get_proper_area().

void CompleteMessage::glue_events ( const MessageEventPtr send_event,
const MessageEventPtr receive_event 
)
inline

Connects to given send and receive events. Does a sequential execution of glue_send_event() and glue_receive_event().

Definition at line 95 of file CompleteMessage.h.

void CompleteMessage::glue_receive_event ( const MessageEventPtr receive_event)

Connects to a given receive event and re-configures its back-pointers. To un-glue, use NULL as the parameter.

Definition at line 46 of file CompleteMessage.cpp.

References m_receive_event, and MessageEvent::set_message().

void CompleteMessage::glue_send_event ( const MessageEventPtr send_event)

Connects to a given send event and re-configures its back-pointers. To un-glue, use NULL as the parameter.

Definition at line 26 of file CompleteMessage.cpp.

References m_send_event, and MessageEvent::set_message().

virtual bool CompleteMessage::is_glued ( ) const
inlinevirtual

Determines if the message is correctly glued to events.

Implements MscMessage.

Definition at line 101 of file CompleteMessage.h.

Member Data Documentation

MessageEvent* CompleteMessage::m_receive_event
private

Receiver of message.

Warning
boost::intrusive_ptr mustn't be used because of possible cyclic dependency

Definition at line 37 of file CompleteMessage.h.

Referenced by get_receiver(), and glue_receive_event().

MessageEvent* CompleteMessage::m_send_event
private

Sender of message.

Warning
boost::intrusive_ptr mustn't be used because of possible cyclic dependency

Definition at line 30 of file CompleteMessage.h.

Referenced by get_sender(), and glue_send_event().


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

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