Nymph  v1.5.2
Flow-Based Data Processing Framework
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
KTSignalOneArg< XSignalArgument > Class Template Reference

Creates a signal that takes a single argument. More...

#include <KTSignal.hh>

Inheritance diagram for KTSignalOneArg< XSignalArgument >:
Inheritance graph

Public Types

typedef void() signature(XSignalArgument)
 
typedef boost::signals2::signal< signatureboost_signal
 
typedef boost::signals2::signal< signature >::slot_type slot_type
 

Public Member Functions

 KTSignalOneArg ()
 
 KTSignalOneArg (const std::string &name, KTProcessor *proc)
 
virtual ~KTSignalOneArg ()
 
void operator() (XSignalArgument arg)
 
boost_signalSignal ()
 

Protected Member Functions

 KTSignalOneArg (const KTSignalOneArg &)
 

Protected Attributes

boost_signal fSignal
 

Detailed Description

template<class XSignalArgument>
class Nymph::KTSignalOneArg< XSignalArgument >

Creates a signal that takes a single argument.

Author
N. S. Oblath

The signal is emitted by calling operator(). If a KTDataSlot is being used, and the Slot has been given a pointer to this signal, the Slot will emit the Signal.

Usage: In your Processor's header add a member variable of type KTDataSignal< ArgumentType >.

Initialize the signal with the processor's 'this' pointer and the name of the signal.

To use the signal, call it as: fSignalObject(arg);

Definition at line 39 of file KTSignal.hh.

Member Typedef Documentation

◆ boost_signal

typedef boost::signals2::signal< signature > boost_signal

Definition at line 43 of file KTSignal.hh.

◆ signature

typedef void() signature(XSignalArgument)

Definition at line 42 of file KTSignal.hh.

◆ slot_type

typedef boost::signals2::signal< signature >::slot_type slot_type

Definition at line 44 of file KTSignal.hh.

Constructor & Destructor Documentation

◆ KTSignalOneArg() [1/3]

Definition at line 157 of file KTSignal.hh.

◆ KTSignalOneArg() [2/3]

KTSignalOneArg ( const std::string &  name,
KTProcessor proc 
)

Definition at line 150 of file KTSignal.hh.

◆ ~KTSignalOneArg()

~KTSignalOneArg ( )
virtual

Definition at line 167 of file KTSignal.hh.

◆ KTSignalOneArg() [3/3]

KTSignalOneArg ( const KTSignalOneArg< XSignalArgument > &  )
protected

Definition at line 162 of file KTSignal.hh.

Member Function Documentation

◆ operator()()

void operator() ( XSignalArgument  arg)
inline

Definition at line 172 of file KTSignal.hh.

◆ Signal()

KTSignalOneArg< XSignalArgument >::boost_signal * Signal ( )
inline

Definition at line 178 of file KTSignal.hh.

Member Data Documentation

◆ fSignal

boost_signal fSignal
protected

Definition at line 60 of file KTSignal.hh.


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