BALL  1.4.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Types | Public Member Functions | Protected Attributes | List of all members
BALL::VIEW::DatasetMessage Class Reference

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

Inheritance diagram for BALL::VIEW::DatasetMessage:
BALL::VIEW::Message

Public Types

enum  Type {
  UNDEFINED = -1, ADD = 0, REMOVE, UPDATE,
  SELECTED, VISUALIZE, VISUALIZE_END = 100
}
 Message type enumeration. More...
 

Public Member Functions

 DatasetMessage (Dataset *set=0, Type type=UNDEFINED)
 
 DatasetMessage (const DatasetMessage &msg)
 
Type getType () const
 
void setType (Type type)
 
DatasetgetDataset () const
 
void setDataset (Dataset *set)
 
bool isValid () const
 
- Public Member Functions inherited from BALL::VIEW::Message
 Message ()
 
 Message (const Message &message)
 
virtual ~Message ()
 
void setSender (const ConnectionObject *sender)
 
const ConnectionObjectgetSender () const
 
void setDeletable (bool flag=true)
 
bool isDeletable () const
 
boost::any & data ()
 

Protected Attributes

Datasetdataset_
 
Type type_
 
String dataset_type_
 

Detailed Description

Message to notify about changes in a Dataset. This message can be e.g. used to notify all ModularWidget about a new DockResult, Trajectory or any other kind of dataset. The Dataset contains the information on the kind of data it contains. The receiving widget thus has to query the type of the message and the the type of the Dataset.

See Also
Dataset
DatasetController
DatasetControl

Definition at line 137 of file message.h.

Member Enumeration Documentation

Message type enumeration.

Enumerator
UNDEFINED 

Default Value.

ADD 

To add.

REMOVE 

To be removed.

UPDATE 

Update.

SELECTED 

Was selected in Control.

VISUALIZE 
VISUALIZE_END 

Allow >90 different kinds of visualization.

Definition at line 143 of file message.h.

Constructor & Destructor Documentation

BALL::VIEW::DatasetMessage::DatasetMessage ( Dataset set = 0,
Type  type = UNDEFINED 
)
BALL::VIEW::DatasetMessage::DatasetMessage ( const DatasetMessage msg)

Member Function Documentation

Dataset* BALL::VIEW::DatasetMessage::getDataset ( ) const
inline

Definition at line 180 of file message.h.

Type BALL::VIEW::DatasetMessage::getType ( ) const
inline

Definition at line 174 of file message.h.

bool BALL::VIEW::DatasetMessage::isValid ( ) const
void BALL::VIEW::DatasetMessage::setDataset ( Dataset set)
inline

Definition at line 183 of file message.h.

void BALL::VIEW::DatasetMessage::setType ( Type  type)
inline

Definition at line 177 of file message.h.

Member Data Documentation

Dataset* BALL::VIEW::DatasetMessage::dataset_
protected

Definition at line 190 of file message.h.

String BALL::VIEW::DatasetMessage::dataset_type_
protected

Definition at line 192 of file message.h.

Type BALL::VIEW::DatasetMessage::type_
protected

Definition at line 191 of file message.h.