SetNotchFilterFrequency Method

Summary

Sets the notch filter frequency for the channel.

Syntax

C++

public bool SetNotchFilterFrequency( 
   bool include, 
   double notchFilterFrequency 
)

Public Function SetNotchFilterFrequency( _ 
   ByVal include As Boolean, _ 
   ByVal notchFilterFrequency As Double _ 
) As Boolean

public: 
bool SetNotchFilterFrequency(  
   bool include, 
   double notchFilterFrequency 
)

Parameters

include
true to insert the "Notch Filter Frequency" (003A,0222) element (that corresponds to this channel) into the dataset and then set its value, false to delete the "Notch Filter Frequency" (003A,0222) element (that corresponds to this channel) from the dataset.

notchFilterFrequency
New notch filter frequency.

Return Value

true if the notch filter frequency was set successfully, false if an error occurred.

Remarks

This method sets the value of the "Notch Filter Frequency" (003A,0222) element that corresponds to this channel. Set include to true to force the method to insert the element if it does not already exist in the dataset.
This method can also be used to delete the "Notch Filter Frequency" (003A,0222) element that corresponds to this channel by setting include to false. In this case the notchFilterFrequency parameter is ignored.

Example

For an example, refer to WaveformGroupCount.

Requirements

Target Platforms