NI RFmx LTE Build String Functions - ni/grpc-device GitHub Wiki
- RFmxLTE_BuildSignalString
- RFmxLTE_BuildSubblockString
- RFmxLTE_BuildCarrierString
- RFmxLTE_BuildOffsetString
- RFmxLTE_BuildClusterString
- RFmxLTE_BuildSubframeString
- RFmxLTE_BuildPDSCHString
int32 __stdcall RFmxLTE_BuildSignalString (char signalName[], char resultName[], int32 selectorStringLength, char selectorString[]);
Creates selector string for use with configuration or fetch attributes and functions.
| 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. |
| 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 |
int32 __stdcall RFmxLTE_BuildSubblockString (char selectorString[], int32 subblockNumber, int32 selectorStringOutLength, char selectorStringOut[]);
Creates the subblock string to use as the selector string with the subblock configuration or fetch attributes and functions.
| 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. |
| 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 |
int32 __stdcall RFmxLTE_BuildCarrierString (char selectorString[], int32 carrierNumber, int32 selectorStringOutLength, char selectorStringOut[]);
Creates the carrier string to use as the selector string with the SEM and ACP carrier configuration or fetch attributes and functions.
| 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. |
| 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 |
int32 __stdcall RFmxLTE_BuildOffsetString (char selectorString[], int32 offsetNumber, int32 selectorStringOutLength, char selectorStringOut[]);
Creates the offset string to use as the selector string with SEM and ACP offset configuration or fetch attributes and functions.
| 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. |
| 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 |
int32 __stdcall RFmxLTE_BuildClusterString (char selectorString[], int32 clusterNumber, int32 selectorStringOutLength, char selectorStringOut[]);
Creates a cluster string to use as the selector string with the ModAcc cluster configuration or the fetch attributes and functions.
| 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. |
| 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 |
int32 __stdcall RFmxLTE_BuildSubframeString (char selectorString[], int32 subframeNumber, int32 selectorStringOutLength, char selectorStringOut[]);
Creates the subframe string to use as the selector string with the configuration or the fetch attributes and functions.
| 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. |
| 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 |
int32 __stdcall RFmxLTE_BuildPDSCHString (char selectorString[], int32 pdschNumber, int32 selectorStringOutLength, char selectorStringOut[]);
Creates the PDSCH string to use as the selector string with the configuration or the fetch attributes and functions.
| 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. |
| 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 |