BALL::VIEW::Message

BALL::VIEW::Message Class Reference
[Messages]

#include <BALL/VIEW/KERNEL/message.h>

Inheritance diagram for BALL::VIEW::Message:
BALL::VIEW::CompositeMessage BALL::VIEW::CreateRepresentationMessage BALL::VIEW::DatasetMessage BALL::VIEW::DeselectControlsMessage BALL::VIEW::DockingFinishedMessage BALL::VIEW::FinishedSimulationMessage BALL::VIEW::GenericSelectionMessage BALL::VIEW::GeometricObjectSelectionMessage BALL::VIEW::MolecularTaskMessage BALL::VIEW::NewSelectionMessage BALL::VIEW::RegisterHelpSystemMessage BALL::VIEW::RepresentationMessage BALL::VIEW::SceneMessage BALL::VIEW::ShowDisplayPropertiesMessage BALL::VIEW::ShowHelpMessage BALL::VIEW::SyncClippingPlanesMessage BALL::VIEW::TransformationMessage

List of all members.


Public Member Functions

Constructors and Destructor
 Message ()
 Message (const Message &message)
virtual ~Message ()
Accessors: inspectors and mutators
void setSender (const ConnectionObject *sender)
const ConnectionObject * getSender () const
void setDeletable (bool flag=true)
bool isDeletable () const

Private Attributes

const ConnectionObject * connection_object_
bool deletable_

Detailed Description

General Message class. Message is the base class of all message classes and provides a base interface. Message classes will be sent through the ConnectionObject tree for the purpose of communication between several ConnectionObject classes. Each ConnectionObject handels in its onNotify() method messages that are relevant for that class by means of RTTI. This class can be given a sender object that is a pointer to the ConnectionObject that has initially sent the message. This methods concerning the sender object are internally used and no user interaction is necessary. A message can be deletable or not. If a message is deletable it will be deleted after all ConnectionObject objects has been informed of this message. Therefore a deletable message must be created with the new command. All messages should be created with the new command, since they will be automatically deleted after all ConnectionObjects have been notified. See ConnectionObject for further information concerning message handling. and message posting.

Constructor & Destructor Documentation

BALL::VIEW::Message::Message (  ) 

Default Constructor. The state of this message is:

  • sender - set to 0
  • deletable - set to false
BALL::VIEW::Message::Message ( const Message &  message  ) 

Copy constructor.

virtual BALL::VIEW::Message::~Message (  )  [virtual]

Destructor.

Member Function Documentation

const ConnectionObject* BALL::VIEW::Message::getSender (  )  const

Non-mutable inspection of the sender. This method will be used internally by ConnectionObject::onNotify.

See also:
ConnectionObject::onNotify
bool BALL::VIEW::Message::isDeletable (  )  const

Test if this message is deletable.

void BALL::VIEW::Message::setDeletable ( bool  flag = true  ) 

Change the deletable flag. If the parameter flag is set to true the message is set to deletable and will be automatically deleted after all ConnectionObject objects are notified of this message. It is important that the message is created by the new command to avoid segmentation faults.

If the parameter flag is set to false the message will not be automatically deleted.
Avoid creating non-deletable messages because it can result in segmentation faults.
Parameters:
flag the new deletable state of this message
void BALL::VIEW::Message::setSender ( const ConnectionObject *  sender  ) 

Change the sender. This method will be used internally by ConnectionObject::notify_.

See also:
ConnectionObject::notify_

Member Data Documentation

const ConnectionObject* BALL::VIEW::Message::connection_object_ [private]
bool BALL::VIEW::Message::deletable_ [private]