vtkObservation Class Reference

Stores information about the relationship between a Subject and an Observer. More...

#include <Libs/MRML/Core/vtkObservation.h>

Inheritance diagram for vtkObservation:

Collaboration diagram for vtkObservation:

Classes
struct	CallType

Public Types
typedef vtkObject	Superclass

Public Member Functions
void	AssignObserver (vtkObject *observer)
void	AssignSubject (vtkObject *subject)
virtual vtkCallbackCommand *	GetCallbackCommand ()
std::deque< CallType > *	GetCallDataList ()
virtual const char *	GetClassName ()
virtual char *	GetComment ()
virtual unsigned long	GetEvent ()
virtual vtkEventBroker *	GetEventBroker ()
virtual unsigned long	GetEventTag ()
virtual int	GetInEventQueue ()
virtual double	GetLastElapsedTime ()
virtual vtkCallbackCommand *	GetObservationCallbackCommand ()
virtual vtkObject *	GetObserver ()
virtual unsigned long	GetObserverDeleteEventTag ()
virtual float	GetPriority ()
virtual char *	GetScript ()
virtual vtkObject *	GetSubject ()
virtual unsigned long	GetSubjectDeleteEventTag ()
virtual double	GetTotalElapsedTime ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) override
virtual void	SetCallbackCommand (vtkCallbackCommand *callbackCommand)
virtual void	SetComment (const char *)
virtual void	SetEvent (unsigned long)
virtual void	SetEventBroker (vtkEventBroker *eventBroker)
virtual void	SetEventTag (unsigned long)
virtual void	SetInEventQueue (int)
virtual void	SetLastElapsedTime (double)
virtual void	SetObserverDeleteEventTag (unsigned long)
virtual void	SetPriority (float)
virtual void	SetScript (const char *)
virtual void	SetSubjectDeleteEventTag (unsigned long)
virtual void	SetTotalElapsedTime (double)

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkObservation *	New ()
	The Usual vtk class functions.
static vtkObservation *	SafeDownCast (vtkObject *o)

Protected Member Functions
void	operator= (const vtkObservation &)
	vtkObservation ()
	vtkObservation (const vtkObservation &)
	~vtkObservation () override

Protected Attributes
vtkCallbackCommand *	CallbackCommand
	Holder for callback that the Observer wants to have run when Event happens.
std::deque< CallType >	CallDataList
	data passed to the observation by the subject
char *	Comment
	Holder for comment string.
unsigned long	Event
	Holder for Event.
vtkEventBroker *	EventBroker
	EventBroker that 'owns' this observation.
unsigned long	EventTag
int	InEventQueue
double	LastElapsedTime
vtkCallbackCommand *	ObservationCallbackCommand
vtkObject *	Observer
	Holder for Observer.
unsigned long	ObserverDeleteEventTag
float	Priority
	Priority of the observer.
char *	Script
	Holder for script as an alternative to the callback command.
vtkObject *	Subject
	Holder for Subject.
unsigned long	SubjectDeleteEventTag
double	TotalElapsedTime

Detailed Description

Stores information about the relationship between a Subject and an Observer.

The Observation is a record of

• a subject (vtkObject)
• an event type (unsigned long)
• an observer (vtkObject)
• a callback (vtkCallbackCommand)
• optional comment strings This class can be used by the vtkEventBroker to keep track of the registered observers that it manages, and it can be used by the event queue to keep track of which events have been triggered so it can invoke them later

  Note

  This class does not add or remove observers itself; it just keeps track of them for the event broker.

Definition at line 43 of file vtkObservation.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkObservation::Superclass

Definition at line 49 of file vtkObservation.h.

Constructor & Destructor Documentation

vtkObservation() [1/2]

vtkObservation::vtkObservation ( )

protected

~vtkObservation()

vtkObservation::~vtkObservation ( )

overrideprotected

vtkObservation() [2/2]

vtkObservation::vtkObservation ( const vtkObservation & )

protected

Member Function Documentation

AssignObserver()

void vtkObservation::AssignObserver ( vtkObject * observer )

inline

Definition at line 72 of file vtkObservation.h.

AssignSubject()

void vtkObservation::AssignSubject ( vtkObject * subject )

inline

Definition at line 64 of file vtkObservation.h.

GetCallbackCommand()

virtual vtkCallbackCommand * vtkObservation::GetCallbackCommand ( )

virtual

GetCallDataList()

std::deque< CallType > * vtkObservation::GetCallDataList ( )

inline

Definition at line 99 of file vtkObservation.h.

GetClassName()

virtual const char * vtkObservation::GetClassName ( )

virtual

GetComment()

virtual char * vtkObservation::GetComment ( )

virtual

GetEvent()

virtual unsigned long vtkObservation::GetEvent ( )

virtual

GetEventBroker()

virtual vtkEventBroker * vtkObservation::GetEventBroker ( )

virtual

GetEventTag()

virtual unsigned long vtkObservation::GetEventTag ( )

virtual

GetInEventQueue()

virtual int vtkObservation::GetInEventQueue ( )

virtual

GetLastElapsedTime()

virtual double vtkObservation::GetLastElapsedTime ( )

virtual

Description Elapsed time of last invocation and total elapsed time (in synchronous mode, elapsed time include children)

GetObservationCallbackCommand()

virtual vtkCallbackCommand * vtkObservation::GetObservationCallbackCommand ( )

virtual

GetObserver()

virtual vtkObject * vtkObservation::GetObserver ( )

virtual

GetObserverDeleteEventTag()

virtual unsigned long vtkObservation::GetObserverDeleteEventTag ( )

virtual

GetPriority()

virtual float vtkObservation::GetPriority ( )

virtual

GetScript()

virtual char * vtkObservation::GetScript ( )

virtual

GetSubject()

virtual vtkObject * vtkObservation::GetSubject ( )

virtual

GetSubjectDeleteEventTag()

virtual unsigned long vtkObservation::GetSubjectDeleteEventTag ( )

virtual

GetTotalElapsedTime()

virtual double vtkObservation::GetTotalElapsedTime ( )

virtual

IsA()

virtual int vtkObservation::IsA ( const char * type )

virtual

IsTypeOf()

static int vtkObservation::IsTypeOf ( const char * type )

static

New()

static vtkObservation * vtkObservation::New ( )

static

The Usual vtk class functions.

operator=()

void vtkObservation::operator= ( const vtkObservation & )

protected

PrintSelf()

void vtkObservation::PrintSelf ( ostream & os, vtkIndent indent )

override

SafeDownCast()

static vtkObservation * vtkObservation::SafeDownCast ( vtkObject * o )

static

SetCallbackCommand()

virtual void vtkObservation::SetCallbackCommand ( vtkCallbackCommand * callbackCommand )

virtual

SetComment()

virtual void vtkObservation::SetComment ( const char * )

virtual

SetEvent()

virtual void vtkObservation::SetEvent ( unsigned long )

virtual

SetEventBroker()

virtual void vtkObservation::SetEventBroker ( vtkEventBroker * eventBroker )

virtual

Accessors

• note that AssignObject methods do not register the pointers
• it is assumed that the EventBroker will attach DeleteEvent observers to these objects and will thereby know when they are no longer valid

SetEventTag()

virtual void vtkObservation::SetEventTag ( unsigned long )

virtual

SetInEventQueue()

virtual void vtkObservation::SetInEventQueue ( int )

virtual

SetLastElapsedTime()

virtual void vtkObservation::SetLastElapsedTime ( double )

virtual

SetObserverDeleteEventTag()

virtual void vtkObservation::SetObserverDeleteEventTag ( unsigned long )

virtual

SetPriority()

virtual void vtkObservation::SetPriority ( float )

virtual

SetScript()

virtual void vtkObservation::SetScript ( const char * )

virtual

SetSubjectDeleteEventTag()

virtual void vtkObservation::SetSubjectDeleteEventTag ( unsigned long )

virtual

SetTotalElapsedTime()

virtual void vtkObservation::SetTotalElapsedTime ( double )

virtual

Member Data Documentation

CallbackCommand

vtkCallbackCommand* vtkObservation::CallbackCommand

protected

Holder for callback that the Observer wants to have run when Event happens.

Definition at line 136 of file vtkObservation.h.

CallDataList

std::deque<CallType> vtkObservation::CallDataList

protected

data passed to the observation by the subject

Definition at line 140 of file vtkObservation.h.

Comment

char* vtkObservation::Comment

protected

Holder for comment string.

Definition at line 148 of file vtkObservation.h.

Event

unsigned long vtkObservation::Event

protected

Holder for Event.

Definition at line 128 of file vtkObservation.h.

EventBroker

vtkEventBroker* vtkObservation::EventBroker

protected

EventBroker that 'owns' this observation.

Definition at line 109 of file vtkObservation.h.

EventTag

unsigned long vtkObservation::EventTag

protected

keep track of the tags returned by vtkObject::AddObserver so this observation will be easy to remove when the time comes

Definition at line 156 of file vtkObservation.h.

InEventQueue

int vtkObservation::InEventQueue

protected

Flag that tells the broker that this observation is already in the event queue and doesn't need to be re-added

Definition at line 120 of file vtkObservation.h.

LastElapsedTime

double vtkObservation::LastElapsedTime

protected

Definition at line 160 of file vtkObservation.h.

ObservationCallbackCommand

vtkCallbackCommand* vtkObservation::ObservationCallbackCommand

protected

Holder for callback that this object wants called when either the subject or the observer triggers and event

Definition at line 114 of file vtkObservation.h.

Observer

vtkObject* vtkObservation::Observer

protected

Holder for Observer.

Definition at line 132 of file vtkObservation.h.

ObserverDeleteEventTag

unsigned long vtkObservation::ObserverDeleteEventTag

protected

Definition at line 158 of file vtkObservation.h.

Priority

float vtkObservation::Priority

protected

Priority of the observer.

Definition at line 151 of file vtkObservation.h.

Script

char* vtkObservation::Script

protected

Holder for script as an alternative to the callback command.

Definition at line 144 of file vtkObservation.h.

Subject

vtkObject* vtkObservation::Subject

protected

Holder for Subject.

Definition at line 124 of file vtkObservation.h.

SubjectDeleteEventTag

unsigned long vtkObservation::SubjectDeleteEventTag

protected

Definition at line 157 of file vtkObservation.h.

TotalElapsedTime

double vtkObservation::TotalElapsedTime

protected

Definition at line 161 of file vtkObservation.h.

---

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

• Libs/MRML/Core/vtkObservation.h