Allows to call multiple OnWaveform callback functions as one callback call. More...
#include <bsapi.h>
Inheritance diagram for SWaveformSplitterI:
Public Member Functions | |
| virtual bool BSAPI_METHOD | SetTarget (int index, SWaveformSourceCallbackI *pTarget)=0 |
| Set target handlers. | |
| virtual bool BSAPI_METHOD | AddTarget (SWaveformSourceCallbackI *pTarget)=0 |
| Add target handler. | |
Detailed Description
Allows to call multiple OnWaveform callback functions as one callback call.
This class maintains an array of waveform target handlers (instances of classes that implement the SWaveformSourceCallbackI interface) and when the OnWaveform function is called, the call is routed to all handlers. This allows to connect multiple targets to all classes that send waveform.
Member Function Documentation
| virtual bool BSAPI_METHOD SWaveformSplitterI::AddTarget | ( | SWaveformSourceCallbackI * | pTarget | ) | [pure virtual] |
Add target handler.
Add a new target handler at the end of the target array.
- Parameters:
-
pTarget pointer to waveform handler.
- Returns:
- true if there is no memory allocation error
- See also:
- SetTarget()
| virtual bool BSAPI_METHOD SWaveformSplitterI::SetTarget | ( | int | index, |
| SWaveformSourceCallbackI * | pTarget | ||
| ) | [pure virtual] |
Set target handlers.
Set target handlers. Each handler is characterized by its own index. Each handler can be disabled by calling this function with corresponding index and zero pointer.
- Parameters:
-
index index that the programmer assigns to the handler. It is not necessary to use full series, but it is recommended to start with 0 and not to skip many values. It can slow down the run. pTarget pointer to waveform handler.
- Returns:
- true if there is no memory allocation error
- See also:
- AddTarget()
The documentation for this class was generated from the following file:
