vtkObservation Class Reference

#include <vtkObservation.h>

Inheritance diagram for vtkObservation:

Public Member Functions
void	AssignObserver (vtkObject *observer)
void	AssignSubject (vtkObject *subject)
std::deque< void * > *	GetCallDataList ()
void	PrintSelf (ostream &os, vtkIndent indent)
	vtkGetMacro (TotalElapsedTime, double)
	vtkGetMacro (LastElapsedTime, double)
	vtkGetMacro (ObserverDeleteEventTag, unsigned long)
	vtkGetMacro (SubjectDeleteEventTag, unsigned long)
	vtkGetMacro (EventTag, unsigned long)
	vtkGetMacro (Event, unsigned long)
	vtkGetMacro (InEventQueue, int)
	vtkGetObjectMacro (Observer, vtkObject)
	vtkGetObjectMacro (CallbackCommand, vtkCallbackCommand)
	vtkGetObjectMacro (Subject, vtkObject)
	vtkGetObjectMacro (ObservationCallbackCommand, vtkCallbackCommand)
	vtkGetObjectMacro (EventBroker, vtkEventBroker)
	vtkGetStringMacro (Comment)
	vtkGetStringMacro (Script)
	vtkSetMacro (TotalElapsedTime, double)
	vtkSetMacro (LastElapsedTime, double)
	vtkSetMacro (ObserverDeleteEventTag, unsigned long)
	vtkSetMacro (SubjectDeleteEventTag, unsigned long)
	vtkSetMacro (EventTag, unsigned long)
	vtkSetMacro (Event, unsigned long)
	vtkSetMacro (InEventQueue, int)
	vtkSetObjectMacro (CallbackCommand, vtkCallbackCommand)
	vtkSetObjectMacro (EventBroker, vtkEventBroker)
	vtkSetStringMacro (Comment)
	vtkSetStringMacro (Script)
	vtkTypeRevisionMacro (vtkObservation, vtkObject)
Static Public Member Functions
static vtkObservation *	New ()
	The Usual vtk class functions.
Protected Member Functions
void	operator= (const vtkObservation &)
	vtkObservation (const vtkObservation &)
	vtkObservation ()
virtual	~vtkObservation ()
Protected Attributes
vtkCallbackCommand *	CallbackCommand
std::deque< void * >	CallDataList
char *	Comment
unsigned long	Event
vtkEventBroker *	EventBroker
unsigned long	EventTag
int	InEventQueue
double	LastElapsedTime
vtkCallbackCommand *	ObservationCallbackCommand
vtkObject *	Observer
unsigned long	ObserverDeleteEventTag
char *	Script
vtkObject *	Subject
unsigned long	SubjectDeleteEventTag
double	TotalElapsedTime

Detailed Description

vtkObservation - class that 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 objserver (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 .NOTES This class does not add or remove observers itself; it just keeps track of them for the event broker.

Constructor & Destructor Documentation

vtkObservation::vtkObservation ( ) [protected]

References vtkEventBroker::Callback(), CallbackCommand, Comment, Event, EventBroker, EventTag, InEventQueue, LastElapsedTime, New(), ObservationCallbackCommand, Observer, ObserverDeleteEventTag, Script, Subject, SubjectDeleteEventTag, and TotalElapsedTime.

vtkObservation::~vtkObservation ( ) [protected, virtual]

References CallbackCommand, EventBroker, and ObservationCallbackCommand.

vtkObservation::vtkObservation ( const vtkObservation & ) [protected]

Member Function Documentation

void vtkObservation::AssignObserver ( vtkObject * observer ) [inline]

Referenced by vtkEventBroker::AddObservation().

void vtkObservation::AssignSubject ( vtkObject * subject ) [inline]

Referenced by vtkEventBroker::AddObservation().

std::deque<void *>* vtkObservation::GetCallDataList ( ) [inline]

Referenced by vtkEventBroker::ProcessEventQueue(), and vtkEventBroker::QueueObservation().

static vtkObservation* vtkObservation::New ( ) [static]

The Usual vtk class functions.

Referenced by vtkObservation().

void vtkObservation::operator= ( const vtkObservation & ) [protected]

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

References CallbackCommand, Comment, Event, EventBroker, EventTag, LastElapsedTime, Observer, ObserverDeleteEventTag, Script, Subject, SubjectDeleteEventTag, and TotalElapsedTime.

vtkObservation::vtkGetMacro	(	TotalElapsedTime	,
		double
	)

vtkObservation::vtkGetMacro	(	LastElapsedTime	,
		double
	)

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

vtkObservation::vtkGetMacro	(	ObserverDeleteEventTag	,
		unsigned	long
	)

vtkObservation::vtkGetMacro	(	SubjectDeleteEventTag	,
		unsigned	long
	)

vtkObservation::vtkGetMacro	(	EventTag	,
		unsigned	long
	)

vtkObservation::vtkGetMacro	(	Event	,
		unsigned	long
	)

vtkObservation::vtkGetMacro	(	InEventQueue	,
		int
	)

vtkObservation::vtkGetObjectMacro	(	Observer	,
		vtkObject
	)

vtkObservation::vtkGetObjectMacro	(	CallbackCommand	,
		vtkCallbackCommand
	)

vtkObservation::vtkGetObjectMacro	(	Subject	,
		vtkObject
	)

vtkObservation::vtkGetObjectMacro	(	ObservationCallbackCommand	,
		vtkCallbackCommand
	)

vtkObservation::vtkGetObjectMacro	(	EventBroker	,
		vtkEventBroker
	)

vtkObservation::vtkGetStringMacro ( Comment )

vtkObservation::vtkGetStringMacro ( Script )

vtkObservation::vtkSetMacro	(	TotalElapsedTime	,
		double
	)

vtkObservation::vtkSetMacro	(	LastElapsedTime	,
		double
	)

vtkObservation::vtkSetMacro	(	ObserverDeleteEventTag	,
		unsigned	long
	)

vtkObservation::vtkSetMacro	(	SubjectDeleteEventTag	,
		unsigned	long
	)

vtkObservation::vtkSetMacro	(	EventTag	,
		unsigned	long
	)

vtkObservation::vtkSetMacro	(	Event	,
		unsigned	long
	)

vtkObservation::vtkSetMacro	(	InEventQueue	,
		int
	)

vtkObservation::vtkSetObjectMacro	(	CallbackCommand	,
		vtkCallbackCommand
	)

vtkObservation::vtkSetObjectMacro	(	EventBroker	,
		vtkEventBroker
	)

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

vtkObservation::vtkSetStringMacro ( Comment )