mlFieldSensor.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef ML_FIELD_SENSOR_H
#define ML_FIELD_SENSOR_H

 
//ML-includes
#include "mlInitSystemML.h"
 
ML_START_NAMESPACE

class Field;
 
//------------------------------------------------------------------------------------
//------------------------------------------------------------------------------------
class MLEXPORT FieldSensor
{
 
public:

  enum Strength { NO_NOTIFICATION = 0, 
                  NO_CHANGE       = 1, 
                  CHANGED         = 2  
                };

  FieldSensor(MLSensorCB* callbackFunction, void* userData);

  virtual ~FieldSensor();

  void     callback(Strength notificationStrength=CHANGED);

  void     attachField(Field* field);

  void     detachField();

  Field* getField() const;

  Strength getNotificationStrength() const;
 
private:
  friend class Field;

  void     attachFieldInternal(Field* field);

  Field*        _attachedField;

  MLSensorCB*   _callbackFunc;

  void*         _userData;

  Strength      _notificationStrength;
};
 
 
ML_END_NAMESPACE
 
#endif // __mlFieldSensor_H