Sets the Relative Phase and Relative Amplitude values for the non reference antennas An (1<n<=256) relative to the reference antenna A0 when you set the NIBTSG_ATTR_DIRECTION_FINDING_ANTENNA_SWITCHING_ENABLED attribute to NIBTSG_VAL_TRUE. The reference period and sampling slots in the constant tone extension (CTE) field are modulated in amplitude and phase as specified in the NIBTSG_ATTR_DIRECTION_FINDING_ANTENNA_SWITCHING_PATTERN attribute.

Syntax

int32 __stdcall niBTSG_SetAntennaRelativePhaseAndAmplitude(niBTSGSession session, ViChar channelString, float64 relativeAmplitudeDb, float64 relativePhaseDeg, int32 arraySize)

Parameters

NameDirectionTypeDescription
session[out]niBTSGSession

Specifies the niBT SG session. Use this parameter to configure the behavior and operation of the appropriate RFmx BT Generation function that accepts the niBTSGSession as an input.

channelString[out]ViChar

Specifies the RFSG device channel. Set this parameter to "" (empty string) or NULL.

relativeAmplitudeDb[out]float64

Specifies the array of amplitudes of each non-reference antenna An (1<n<=256) relative to the reference antenna A0. The first element of the array corresponds to the amplitude of antenna A1, the second element of the array corresponds to amplitude of antenna A2, and so on.

relativePhaseDeg[out]float64

Specifies the array of phases of each non-reference antenna An (1<n<=256) relative to the reference antenna A0. The first element of the array corresponds to the phase of antenna A1, the second element of the array corresponds to phase of antenna A2, and so on.

arraySize[in]int32

Specifies the size of the array.

Returns

Returns the status code of this operation. The status code either indicates success or describes an error or warning. Examine the status code from each call to an niBT SG function to determine if an error has occurred. To obtain a text description of the status code and additional information about the error condition, call the niBTSG_GetErrorString function. The general meaning of the status code is as follows:

Value

Meaning

0

Success

Positive Values

Warnings

Negative Values

Errors