EventT< T > Class Template Reference

A class for event processing. More...

#include <Event.hh>

Inherits Event.

Public Member Functions

 EventT ()
 Constructor.
 
virtual ~EventT ()
 Destructor.
 
ConnectionPtr Connect (const std::function< T > &_subscriber)
 Connect a callback to this event.
 
unsigned int ConnectionCount () const
 Get the number of connections.
 
virtual void Disconnect (int _id)
 Disconnect a callback to this event.
 
void operator() ()
 Access the signal.
 
template<typename P >
void operator() (const P &_p)
 Signal the event with one parameter.
 
template<typename P1 , typename P2 >
void operator() (const P1 &_p1, const P2 &_p2)
 Signal the event with two parameters.
 
template<typename P1 , typename P2 , typename P3 >
void operator() (const P1 &_p1, const P2 &_p2, const P3 &_p3)
 Signal the event with three parameters.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
void SetSignaled (const bool _sig)
 Set whether this event has been signaled.
 
void Signal ()
 Signal the event for all subscribers.
 
template<typename P >
void Signal (const P &_p)
 Signal the event with one parameter.
 
template<typename P1 , typename P2 >
void Signal (const P1 &_p1, const P2 &_p2)
 Signal the event with two parameter.
 
template<typename P1 , typename P2 , typename P3 >
void Signal (const P1 &_p1, const P2 &_p2, const P3 &_p3)
 Signal the event with three parameter.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
bool Signaled () const
 Get whether this event has been signaled.
 

Detailed Description

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

A class for event processing.

Member Function Documentation

◆ operator()() [1/11]

template<typename T >
void operator() ( )
inline

Access the signal.

References EventT< T >::Signal().

◆ operator()() [2/11]

template<typename T >
template<typename P >
void operator() ( const P & _p)
inline

Signal the event with one parameter.

Parameters
[in]_pthe parameter.

References EventT< T >::Signal().

◆ operator()() [3/11]

template<typename T >
template<typename P1 , typename P2 >
void operator() ( const P1 & _p1,
const P2 & _p2 )
inline

Signal the event with two parameters.

Parameters
[in]_p1the first parameter.
[in]_p2the second parameter.

References EventT< T >::Signal().

◆ operator()() [4/11]

template<typename T >
template<typename P1 , typename P2 , typename P3 >
void operator() ( const P1 & _p1,
const P2 & _p2,
const P3 & _p3 )
inline

Signal the event with three parameters.

Parameters
[in]_p1the first parameter.
[in]_p2the second parameter.
[in]_p3the second parameter.

References EventT< T >::Signal().

◆ operator()() [5/11]

template<typename T >
template<typename P1 , typename P2 , typename P3 , typename P4 >
void operator() ( const P1 & _p1,
const P2 & _p2,
const P3 & _p3,
const P4 & _p4 )
inline

Signal the event with four parameters.

Parameters
[in]_p1the first parameter.
[in]_p2the second parameter.
[in]_p3the second parameter.
[in]_p4the first parameter.

References EventT< T >::Signal().

◆ operator()() [6/11]

template<typename T >
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 )
inline

Signal the event with five parameters.

Parameters
[in]_p1the first parameter.
[in]_p2the second parameter.
[in]_p3the second parameter.
[in]_p4the first parameter.
[in]_p5the fift parameter.

References EventT< T >::Signal().

◆ operator()() [7/11]

template<typename T >
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 )
inline

Signal the event with six parameters.

Parameters
[in]_p1the first parameter.
[in]_p2the second parameter.
[in]_p3the second parameter.
[in]_p4the first parameter.
[in]_p5the fift parameter.
[in]_p6the sixt parameter.

References EventT< T >::Signal().

◆ operator()() [8/11]

template<typename T >
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 )
inline

Signal the event with seven parameters.

Parameters
[in]_p1the first parameter.
[in]_p2the second parameter.
[in]_p3the second parameter.
[in]_p4the first parameter.
[in]_p5the fifth parameter.
[in]_p6the sixth parameter.
[in]_p7the seventh parameter.

References EventT< T >::Signal().

◆ operator()() [9/11]

template<typename T >
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 )
inline

Signal the event with eight parameters.

Parameters
[in]_p1the first parameter.
[in]_p2the second parameter.
[in]_p3the second parameter.
[in]_p4the first parameter.
[in]_p5the fifth parameter.
[in]_p6the sixth parameter.
[in]_p7the seventh parameter.
[in]_p8the eighth parameter.

References EventT< T >::Signal().

◆ operator()() [10/11]

template<typename T >
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 )
inline

Signal the event with nine parameters.

Parameters
[in]_p1the first parameter.
[in]_p2the second parameter.
[in]_p3the second parameter.
[in]_p4the first parameter.
[in]_p5the fifth parameter.
[in]_p6the sixth parameter.
[in]_p7the seventh parameter.
[in]_p8the eighth parameter.
[in]_p9the ninth parameter.

References EventT< T >::Signal().

◆ operator()() [11/11]

template<typename T >
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 )
inline

Signal the event with ten parameters.

Parameters
[in]_p1the first parameter.
[in]_p2the second parameter.
[in]_p3the second parameter.
[in]_p4the first parameter.
[in]_p5the fifth parameter.
[in]_p6the sixth parameter.
[in]_p7the seventh parameter.
[in]_p8the eighth parameter.
[in]_p9the ninth parameter.
[in]_p10the tenth parameter.

References EventT< T >::Signal().

◆ SetSignaled()

void SetSignaled ( const bool _sig)
inherited

◆ Signal() [1/11]

◆ Signal() [2/11]

template<typename T >
template<typename P >
void Signal ( const P & _p)
inline

Signal the event with one parameter.

Parameters
[in]_pparameter.

References Event::SetSignaled().

◆ Signal() [3/11]

template<typename T >
template<typename P1 , typename P2 >
void Signal ( const P1 & _p1,
const P2 & _p2 )
inline

Signal the event with two parameter.

Parameters
[in]_p1the first parameter.
[in]_p2the second parameter.

References Event::SetSignaled().

◆ Signal() [4/11]

template<typename T >
template<typename P1 , typename P2 , typename P3 >
void Signal ( const P1 & _p1,
const P2 & _p2,
const P3 & _p3 )
inline

Signal the event with three parameter.

Parameters
[in]_p1the first parameter.
[in]_p2the second parameter.
[in]_p3the second parameter.

References Event::SetSignaled().

◆ Signal() [5/11]

template<typename T >
template<typename P1 , typename P2 , typename P3 , typename P4 >
void Signal ( const P1 & _p1,
const P2 & _p2,
const P3 & _p3,
const P4 & _p4 )
inline

Signal the event with four parameter.

Parameters
[in]_p1the first parameter.
[in]_p2the second parameter.
[in]_p3the second parameter.
[in]_p4the first parameter.

References Event::SetSignaled().

◆ Signal() [6/11]

template<typename T >
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 )
inline

Signal the event with five parameter.

Parameters
[in]_p1the first parameter.
[in]_p2the second parameter.
[in]_p3the second parameter.
[in]_p4the first parameter.
[in]_p5the fifth parameter.

References Event::SetSignaled().

◆ Signal() [7/11]

template<typename T >
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 )
inline

Signal the event with six parameter.

Parameters
[in]_p1the first parameter.
[in]_p2the second parameter.
[in]_p3the second parameter.
[in]_p4the first parameter.
[in]_p5the fifth parameter.
[in]_p6the sixth parameter.

References Event::SetSignaled().

◆ Signal() [8/11]

template<typename T >
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 )
inline

Signal the event with seven parameter.

Parameters
[in]_p1the first parameter.
[in]_p2the second parameter.
[in]_p3the second parameter.
[in]_p4the first parameter.
[in]_p5the fifth parameter.
[in]_p6the sixth parameter.
[in]_p7the seventh parameter.

References Event::SetSignaled().

◆ Signal() [9/11]

template<typename T >
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 )
inline

Signal the event with eight parameter.

Parameters
[in]_p1the first parameter.
[in]_p2the second parameter.
[in]_p3the second parameter.
[in]_p4the first parameter.
[in]_p5the fifth parameter.
[in]_p6the sixth parameter.
[in]_p7the seventh parameter.
[in]_p8the eighth parameter.

References Event::SetSignaled().

◆ Signal() [10/11]

template<typename T >
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 )
inline

Signal the event with nine parameter.

Parameters
[in]_p1the first parameter.
[in]_p2the second parameter.
[in]_p3the second parameter.
[in]_p4the first parameter.
[in]_p5the fifth parameter.
[in]_p6the sixth parameter.
[in]_p7the seventh parameter.
[in]_p8the eighth parameter.
[in]_p9the ninth parameter.

References Event::SetSignaled().

◆ Signal() [11/11]

template<typename T >
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 )
inline

Signal the event with ten parameter.

Parameters
[in]_p1the first parameter.
[in]_p2the second parameter.
[in]_p3the second parameter.
[in]_p4the first parameter.
[in]_p5the fifth parameter.
[in]_p6the sixth parameter.
[in]_p7the seventh parameter.
[in]_p8the eighth parameter.
[in]_p9the ninth parameter.
[in]_p10the tenth parameter.

References Event::SetSignaled().

◆ Signaled()

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: