NurApiIsPhysicalAntennaEnabled Method

This function returns true if all physical antennas specified in comma separated string are enabled, otherwise false is returned.

Definition

Namespace: NurApiDotNet
Assembly: NordicID.NurApi.Net (in NordicID.NurApi.Net.dll) Version: 4.0.0
C#
public bool IsPhysicalAntennaEnabled(
	string commaSeparated
)

Parameters

commaSeparated  String
Comma separatede list of physical antenna names to test. If antenna is specified without polarity, all polarities will be tested. To test all antennas, use parameter "ALL"

Return Value

Boolean
Returns true if all specified physical antenna(s) are enabled.

Throws InvalidParameter exception if reader does not contain supplied physical antenna.

Throws NotSupported exception if reader does not support logical to physical antenna mappings.

Example

Example usage.
C#
// Test if Beam1 both polarities and Beam 5 polarity X are enabled.
bool enabled = hApi.IsPhysicalAntennaEnabled("Beam1,Beam5.X");

See Also