Class Antennas.AntennaProperties

This class represents the antenna properties of the Reader

Inheritance

System.Object

Antennas.AntennaProperties

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: rfid.api

Assembly: rfid.netcore.dll

Syntax

public class AntennaProperties

Properties

Index

Gets the Index or ID of the antenna

Declaration

public ushort Index { get; }

Property Value

Type	Description
System.UInt16

Methods

GetConfig()

Gets ths Antenna Configuration

Declaration

public Antennas.Config GetConfig()

Returns

Type	Description
Antennas.Config	Returns the Antenna config object

Exceptions

Type	Condition
OperationFailureException	This exception is thrown when the parameter is invalid

GetPhysicalProperties()

Gets the Physical antenna properties

Declaration

public Antennas.PhysicalProperties GetPhysicalProperties()

Returns

Type	Description
Antennas.PhysicalProperties	PhysicalProperties object

Remarks

This method gets the antenna physical properties such as whether antenna is enabled or not and the antenna gain

Exceptions

Type	Condition
OperationFailureException	This exception is thrown when the parameters are invalid

GetRfConfig()

Function to get the RF configuration of the Antenna Specified

Declaration

public Antennas.AntennaRfConfig GetRfConfig()

Returns

Type	Description
Antennas.AntennaRfConfig	Antenna RF Configuration

GetRFMode()

Gets the RF Mode to be used with the inventory operations

Declaration

public Antennas.RFMode GetRFMode()

Returns

Type	Description
Antennas.RFMode	RF Mode object contains RF mode table index and Tari

GetSingulationControl()

Gets the Singulation Control

Declaration

public Antennas.SingulationControl GetSingulationControl()

Returns

Type	Description
Antennas.SingulationControl	successful call returns singulation control

SetConfig(Antennas.Config)

Sets the Antenna Configuration

Declaration

public void SetConfig(Antennas.Config antennaConfig)

Parameters

Type	Name	Description
Antennas.Config	antennaConfig	Antenna configuations

SetRfConfig(Antennas.AntennaRfConfig)

Sets the RF configuration of the Antenna

Declaration

public void SetRfConfig(Antennas.AntennaRfConfig antennaRfConfig)

Parameters

Type	Name	Description
Antennas.AntennaRfConfig	antennaRfConfig	The Configuration to be set

SetRFMode(Antennas.RFMode)

Sets the RF Mode to be used with the inventory operations

Declaration

public void SetRFMode(Antennas.RFMode antennaRFMode)

Parameters

Type	Name	Description
Antennas.RFMode	antennaRFMode	RFMODE to set

SetSingulationControl(Antennas.SingulationControl)

Sets the Singulation Control

Declaration

public void SetSingulationControl(Antennas.SingulationControl antennaSingulationControl)

Parameters

Type	Name	Description
Antennas.SingulationControl	antennaSingulationControl	Singulation control related to antenna (e.g. session, tag population etc)

Exceptions

Type	Condition
OperationFailureException	This exception is thrown when the parameter is invalid