C_GetFrequencyDomainSpectralResponseGraphFromProcess

Call C_GetFrequencyDomainSpectralResponseGraphFromProcess to extract spectral response results from a process. The model must use the frequency domain dynamics solution method and be in the simulation complete state.

void C_GetFrequencyDomainSpectralResponseGraphFromProcess(

TOrcFxAPIHandle ModelHandle,

int ComponentCount,

const TComplex *lpProcess,

int *lpNumOfGraphPoints,

TGraphCurve *lpGraph,

int *lpStatus

);

Parameters

ModelHandle (IN)

The handle of the model.

ComponentCount (IN)

The number of components.

lpProcess (IN)

The process, an array of complex numbers of length ComponentCount.

lpNumOfGraphPoints (OUT)

Points to a variable in which the total number of graph points is returned.

lpGraph (OUT)

Points to a structure in which the spectral response graph will be returned.

The X values for the curve are returned in the block of memory pointed to by the lpX member. Similarly the Y values for the curve are returned in lpY.

It is the caller's responsibility to allocate (and deallocate) the memory pointed to by lpX and lpY. To find out how much memory to allocate call C_GetFrequencyDomainSpectralResponseGraphFromProcess passing NULL as the lpGraph parameter and use the value returned in lpNumOfGraphPoints to determine how much memory to allocate. Both lpX and lpY must point to arrays of length *lpNumOfGraphPoints.

lpStatus (OUT)

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

See also

C_GetFrequencyDomainResults, C_GetFrequencyDomainResultsProcess, C_GetFrequencyDomainResultsFromProcess, C_GetFrequencyDomainSpectralDensityGraphFromProcess.