ToyMaker::Signal< TArgs > Class Template Reference

A Signal object, designed to emit signals matching some data signature to be received by all the SignalObservers subscribed to it. More...

#include <signals.hpp>

Public Member Functions
	Signal (SignalTracker &owningTracker, const std::string &name)
	Constructs a Signal object and associates it with its SignalTracker.
	Signal (const Signal &other)=delete
	Signal (Signal &&other)=delete
Signal &	operator= (const Signal &other)=delete
Signal &	operator= (Signal &&other)=delete
void	emit (TArgs...args)
	A method on the signal which causes the signal to be sent to all of its subscribers (aka SignalObservers).
void	resetSignal (SignalTracker &owningTracker, const std::string &name)
	Reinitializes the tracker with a new owning SignalTracker.

Private Member Functions
void	registerObserver (SignalObserver< TArgs... > &observer)
	Registers a compatible SignalObserver as a subscriber of this Signal.

Private Attributes
std::shared_ptr< Signal_< TArgs... > >	mSignal_
	The actual object connected with this Signal's signal tracker, hidden from users of Signal.

Friends
class	SignalObserver< TArgs... >

Detailed Description

template<typename ... TArgs>
class ToyMaker::Signal< TArgs >

A Signal object, designed to emit signals matching some data signature to be received by all the SignalObservers subscribed to it.

It is essentially a wrapper over Signal_<T>

Usage

class SomeClass : public ToyMaker::SignalTracker {
 
    // ... 
 
public:
    ToyMaker::Signal<> mSigViewUpdateStarted { *this, "ViewUpdateStarted" };
 
    ToyMaker::Signal<GameScoreData> mSigScoreUpdated { *this, "ScoreUpdated" };
 
    // ...
 
};

Here we see two signals declared, one that sends no data, and one that sends GameScoreData, named "ViewUpdateStarted" and "ScoreUpdated" respectively.

When a SignalObserver (with the correct signature) wishes to connect to these signals, a function call resembling the one below should be made:

signalTo.connect(
    "ViewUpdateStarted",
    "ObserveViewUpdateStarted",
    signalFrom
);

Where:

• signalTo is a reference to the SignalTracker (or its subclass) owning the SignalObserver.
• signalFrom is a reference to the SignalTracker (or its subclass) owning the Signal
• "ViewUpdateStarted" is the name of the Signal being subscribed to.
• "ObserveViewUpdateStarted" is the name of the SignalObserver requesting subscription.

Template Parameters

TArgs

A list of data types this Signal is expected to send when a signal is emitted.

See also

SignalTracker

SignalObserver

Constructor & Destructor Documentation

Signal()

template<typename ... TArgs>

ToyMaker::Signal< TArgs >::Signal	(	SignalTracker &	owningTracker,
		const std::string &	name )

Constructs a Signal object and associates it with its SignalTracker.

Parameters

owningTracker	The tracker responsible for advertising this signal.
name	The name of this signal.

Member Function Documentation

emit()

template<typename ... TArgs>

void ToyMaker::Signal< TArgs >::emit

(

TArgs...

args

)

A method on the signal which causes the signal to be sent to all of its subscribers (aka SignalObservers).

Parameters

args	A list of values sent along with this signal.

registerObserver()

template<typename ... TArgs>

void ToyMaker::Signal< TArgs >::registerObserver ( SignalObserver< TArgs... > & observer )

private

Registers a compatible SignalObserver as a subscriber of this Signal.

Parameters

observer

The observer requesting subscription.

resetSignal()

template<typename ... TArgs>

void ToyMaker::Signal< TArgs >::resetSignal	(	SignalTracker &	owningTracker,
		const std::string &	name )

Reinitializes the tracker with a new owning SignalTracker.

Useful for copy and move operations on the object this signal may be a member of.

Parameters

owningTracker	A reference to this Signal's new owning tracker.
name	The (possibly new) name of this signal, per its owner.

Todo

Investigate the behaviour of this method.

---

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

• ToyMaker_Main/include/toymaker/engine/signals.hpp