10.06.2016 Views

eldo_user

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

Eldo Control Language<br />

Library of Functions for Tasks<br />

wcreate_wave<br />

Task function category: Functions Creating New Waveforms<br />

Creates a new waveform inside the specified .wdb file, and returns a waveform variable to, for<br />

example, call post-processing functions on it.<br />

Usage<br />

wcreate_wave(wdbId, "wave_name", "folder", [[x_values], y_values])<br />

wcreate_wave(wdbId, "wave_name", "folder", [[x_values], y_values],<br />

"x_data_type")<br />

wcreate_wave(wdbId, "wave_name", "folder", [[x_values], y_values],<br />

"x_data_type", "y_data_type")<br />

wcreate_wave(wdbId, "wave_name", "folder", [[x_values], y_values],<br />

"x_data_type", "y_data_type", "options")<br />

wcreate_wave(wdbId, "wave_name", "folder", [[x_values], y_values],<br />

"x_data_type", "y_data_type", "options", x_scale)<br />

wcreate_wave(wdbId, "wave_name", "folder", [[x_values], y_values],<br />

"x_data_type", "y_data_type", "options", x_scale, y_scale)<br />

Arguments<br />

• wdbId<br />

Identifier of the .wdb file where to create the waveform. It can be wstdout to create the<br />

waveform inside the main .wdb file, or any identifier of a .wdb file created with wopen in<br />

write mode.<br />

• "wave_name"<br />

Name to assign to the new waveform (no waveform with the same name must already exist<br />

in the folder where the wave will be created).<br />

• "folder"<br />

Path to the folder where the waveform will be created. If it does not exist, it will be created.<br />

The path may be hierarchical.<br />

• x_values<br />

Vector containing the x-values of the points to plot. If this argument is omitted and y_values<br />

are specified, then the indexes of the y-values in the vector y_values are taken as x-values.<br />

The values of x_values have to be ordered.<br />

• y_values<br />

Vector containing the y-values of the points to plot. If this argument and x_values are<br />

omitted then the waveform will be created empty and its content can be specified later using<br />

the wset_values function.<br />

This vector can contain complex values if the data type of the y-axis is set to "complex".<br />

Eldo® User's Manual, 15.3 987

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!