The PeriodicAmplitude object defines an amplitude curve using a Fourier series.
The PeriodicAmplitude object is derived from the Amplitude object.
amplitudeApi.amplitudes()[name]
This method creates a PeriodicAmplitude object.
amplitudeApi.PeriodicAmplitude
odb_PeriodicAmplitude& PeriodicAmplitude(const odb_String& name, double frequency, double start, double a_0, const odb_SequenceSequenceDouble& data, const odb_String& timeSpan);
Required arguments
An odb_String specifying the repository key.
A Double specifying the circular frequency
. Possible values are positive numbers.
A Double specifying the starting time
. Possible values are positive numbers.
A Double specifying the constant
.
An odb_SequenceSequenceDouble specifying
and
pairs.
Optional argument
An odb_String specifying the time span of the amplitude. Possible values are "STEP" and "TOTAL". The default value is "STEP".
Return value
A PeriodicAmplitude object.
Exceptions
InvalidNameError and RangeError.
This method modifies the PeriodicAmplitude object.
Required arguments
Optional arguments
The optional arguments to setValues are the same as the arguments to the PeriodicAmplitude method, except for the name argument.
Return value
Exceptions
RangeError.
The PeriodicAmplitude object has members with the same names and descriptions as the arguments to the PeriodicAmplitude method.