Skip to content

NI RFmx LTE Build String Functions

Dane Stull edited this page Feb 28, 2022 · 2 revisions

Build String Functions

RFmxLTE_BuildSignalString

int32 __stdcall RFmxLTE_BuildSignalString (char signalName[], char resultName[], int32 selectorStringLength, char selectorString[]);

Purpose

Creates selector string for use with configuration or fetch attributes and functions.

Parameters

Input
Name Type Description
signalName char[] Specifies the signal name for building the selector string. This input accepts the signal name with or without the "signal::" prefix.
Example:
"signal::sig1"
"sig1"
resultName char[] Specifies the result name for building the selector string. This input accepts the result name with or without the "result::" prefix.
Example:
"result::r1"
"r1"
selectorStringLength int32 Specifies the length of the selector string. Set this parameter to 0 to get the minimum buffer size required to build the selector string.
selectorString char[] Returns the selector string.

Return Value

Name Type Description
statusOrRequiredSize int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

When the statusOrRequiredSize return value returns the buffer size, the status code is not returned.

To obtain a text description of the status code and additional information about the error condition, call the RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_BuildSubblockString

int32 __stdcall RFmxLTE_BuildSubblockString (char selectorString[], int32 subblockNumber, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates the subblock string to use as the selector string with the subblock configuration or fetch attributes and functions.

Parameters

Input
Name Type Description
selectorString char[] Specifies a selector string) comprising of the signal name and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxLTE_BuildSignalString) function to build the selector string.
subblockNumber int32 Specifies the number of subblocks that are configured in the intra-band noncontiguous carrier aggregation. Set this parameter to 1, which is the default, for single carrier and intra-band contiguous carrier aggregation.
selectorStringOutLength int32 Specifies the length of the string that is returned by the selectorStringOut parameter. To get the minimum buffer size required to build the selector string, set the selectorStringOutLength parameter to 0.
Output
Name Type Description
selectorStringOut char[] Returns the selector string created by this function.

Return Value

Name Type Description
statusOrRequiredSize int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

When the statusOrRequiredSize return value returns the buffer size, the status code is not returned.

To obtain a text description of the status code and additional information about the error condition, call the RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_BuildCarrierString

int32 __stdcall RFmxLTE_BuildCarrierString (char selectorString[], int32 carrierNumber, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates the carrier string to use as the selector string with the SEM and ACP carrier configuration or fetch attributes and functions.

Parameters

Input
Name Type Description
selectorString char[] Specifies a selector string) comprising of the signal name and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxLTE_BuildSignalString) function to build the selector string.
carrierNumber int32 Specifies the carrier number for building the selector string.
selectorStringOutLength int32 Specifies the length of the string that is returned by the selectorStringOut parameter. To get the minimum buffer size required to build the selector string, set the selectorStringOutLength parameter to 0.
Output
Name Type Description
selectorStringOut char[] Returns the selector string created by this function.

Return Value

Name Type Description
statusOrRequiredSize int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

When the statusOrRequiredSize return value returns the buffer size, the status code is not returned.

To obtain a text description of the status code and additional information about the error condition, call the RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_BuildOffsetString

int32 __stdcall RFmxLTE_BuildOffsetString (char selectorString[], int32 offsetNumber, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates the offset string to use as the selector string with SEM and ACP offset configuration or fetch attributes and functions.

Parameters

Input
Name Type Description
selectorString char[] Specifies a selector string) comprising of the signal name and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxLTE_BuildSignalString) function to build the selector string.
offsetNumber int32 Specifies the offset number for building the selector string.
selectorStringOutLength int32 Specifies the length of the string that is returned by the selectorStringOut parameter. To get the minimum buffer size required to build the selector string, set the selectorStringOutLength parameter to 0.
Output
Name Type Description
selectorStringOut char[] Returns the selector string created by this function.

Return Value

Name Type Description
statusOrRequiredSize int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

When the statusOrRequiredSize return value returns the buffer size, the status code is not returned.

To obtain a text description of the status code and additional information about the error condition, call the RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_BuildClusterString

int32 __stdcall RFmxLTE_BuildClusterString (char selectorString[], int32 clusterNumber, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates a cluster string to use as the selector string with the ModAcc cluster configuration or the fetch attributes and functions.

Parameters

Input
Name Type Description
selectorString char[] Specifies a selector string) comprising of the signal name and the result name. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"signal::sig1"
"result::r1"
"signal::sig1/result::r1"
You can use the RFmxLTE_BuildSignalString) function to build the selector string.
clusterNumber int32 Specifies the cluster number.
selectorStringOutLength int32 Specifies the length of the string that is returned by the selectorStringOut parameter. To get the minimum buffer size required to build the selector string, set the selectorStringOutLength parameter to 0.
Output
Name Type Description
selectorStringOut char[] Returns the selector string created by this function.

Return Value

Name Type Description
statusOrRequiredSize int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

When the statusOrRequiredSize return value returns the buffer size, the status code is not returned.

To obtain a text description of the status code and additional information about the error condition, call the RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_BuildSubframeString

int32 __stdcall RFmxLTE_BuildSubframeString (char selectorString[], int32 subframeNumber, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates the subframe string to use as the selector string with the configuration or the fetch attributes and functions.

Parameters

Input
Name Type Description
selectorString char[] Specifies a selector string) comprising of the signal name, subblock number, and carrier number. If you do not specify the signal name, the default signal instance is used.
Example:
"subblock0/carrier0"
"signal::sig1/subblock0/carrier0"
You can use the RFmxLTE_BuildCarrierString) function to build the selector string.
subframeNumber int32 Specifies the subframe number for building the selector string.
selectorStringOutLength int32 Specifies the length of the string that is returned by the selectorStringOut parameter. To get the minimum buffer size required to build the selector string, set the selectorStringOutLength parameter to 0.
Output
Name Type Description
selectorStringOut char[] Returns the selector string created by this function.

Return Value

Name Type Description
statusOrRequiredSize int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

When the statusOrRequiredSize return value returns the buffer size, the status code is not returned.

To obtain a text description of the status code and additional information about the error condition, call the RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_BuildPDSCHString

int32 __stdcall RFmxLTE_BuildPDSCHString (char selectorString[], int32 pdschNumber, int32 selectorStringOutLength, char selectorStringOut[]);

Purpose

Creates the PDSCH string to use as the selector string with the configuration or the fetch attributes and functions.

Parameters

Input
Name Type Description
selectorString char[] Specifies a selector string) comprising of the signal name, subblock number, carrier number, and subframe number. If you do not specify the signal name, the default signal instance is used.
Example:
"subblock0/carrier0/subframe0"
"signal::sig1/subblock0/carrier0/subframe0"
You can use the RFmxLTE_BuildSubframeString) function to build the selector string.
pdschNumber int32 Specifies the PDSCH channel number for building the selector string.
selectorStringOutLength int32 Specifies the length of the string that is returned by the selectorStringOut parameter. To get the minimum buffer size required to build the selector string, set the selectorStringOutLength parameter to 0.
Output
Name Type Description
selectorStringOut char[] Returns the selector string created by this function.

Return Value

Name Type Description
statusOrRequiredSize int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

When the statusOrRequiredSize return value returns the buffer size, the status code is not returned.

To obtain a text description of the status code and additional information about the error condition, call the RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Table of Contents

Internal Development

Creating and Setting Up a gRPC Server

Server Security Support

Creating a gRPC Client

gRPC Client Examples

Session Utilities API Reference

Driver Documentation

gRPC API Differences From C API

Sharing Driver Sessions Between Clients

C API Docs
NI-DAQmx
NI-DCPOWER
NI-DIGITAL PATTERN DRIVER
NI-DMM
NI-FGEN
NI-FPGA
NI-RFmx Bluetooth
NI-RFmx NR
NI-RFmx WCDMA
NI-RFmx GSM
NI-RFmx CDMA2k
NI-RFmx Instr
NI-RFmx LTE
NI-RFmx SpecAn
NI-RFmx TD-SCDMA
NI-RFmx WLAN
NI-RFSA
NI-RFSG
NI-SCOPE
NI-SWITCH
NI-TCLK
NI-XNET
Clone this wiki locally