SChannelSplitterI Class Reference

Splits waveform channels and resends them separately. More...

#include <bsapi.h>

Inheritance diagram for SChannelSplitterI:

List of all members.

Public Member Functions
virtual void BSAPI_METHOD	SetTarget (SWaveformSourceCallbackI *pTarget)=0
	Set target object.
virtual bool BSAPI_METHOD	SetPerChannelTarget (int channel, SWaveformSourceCallbackI *pTarget)=0
	Set channel specific target object.
virtual void BSAPI_METHOD	SetNChannels (int nChannels=1)=0
	Set default number of channels.
virtual int BSAPI_METHOD	GetActualChannel ()=0
	Get actual channel index.
virtual int BSAPI_METHOD	GetActualNChannels ()=0
	Get actual number of channels.

---

Detailed Description

Splits waveform channels and resends them separately.

---

Member Function Documentation

virtual int BSAPI_METHOD SChannelSplitterI::GetActualChannel

(

)

[pure virtual]

Get actual channel index.

In case that a single target is used this function serves to distinguish which channel was sent to its OnWaveform function.

Returns:

zero-based channel index

See also:

SetTarget()

virtual int BSAPI_METHOD SChannelSplitterI::GetActualNChannels

(

)

[pure virtual]

Get actual number of channels.

This function is useful for target objects in order to get the number of channels initially sent to the channel splitter.

Returns:

actual number of channels

virtual void BSAPI_METHOD SChannelSplitterI::SetNChannels

(

int

nChannels = 1

)

[pure virtual]

Set default number of channels.

Number of channels in input waveform is primarily recognized by parameter of OnWaveform function. In case that this parameter is WF_UNK_NCHANNELS (unknown number of channels) default number of channels set by this function is used instead.

Parameters:

nChannels

default number of channels

virtual bool BSAPI_METHOD SChannelSplitterI::SetPerChannelTarget	(	int	channel,
		SWaveformSourceCallbackI *	pTarget
	)			[pure virtual]

Set channel specific target object.

Target object receives output (splitted) waveform of desired channel.

Parameters:

	channel	zero-based channel index
	pTarget	pointer to target object

Returns:

true target was set correctly

See also:

SetTarget()

virtual void BSAPI_METHOD SChannelSplitterI::SetTarget

(

SWaveformSourceCallbackI *

pTarget

)

[pure virtual]

Set target object.

Target object receives output (splitted) waveforms. Which waveform belongs to which channel can be distinguished by GetActualChannel function.

Parameters:

pTarget

pointer to target object

See also:

GetActualChannel()

SetPerChannelTarget()

---

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

• bsapi.h

---