tgObserver< Subject > Class Template Reference

#include <tgObserver.h>

Public Member Functions
virtual	~tgObserver ()
virtual void	onStep (Subject &subject, double dt)=0
virtual void	onAttach (Subject &subject)
virtual void	onSetup (Subject &subject)
virtual void	onTeardown (Subject &subject)

Detailed Description

template<class Subject>
class tgObserver< Subject >

A mixin class which makes its derived class the Subject in the Obsever design pattern. These are typically controllers.

Definition at line 34 of file tgObserver.h.

Constructor & Destructor Documentation

template<class Subject>

virtual tgObserver< Subject >::~tgObserver ( )

inlinevirtual

A class with virtual member functions must have a virtual destructor.

Definition at line 39 of file tgObserver.h.

Member Function Documentation

template<class Subject>

virtual void tgObserver< Subject >::onAttach ( Subject &  subject )

inlinevirtual

Notify the observers when an attach action has occurred. Will only occur once, typically before setup

Parameters

[in,out]

subject

the subject being observed

Reimplemented in tgCPGStringControl.

Definition at line 54 of file tgObserver.h.

Here is the caller graph for this function:

template<class Subject>

virtual void tgObserver< Subject >::onSetup ( Subject &  subject )

inlinevirtual

Notify the observers when a setup action has occurred.

Parameters

[in,out]

subject

the subject being observed

Reimplemented in BaseSpineCPGControl, and T6RestLengthController.

Definition at line 60 of file tgObserver.h.

Here is the caller graph for this function:

template<class Subject>

virtual void tgObserver< Subject >::onStep ( Subject &  subject, double  dt  )

pure virtual

Notify the observers when a step action has occurred.

Parameters

[in,out]	subject	the subject being observed
[in]	the	number of seconds since the previous call; must be positive

Implemented in BaseSpineCPGControl, NestedStructureSineWaves, T6RestLengthController, T6TensionController, tgCPGStringControl, PretensionController, ContactTestController, and BuildTestController.

Here is the caller graph for this function:

template<class Subject>

virtual void tgObserver< Subject >::onTeardown ( Subject &  subject )

inlinevirtual

Notify the observers when a teardown action has occurred.

Parameters

[in,out]

subject

the subject being observed

Reimplemented in BaseSpineCPGControl.

Definition at line 66 of file tgObserver.h.

Here is the caller graph for this function:

---

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

• core/tgObserver.h