C_TranslateDiffractionOutput

Call C_TranslateDiffractionOutput to translate the results of a diffraction calculation to specified reporting origins. After calling this function, the results are expressed with respect to axes through the specified reporting origins and parallel to the body axes.

In order to translate diffraction results, you must first call C_GetDiffractionOutput to obtain results, and then subsequently call C_TranslateDiffractionOutput to translate these results.

void C_TranslateDiffractionOutput(

TOrcFxAPIHandle DiffractionHandle,

int OutputType,

int OutputSize,

void *lpOutput,

const TVector *lpReportingOrigins,

int *lpStatus

);

Parameters

DiffractionHandle (IN)

The diffraction handle returned by C_CreateDiffraction.

OutputType (IN)

Specifies the type of output which is being translated. This must be the same value that was passed to C_GetDiffractionOutput.

Only the following output types are supported for translation:

OutputSize (IN)

The size of the output, as returned by the call to C_GetDiffractionOutput.

lpOutput (IN/OUT)

Pointer to the output buffer which was populated by the call to C_GetDiffractionOutput.

lpReportingOrigins (IN)

An array of reporting origins. The length of the array must equal the number of included bodies, Nb.

Each reporting origin should be given in the body coordinates of the corresponding body. After the translation, the results are with respect to axes through the specified reporting origins and parallel to the body axes.

lpStatus (OUT)

Points to a variable in which the status result for the function call will be returned.

See also

C_GetDiffractionOutput.