EventT< T > Class Template Reference

A class for event processing. More...

#include <Event.hh>

Inherits Event.

Public Member Functions
	EventT ()
	Constructor. More...
virtual	~EventT ()
	Destructor. More...
ConnectionPtr	Connect (const std::function< T > &_subscriber)
	Connect a callback to this event. More...
unsigned int	ConnectionCount () const
	Get the number of connections. More...
virtual void	Disconnect (ConnectionPtr _c) GAZEBO_DEPRECATED(8.0)
	Disconnect a callback to this event. More...
virtual void	Disconnect (int _id)
	Disconnect a callback to this event. More...
bool	GetSignaled () const GAZEBO_DEPRECATED(8.0)
	Get whether this event has been signaled. More...
void	operator() ()
	Access the signal. More...
template<typename P >
void	operator() (const P &_p)
	Signal the event with one parameter. More...
template<typename P1 , typename P2 >
void	operator() (const P1 &_p1, const P2 &_p2)
	Signal the event with two parameters. More...
template<typename P1 , typename P2 , typename P3 >
void	operator() (const P1 &_p1, const P2 &_p2, const P3 &_p3)
	Signal the event with three parameters. More...
template<typename P1 , typename P2 , typename P3 , typename P4 >
void	operator() (const P1 &_p1, const P2 &_p2, const P3 &_p3, const P4 &_p4)
	Signal the event with four parameters. More...
template<typename P1 , typename P2 , typename P3 , typename P4 , typename P5 >
void	operator() (const P1 &_p1, const P2 &_p2, const P3 &_p3, const P4 &_p4, const P5 &_p5)
	Signal the event with five parameters. More...
template<typename P1 , typename P2 , typename P3 , typename P4 , typename P5 , typename P6 >
void	operator() (const P1 &_p1, const P2 &_p2, const P3 &_p3, const P4 &_p4, const P5 &_p5, const P6 &_p6)
	Signal the event with six parameters. More...
template<typename P1 , typename P2 , typename P3 , typename P4 , typename P5 , typename P6 , typename P7 >
void	operator() (const P1 &_p1, const P2 &_p2, const P3 &_p3, const P4 &_p4, const P5 &_p5, const P6 &_p6, const P7 &_p7)
	Signal the event with seven parameters. More...
template<typename P1 , typename P2 , typename P3 , typename P4 , typename P5 , typename P6 , typename P7 , typename P8 >
void	operator() (const P1 &_p1, const P2 &_p2, const P3 &_p3, const P4 &_p4, const P5 &_p5, const P6 &_p6, const P7 &_p7, const P8 &_p8)
	Signal the event with eight parameters. More...
template<typename P1 , typename P2 , typename P3 , typename P4 , typename P5 , typename P6 , typename P7 , typename P8 , typename P9 >
void	operator() (const P1 &_p1, const P2 &_p2, const P3 &_p3, const P4 &_p4, const P5 &_p5, const P6 &_p6, const P7 &_p7, const P8 &_p8, const P9 &_p9)
	Signal the event with nine parameters. More...
template<typename P1 , typename P2 , typename P3 , typename P4 , typename P5 , typename P6 , typename P7 , typename P8 , typename P9 , typename P10 >
void	operator() (const P1 &_p1, const P2 &_p2, const P3 &_p3, const P4 &_p4, const P5 &_p5, const P6 &_p6, const P7 &_p7, const P8 &_p8, const P9 &_p9, const P10 &_p10)
	Signal the event with ten parameters. More...
void	SetSignaled (const bool _sig)
	Set whether this event has been signaled. More...
void	Signal ()
	Signal the event for all subscribers. More...
template<typename P >
void	Signal (const P &_p)
	Signal the event with one parameter. More...
template<typename P1 , typename P2 >
void	Signal (const P1 &_p1, const P2 &_p2)
	Signal the event with two parameter. More...
template<typename P1 , typename P2 , typename P3 >
void	Signal (const P1 &_p1, const P2 &_p2, const P3 &_p3)
	Signal the event with three parameter. More...
template<typename P1 , typename P2 , typename P3 , typename P4 >
void	Signal (const P1 &_p1, const P2 &_p2, const P3 &_p3, const P4 &_p4)
	Signal the event with four parameter. More...
template<typename P1 , typename P2 , typename P3 , typename P4 , typename P5 >
void	Signal (const P1 &_p1, const P2 &_p2, const P3 &_p3, const P4 &_p4, const P5 &_p5)
	Signal the event with five parameter. More...
template<typename P1 , typename P2 , typename P3 , typename P4 , typename P5 , typename P6 >
void	Signal (const P1 &_p1, const P2 &_p2, const P3 &_p3, const P4 &_p4, const P5 &_p5, const P6 &_p6)
	Signal the event with six parameter. More...
template<typename P1 , typename P2 , typename P3 , typename P4 , typename P5 , typename P6 , typename P7 >
void	Signal (const P1 &_p1, const P2 &_p2, const P3 &_p3, const P4 &_p4, const P5 &_p5, const P6 &_p6, const P7 &_p7)
	Signal the event with seven parameter. More...
template<typename P1 , typename P2 , typename P3 , typename P4 , typename P5 , typename P6 , typename P7 , typename P8 >
void	Signal (const P1 &_p1, const P2 &_p2, const P3 &_p3, const P4 &_p4, const P5 &_p5, const P6 &_p6, const P7 &_p7, const P8 &_p8)
	Signal the event with eight parameter. More...
template<typename P1 , typename P2 , typename P3 , typename P4 , typename P5 , typename P6 , typename P7 , typename P8 , typename P9 >
void	Signal (const P1 &_p1, const P2 &_p2, const P3 &_p3, const P4 &_p4, const P5 &_p5, const P6 &_p6, const P7 &_p7, const P8 &_p8, const P9 &_p9)
	Signal the event with nine parameter. More...
template<typename P1 , typename P2 , typename P3 , typename P4 , typename P5 , typename P6 , typename P7 , typename P8 , typename P9 , typename P10 >
void	Signal (const P1 &_p1, const P2 &_p2, const P3 &_p3, const P4 &_p4, const P5 &_p5, const P6 &_p6, const P7 &_p7, const P8 &_p8, const P9 &_p9, const P10 &_p10)
	Signal the event with ten parameter. More...
bool	Signaled () const
	Get whether this event has been signaled. More...

Detailed Description

template<typename T>
class gazebo::event::EventT< T >

A class for event processing.

Member Function Documentation

bool GetSignaled ( ) const

inherited

Get whether this event has been signaled.

Returns

True if the event has been signaled.

Deprecated:

See bool Signaled() const;

void operator() ( )

inline

Access the signal.

void operator() ( const P &  _p )

inline

Signal the event with one parameter.

Parameters

[in]

_p

the parameter.

void operator() ( const P1 &  _p1, const P2 &  _p2  )

inline

Signal the event with two parameters.

Parameters

[in]	_p1	the first parameter.
[in]	_p2	the second parameter.

void operator() ( const P1 &  _p1, const P2 &  _p2, const P3 &  _p3  )

inline

Signal the event with three parameters.

Parameters

[in]	_p1	the first parameter.
[in]	_p2	the second parameter.
[in]	_p3	the second parameter.

void operator() ( const P1 &  _p1, const P2 &  _p2, const P3 &  _p3, const P4 &  _p4  )

inline

Signal the event with four parameters.

Parameters

[in]	_p1	the first parameter.
[in]	_p2	the second parameter.
[in]	_p3	the second parameter.
[in]	_p4	the first parameter.

void operator() ( const P1 &  _p1, const P2 &  _p2, const P3 &  _p3, const P4 &  _p4, const P5 &  _p5  )

inline

Signal the event with five parameters.

Parameters

[in]	_p1	the first parameter.
[in]	_p2	the second parameter.
[in]	_p3	the second parameter.
[in]	_p4	the first parameter.
[in]	_p5	the fift parameter.

void operator() ( const P1 &  _p1, const P2 &  _p2, const P3 &  _p3, const P4 &  _p4, const P5 &  _p5, const P6 &  _p6  )

inline

Signal the event with six parameters.

Parameters

[in]	_p1	the first parameter.
[in]	_p2	the second parameter.
[in]	_p3	the second parameter.
[in]	_p4	the first parameter.
[in]	_p5	the fift parameter.
[in]	_p6	the sixt parameter.

void operator() ( const P1 &  _p1, const P2 &  _p2, const P3 &  _p3, const P4 &  _p4, const P5 &  _p5, const P6 &  _p6, const P7 &  _p7  )

inline

Signal the event with seven parameters.

Parameters

[in]	_p1	the first parameter.
[in]	_p2	the second parameter.
[in]	_p3	the second parameter.
[in]	_p4	the first parameter.
[in]	_p5	the fifth parameter.
[in]	_p6	the sixth parameter.
[in]	_p7	the seventh parameter.

void operator() ( const P1 &  _p1, const P2 &  _p2, const P3 &  _p3, const P4 &  _p4, const P5 &  _p5, const P6 &  _p6, const P7 &  _p7, const P8 &  _p8  )

inline

Signal the event with eight parameters.

Parameters

[in]	_p1	the first parameter.
[in]	_p2	the second parameter.
[in]	_p3	the second parameter.
[in]	_p4	the first parameter.
[in]	_p5	the fifth parameter.
[in]	_p6	the sixth parameter.
[in]	_p7	the seventh parameter.
[in]	_p8	the eighth parameter.

void operator() ( const P1 &  _p1, const P2 &  _p2, const P3 &  _p3, const P4 &  _p4, const P5 &  _p5, const P6 &  _p6, const P7 &  _p7, const P8 &  _p8, const P9 &  _p9  )

inline

Signal the event with nine parameters.

Parameters

[in]	_p1	the first parameter.
[in]	_p2	the second parameter.
[in]	_p3	the second parameter.
[in]	_p4	the first parameter.
[in]	_p5	the fifth parameter.
[in]	_p6	the sixth parameter.
[in]	_p7	the seventh parameter.
[in]	_p8	the eighth parameter.
[in]	_p9	the ninth parameter.

void operator() ( const P1 &  _p1, const P2 &  _p2, const P3 &  _p3, const P4 &  _p4, const P5 &  _p5, const P6 &  _p6, const P7 &  _p7, const P8 &  _p8, const P9 &  _p9, const P10 &  _p10  )

inline

Signal the event with ten parameters.

Parameters

[in]	_p1	the first parameter.
[in]	_p2	the second parameter.
[in]	_p3	the second parameter.
[in]	_p4	the first parameter.
[in]	_p5	the fifth parameter.
[in]	_p6	the sixth parameter.
[in]	_p7	the seventh parameter.
[in]	_p8	the eighth parameter.
[in]	_p9	the ninth parameter.
[in]	_p10	the tenth parameter.

void SetSignaled ( const bool  _sig )

inherited

Set whether this event has been signaled.

Parameters

[in]

_sig

True if the event has been signaled.

Referenced by EventT< void(bool)>::Signal().

void Signal ( )

inline

Signal the event for all subscribers.

Referenced by EventT< void(bool)>::operator()().

void Signal ( const P &  _p )

inline

Signal the event with one parameter.

Parameters

[in]

_p

parameter.

void Signal ( const P1 &  _p1, const P2 &  _p2  )

inline

Signal the event with two parameter.

Parameters

[in]	_p1	the first parameter.
[in]	_p2	the second parameter.

void Signal ( const P1 &  _p1, const P2 &  _p2, const P3 &  _p3  )

inline

Signal the event with three parameter.

Parameters

[in]	_p1	the first parameter.
[in]	_p2	the second parameter.
[in]	_p3	the second parameter.

void Signal ( const P1 &  _p1, const P2 &  _p2, const P3 &  _p3, const P4 &  _p4  )

inline

Signal the event with four parameter.

Parameters

[in]	_p1	the first parameter.
[in]	_p2	the second parameter.
[in]	_p3	the second parameter.
[in]	_p4	the first parameter.

void Signal ( const P1 &  _p1, const P2 &  _p2, const P3 &  _p3, const P4 &  _p4, const P5 &  _p5  )

inline

Signal the event with five parameter.

Parameters

[in]	_p1	the first parameter.
[in]	_p2	the second parameter.
[in]	_p3	the second parameter.
[in]	_p4	the first parameter.
[in]	_p5	the fifth parameter.

void Signal ( const P1 &  _p1, const P2 &  _p2, const P3 &  _p3, const P4 &  _p4, const P5 &  _p5, const P6 &  _p6  )

inline

Signal the event with six parameter.

Parameters

[in]	_p1	the first parameter.
[in]	_p2	the second parameter.
[in]	_p3	the second parameter.
[in]	_p4	the first parameter.
[in]	_p5	the fifth parameter.
[in]	_p6	the sixth parameter.

void Signal ( const P1 &  _p1, const P2 &  _p2, const P3 &  _p3, const P4 &  _p4, const P5 &  _p5, const P6 &  _p6, const P7 &  _p7  )

inline

Signal the event with seven parameter.

Parameters

[in]	_p1	the first parameter.
[in]	_p2	the second parameter.
[in]	_p3	the second parameter.
[in]	_p4	the first parameter.
[in]	_p5	the fifth parameter.
[in]	_p6	the sixth parameter.
[in]	_p7	the seventh parameter.

void Signal ( const P1 &  _p1, const P2 &  _p2, const P3 &  _p3, const P4 &  _p4, const P5 &  _p5, const P6 &  _p6, const P7 &  _p7, const P8 &  _p8  )

inline

Signal the event with eight parameter.

Parameters

[in]	_p1	the first parameter.
[in]	_p2	the second parameter.
[in]	_p3	the second parameter.
[in]	_p4	the first parameter.
[in]	_p5	the fifth parameter.
[in]	_p6	the sixth parameter.
[in]	_p7	the seventh parameter.
[in]	_p8	the eighth parameter.

void Signal ( const P1 &  _p1, const P2 &  _p2, const P3 &  _p3, const P4 &  _p4, const P5 &  _p5, const P6 &  _p6, const P7 &  _p7, const P8 &  _p8, const P9 &  _p9  )

inline

Signal the event with nine parameter.

Parameters

[in]	_p1	the first parameter.
[in]	_p2	the second parameter.
[in]	_p3	the second parameter.
[in]	_p4	the first parameter.
[in]	_p5	the fifth parameter.
[in]	_p6	the sixth parameter.
[in]	_p7	the seventh parameter.
[in]	_p8	the eighth parameter.
[in]	_p9	the ninth parameter.

void Signal ( const P1 &  _p1, const P2 &  _p2, const P3 &  _p3, const P4 &  _p4, const P5 &  _p5, const P6 &  _p6, const P7 &  _p7, const P8 &  _p8, const P9 &  _p9, const P10 &  _p10  )

inline

Signal the event with ten parameter.

Parameters

[in]	_p1	the first parameter.
[in]	_p2	the second parameter.
[in]	_p3	the second parameter.
[in]	_p4	the first parameter.
[in]	_p5	the fifth parameter.
[in]	_p6	the sixth parameter.
[in]	_p7	the seventh parameter.
[in]	_p8	the eighth parameter.
[in]	_p9	the ninth parameter.
[in]	_p10	the tenth parameter.

bool Signaled ( ) const

inherited

Get whether this event has been signaled.

Returns

True if the event has been signaled.

---

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

• Event.hh