Method: AddWaveformProperties for Channel <DataPlugin>
- Updated2024-09-12
- 2 minute(s) read
DataPlugin > Methods > Method: AddWaveformProperties for Channel <DataPlugin>
Method: AddWaveformProperties for Channel <DataPlugin>
Adds waveform properties to the channel to create a waveform channel.
Waveform channels contain the x-part and the y-part of a curve in a channel. The y-part contains the (measurement) values. The x-part might be the measured time. The Waveform properties specify the x-part that is a linear specification with a start value and a step width.
Object.AddWaveformProperties(Increment, StartOffset, [XChannelName], [XChannelUnit], [StartTime], [TimePreference], [NumberOfSamples])
| Object | Channel <DataPlugin> Object with this method | ||||||
| Increment | Double Specifies the step width of the x-part of the waveform channel. | ||||||
| StartOffset | Double Specifies the offset of the x-part of the waveform channel. | ||||||
| [XChannelName] | String Specifies the name of the x-part of the waveform channel. The default channel name is Time. | ||||||
| [XChannelUnit] | String Specifies the unit of the x-part of the waveform channel. The default unit is s. | ||||||
| [StartTime] | UsiTimeDisp Specifies the start time of the x-part of the waveform channel. | ||||||
| [TimePreference] | Enumeration with the following selection terms:
| ||||||
| [NumberOfSamples] | LongInteger Specifies the block size of the values of the waveform channel. The default value is 1. |
The following example generates the MyChannel channel in the Measurements channel group and then adds waveform properties to this channel.
Dim oMyGrp : Set oMyGrp = Root.ChannelGroups.Add("Measurements") Dim oMyChn : Set oMyChn = oMyGrp.Channels.Add("MyChannel",eR32) Dim i For i = 1 to 100 oMyChn.Values(i) = cdbl(i/100000) Next Call oMyChn.AddWaveformProperties(1, 0, "Time", "s")