trax::SignalTarget Struct Reference

Target for signal notification. More...

#include <C:/Trend/Development/Trax3/Code/trax/Signal.h>

Inheritance diagram for trax::SignalTarget:

Public Member Functions
virtual bool	Notify (const Signal &signal, Length distance)=0
	Method called to notify about a signalling state.
virtual void	Active (bool bActive) noexcept=0
	Switches the target on or off to receive notifications from signals.
virtual bool	Active () const noexcept=0
	SignalTarget (const SignalTarget &)=delete
	SignalTarget (SignalTarget &&)=delete
SignalTarget &	operator= (const SignalTarget &)=delete
SignalTarget &	operator= (SignalTarget &&)=delete

Detailed Description

Target for signal notification.

Member Function Documentation

Active() [1/2]

virtual bool trax::SignalTarget::Active ( ) const

pure virtualnoexcept

Returns

Activity state of the target.

Implemented in TestSignalTarget.

Active() [2/2]

virtual void trax::SignalTarget::Active ( bool bActive )

pure virtualnoexcept

Switches the target on or off to receive notifications from signals.

Parameters

bActive

true to receive, the default.

Implemented in TestSignalTarget.

Notify()

virtual bool trax::SignalTarget::Notify ( const Signal & signal, Length distance )

pure virtual

Method called to notify about a signalling state.

Parameters

signal	Reference to signal that notifies.
distance	The distance from the location the SignalTarget is moved with up to the head of the signal range.

Returns

true if the movement along the track should get calculated, false if this is supposed to stop, because the train was relocated by the Notify function.

Implemented in TestSignalTarget.

---

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

• C:/Trend/Development/Trax3/Code/trax/Signal.h