Class StimParamsBasicExtensions

Convenience extension methods over IStimParamsCore that forward to the optional BASIC layer (IBasicStimulation).

Inheritance

object

StimParamsBasicExtensions

Namespace: Wss.CoreModule

Assembly: WSS_Core_Interface.dll

Syntax

public static class StimParamsBasicExtensions

Methods

LoadBoard(IStimParamsCore, WssTarget)

Forward to BASIC.Load(...).

Declaration

public static void LoadBoard(this IStimParamsCore s, WssTarget t)

Parameters

Type	Name	Description
IStimParamsCore	s
WssTarget	t

LoadWaveform(IStimParamsCore, string, int)

Forward to BASIC.LoadWaveform(...).

Declaration

public static void LoadWaveform(this IStimParamsCore s, string fileName, int eventId)

Parameters

Type	Name	Description
IStimParamsCore	s
string	fileName
int	eventId

RequestConfigs(IStimParamsCore, int, int, WssTarget)

Forward to BASIC.Request_Configs(...).

Declaration

public static void RequestConfigs(this IStimParamsCore s, int command, int id, WssTarget t)

Parameters

Type	Name	Description
IStimParamsCore	s
int	command
int	id
WssTarget	t

SaveBoard(IStimParamsCore, WssTarget)

Forward to BASIC.Save(...).

Declaration

public static void SaveBoard(this IStimParamsCore s, WssTarget t)

Parameters

Type	Name	Description
IStimParamsCore	s
WssTarget	t

TryUpdateWaveform(IStimParamsCore, WaveformBuilder, int, WssTarget)

Attempts to forward to BASIC.UpdateWaveform(WaveformBuilder,...) without throwing.

Declaration

public static bool TryUpdateWaveform(this IStimParamsCore s, WaveformBuilder wf, int eventId, WssTarget t)

Parameters

Type	Name	Description
IStimParamsCore	s	Stimulation params core instance.
WaveformBuilder	wf	Waveform builder to upload.
int	eventId	Event ID to associate with the waveform.
WssTarget	t	Target device.

Returns

Type	Description
bool	true if BASIC is available and the call succeeded; otherwise false.

UpdateEventShape(IStimParamsCore, int, int, int, WssTarget)

Forward to BASIC.UpdateEventShape(...).

Declaration

public static void UpdateEventShape(this IStimParamsCore s, int cathodicWaveform, int anodicWaveform, int eventId, WssTarget t)

Parameters

Type	Name	Description
IStimParamsCore	s
int	cathodicWaveform
int	anodicWaveform
int	eventId
WssTarget	t

UpdateWaveform(IStimParamsCore, int[], int, WssTarget)

Forward to BASIC.UpdateWaveform(int[],...).

Declaration

public static void UpdateWaveform(this IStimParamsCore s, int[] waveform, int eventId, WssTarget t)

Parameters

Type	Name	Description
IStimParamsCore	s
int[]	waveform
int	eventId
WssTarget	t

UpdateWaveform(IStimParamsCore, WaveformBuilder, int, WssTarget)

Forward to BASIC.UpdateWaveform(WaveformBuilder,...).

Declaration

public static void UpdateWaveform(this IStimParamsCore s, WaveformBuilder wf, int eventId, WssTarget t)

Parameters

Type	Name	Description
IStimParamsCore	s
WaveformBuilder	wf
int	eventId
WssTarget	t

WaveformSetup(IStimParamsCore, WaveformBuilder, int, WssTarget)

Forward to BASIC.WaveformSetup(...).

Declaration

public static void WaveformSetup(this IStimParamsCore s, WaveformBuilder wf, int eventId, WssTarget t)

Parameters

Type	Name	Description
IStimParamsCore	s
WaveformBuilder	wf
int	eventId
WssTarget	t