C_GetRangeGraph4

In many circumstances you will not wish to use all the parameters of this procedure. For instance you may be interested only in knowing the maximum value of a variable over the length of a line. In this case you can pass NULL for the parameters you wish to ignore. For example the function might be called as such:

C_GetRangeGraph4(ObjectHandle, NULL, &Period, NULL, VarID, NULL, NULL, MaxValues, NULL, NULL, NULL, NULL, &Status);

Note that for some variables not all the parameters are meaningful. For instance a clearance range graph only has one curve, the minimum. In this case, if you use the other parameters, then the blocks of memory will be filled with zeros.

If the model uses the frequency domain dynamics solution method, and the period is pnSpecifiedPeriod, then the output is based on synthesised time histories.

void C_GetRangeGraph4(

TOrcFxAPIHandle ObjectHandle,

const TObjectExtra2 *lpObjectExtra,

const TPeriod *lpPeriod,

const TArclengthRange *lpArclengthRange,

int VarID,

double *lpXValues,

double *lpMinValues,

double *lpMaxValues,

double *lpMeanValues,

double *lpStdDevValues,

double *lpUpperValues,

double *lpLowerValues,

int *lpStatus

);

Parameters

ObjectHandle (IN)

The handle of the object for which you want range graph results. This must be the handle of a line or turbine.

lpObjectExtra (IN)

If you do want clearance results to be reported as clearances from a specified line then you must set the ClearanceLineName member of lpObjectExtra. Note that the other members which specify a particular point on the line or turbine blade are ignored and do not need to be set. This is because a range graph gives results for all points on the line or turbine blade.

If you are asking for component stress results then you need to specify the RadialPos and Theta members of lpObjectExtra. Note that the other members which specify a particular point on the line or turbine blade are ignored and do not need to be set. This is because a range graph gives results for all points on the line or turbine blade.

If the object is a turbine, then you need to specify the BladeIndex member of lpObjectExtra. Note that the other members which specify a particular point on the blade are ignored and do not need to be set. This is because a range graph gives results for all points on the blade.

lpPeriod (IN)

Points to a TPeriod variable which specifies the period of the simulation over which results are to be extracted.

lpArclengthRange (IN)

Points to a TArclengthRange variable which specifies the arclength ranges for which results are to be extracted. If NULL is passed then results will be extracted for the entire line or turbine blade.

VarID (IN)

Specifies the OrcaFlex variable for which the range graph results are requested. Call C_GetVarID to obtain a VarID from a variable name.

lpXValues (OUT)

Points to an array of double of length N, where N is the number of points in the range graph – obtained by calling C_GetRangeGraphNumOfPoints3. The function populates the array with the arclength values for the range graph.

lpMinValues (OUT)

Points to an array of double of length N, where N is the number of points in the range graph. The function populates the array with the values of the Minimum curve of the range graph.

lpMaxValues (OUT)

Points to an array of double of length N, where N is the number of points in the range graph. The function populates the array with the values of the Maximum curve of the range graph.

lpMeanValues (OUT)

Points to an array of double of length N, where N is the number of points in the range graph. The function populates the array with the values of the Mean curve of the range graph.

lpStdDevValues (OUT)

Points to an array of double of length N, where N is the number of points in the range graph. The function populates the array with the values of the Standard Deviation curve of the range graph.

lpUpperValues (OUT)

Points to an array of double of length N, where N is the number of points in the range graph. The function populates the array with the values of the Upper Bound curve of the range graph.

lpLowerValues (OUT)

Points to an array of double of length N, where N is the number of points in the range graph. The function populates the array with the values of the Lower Bound curve of the range graph.

lpStatus (OUT)

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

Unicode and ANSI

The Unicode function name is C_GetRangeGraph4W and the ANSI function name is C_GetRangeGraph4A, see Unicode.