vtkObservation.h

Go to the documentation of this file.

/*=auto=========================================================================

  Portions (c) Copyright 2005 Brigham and Women's Hospital (BWH) All Rights Reserved.

  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.

  Program:   3D Slicer
  Module:    $RCSfile: vtkObservation.h,v $
  Date:      $Date: 2006/01/08 04:48:05 $
  Version:   $Revision: 1.45 $

=========================================================================auto=*/

#ifndef __vtkObservation_h
#define __vtkObservation_h

// MRML includes
#include "vtkMRML.h"
class vtkEventBroker;

// VTK includes
#include <vtkObject.h>
class vtkCallbackCommand;

// STD includes
#include <deque>

//
class VTK_MRML_EXPORT vtkObservation : public vtkObject
{
  public:

  static vtkObservation *New();
  vtkTypeMacro(vtkObservation,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  virtual void SetEventBroker(vtkEventBroker* eventBroker);
  vtkGetObjectMacro (EventBroker, vtkEventBroker);
  vtkGetMacro (InEventQueue, int);
  vtkSetMacro (InEventQueue, int);
  vtkGetObjectMacro (ObservationCallbackCommand, vtkCallbackCommand);
  vtkGetObjectMacro (Subject, vtkObject);
  void AssignSubject(vtkObject* subject) {this->Subject = subject;};
  vtkGetMacro (Event, unsigned long);
  vtkSetMacro (Event, unsigned long);
  virtual void SetCallbackCommand(vtkCallbackCommand* callbackCommand);
  vtkGetObjectMacro (CallbackCommand, vtkCallbackCommand);
  vtkSetStringMacro (Script);
  vtkGetStringMacro (Script);
  vtkGetObjectMacro (Observer, vtkObject);
  void AssignObserver(vtkObject* observer) {this->Observer = observer;};
  vtkSetStringMacro (Comment);
  vtkGetStringMacro (Comment);
  vtkSetMacro(Priority, float);
  vtkGetMacro(Priority, float);

  vtkGetMacro (EventTag, unsigned long);
  vtkSetMacro (EventTag, unsigned long);
  vtkGetMacro (SubjectDeleteEventTag, unsigned long);
  vtkSetMacro (SubjectDeleteEventTag, unsigned long);
  vtkGetMacro (ObserverDeleteEventTag, unsigned long);
  vtkSetMacro (ObserverDeleteEventTag, unsigned long);

  vtkGetMacro (LastElapsedTime, double);
  vtkSetMacro (LastElapsedTime, double);
  vtkGetMacro (TotalElapsedTime, double);
  vtkSetMacro (TotalElapsedTime, double);

  struct CallType
  {
    inline CallType(unsigned long eventID, void* callData);
    unsigned long EventID;
    void* CallData;
  };
  std::deque<CallType> *GetCallDataList() {return &(this->CallDataList);};

protected:
  vtkObservation();
  ~vtkObservation() override;
  vtkObservation(const vtkObservation&);
  void operator=(const vtkObservation&);

  vtkEventBroker *EventBroker;

  vtkCallbackCommand *ObservationCallbackCommand;

  int InEventQueue;

  vtkObject *Subject;

  unsigned long Event;

  vtkObject *Observer;

  vtkCallbackCommand *CallbackCommand;

  std::deque<CallType> CallDataList;

  char *Script;

  char *Comment;

  float Priority;

  unsigned long EventTag;
  unsigned long SubjectDeleteEventTag;
  unsigned long ObserverDeleteEventTag;

  double LastElapsedTime;
  double TotalElapsedTime;

};

//----------------------------------------------------------------------------
vtkObservation::CallType::CallType(unsigned long eventID, void* callData)
  : EventID(eventID)
  , CallData(callData)
{
}


#endif