55.12 UserAmplitude object

The UserAmplitude object defines an amplitude curve using the UAMP or VUAMP user subroutine.

The UserAmplitude object is derived from the Amplitude object.

Access

amplitudeApi.amplitudes()[name]

This method creates a UserAmplitude object.

Path

amplitudeApi.UserAmplitude

Prototype

odb_UserAmplitude&
UserAmplitude(const odb_String& name,
              int numVariables,
              const odb_String& timeSpan);

Required arguments

name

An odb_String specifying the repository key.

numVariables

An Int specifying the number of variables for the UAMP or VUAMP user subroutine.

Optional argument

timeSpan

An odb_String specifying the time span of the amplitude. Possible values are "STEP" and "TOTAL". The default value is "STEP".

Return value

A UserAmplitude object.

Exceptions

InvalidNameError and RangeError.

This method modifies the UserAmplitude object.

Required arguments

None.

Optional arguments

The optional arguments to setValues are the same as the arguments to the UserAmplitude method, except for the name argument.

Return value

None

Exceptions

RangeError.

The UserAmplitude object has members with the same names and descriptions as the arguments to the UserAmplitude method.