Class TranspondersCommandBase

Namespace

TechnologySolutions.Rfid.AsciiProtocol.Commands

Assembly

TechnologySolutions.Rfid.AsciiProtocol.Core.dll

Base class for commands that return one or more transponders

public abstract class TranspondersCommandBase : AlertDateTimeCommandBase, IAsciiCommand, ICommandParameters, IResponseParameters, IInventoryStopParameters, IAntennaParametersWithBounds, IAntennaParameters, IAntennaParameterBounds, IAntennaParameterCommandBounds, ITransponderParameters

Inheritance

object

AsciiCommandBase

ParameterCommandBase

ActionCommandBase

AlertDateTimeCommandBase

TranspondersCommandBase

Implements

IAsciiCommand

ICommandParameters

IResponseParameters

IInventoryStopParameters

IAntennaParametersWithBounds

IAntennaParameters

IAntennaParameterBounds

IAntennaParameterCommandBounds

ITransponderParameters

Derived

QuerySelectTransponderCommandBase

WriteSingleTransponderCommand

Inherited Members

AlertDateTimeCommandBase.UseAlert

AlertDateTimeCommandBase.IncludeDateTime

AlertDateTimeCommandBase.IsAlertSupported

ActionCommandBase.TakeNoAction

ParameterCommandBase.ResetParameters

ParameterCommandBase.ReadParameters

AsciiCommandBase.LibraryCommandIdentifier

AsciiCommandBase.CommandName

AsciiCommandBase.IsIndexedCommand

AsciiCommandBase.IsLibraryCommand

AsciiCommandBase.LastCommandLine

AsciiCommandBase.MaxSynchronousWaitTime

AsciiCommandBase.MaxSynchronousWait

AsciiCommandBase.Parameters

AsciiCommandBase.Response

AsciiCommandBase.Responder

AsciiCommandBase.AsciiResponse

AsciiCommandBase.ToString()

AsciiCommandBase.BuildCommandLine(StringBuilder)

AsciiCommandBase.CommandLine()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

SwitchActionExtensions.TriggerCommandLine(AsciiCommandBase, int)

AsciiCommandExtensions.ApplyAntennaBounds<TAsciiCommand>(TAsciiCommand, IAntennaParameterBounds)

AsciiCommandExtensions.ApplyAntennaBounds<TAsciiCommand>(TAsciiCommand, IReaderConfiguration)

AsciiCommandExtensions.ApplyAntenna<TAsciiCommand>(TAsciiCommand, TagFilter)

AsciiCommandExtensions.ApplyReport<TAsciiCommand>(TAsciiCommand, TagFields)

Constructors

TranspondersCommandBase(string)

Initializes a new instance of the TranspondersCommandBase class

protected TranspondersCommandBase(string commandName)

Parameters

commandName string

The command name (e.g. ".iv" for inventory)

Properties

IncludeChecksum

Gets or sets a value indicating whether to include checksum information in reader responses

[AsciiParameter("c", "transponder includes")]
public TriState? IncludeChecksum { get; set; }

Property Value

TriState?

IncludeIndex

Gets or sets a value indicating whether to include index numbers for multiple values in reader responses

[AsciiParameter("ix", "transponder includes")]
public TriState? IncludeIndex { get; set; }

Property Value

TriState?

IncludePC

Gets or sets a value indicating whether to include the EPC PC value in reader responses

[AsciiParameter("e", "transponder includes")]
public TriState? IncludePC { get; set; }

Property Value

TriState?

IncludeTransponderRssi

Gets or sets a value indicating whether to include RSSI value in reader responses

[AsciiParameter("r", "transponder includes")]
public TriState? IncludeTransponderRssi { get; set; }

Property Value

TriState?

IsIncludeIndexSupported

Gets or sets a value indicating whether the IncludeIndex property is supported by this command

protected bool IsIncludeIndexSupported { get; set; }

Property Value

bool

MaximumDuration

Gets or sets the maximum number of tags in a single inventory. Zero represents no limit

[AsciiParameter("md")]
public int? MaximumDuration { get; set; }

Property Value

int?

MaximumOutputPower

Gets or sets the maximum output power (used to bounds check OutputPower)

public int MaximumOutputPower { get; set; }

Property Value

int

Remarks

This value does not need to be initialized. If the value is not set it will assume the value from Current

MaximumRounds

Gets or sets the maximum number of tags in a single inventory. Zero represents no limit

[AsciiParameter("mr")]
public int? MaximumRounds { get; set; }

Property Value

int?

MaximumTags

Gets or sets the maximum number of tags in a single inventory. Zero represents no limit

[AsciiParameter("mt")]
public int? MaximumTags { get; set; }

Property Value

int?

MinimumOutputPower

Gets or sets the minimum output power (used to bounds check OutputPower)

public int MinimumOutputPower { get; set; }

Property Value

int

Remarks

This value does not need to be initialized. If the value is not set it will assume the value from Current

OutputPower

Gets or sets the output power in dBm between MinimumOutputPower and MaximumOutputPower or null to use the reader's current value

[AsciiParameter("o")]
public int? OutputPower { get; set; }

Property Value

int?

Timestamp

Gets the timestamp when the command started if date and time stamp is enabled (-dt on)

[AsciiResponse("DT")]
public DateTime Timestamp { get; }

Property Value

DateTime

Transponders

Gets the transponders received since the start of the last command

[AsciiResponse("CR", AsciiResponseRepeat.PerTransponder, "requires -c on")]
[AsciiResponse("EP", AsciiResponseRepeat.PerTransponder, "requires -ie on")]
[AsciiResponse("IX", AsciiResponseRepeat.PerTransponder, "requires -ix on")]
[AsciiResponse("PC", AsciiResponseRepeat.PerTransponder, "requires -e on")]
[AsciiResponse("RI", AsciiResponseRepeat.PerTransponder, "requires -r on")]
[AsciiResponse("EA", AsciiResponseRepeat.PerTransponder, "tag access commands only")]
[AsciiResponse("EB", AsciiResponseRepeat.PerTransponder, "tag access commands only")]
[AsciiResponse("KS", AsciiResponseRepeat.PerTransponder, "tag access commands only")]
[AsciiResponse("LS", AsciiResponseRepeat.PerTransponder, "tag access commands only")]
[AsciiResponse("TD", AsciiResponseRepeat.PerTransponder, "requires -fi on")]
[AsciiResponse("CF", AsciiResponseRepeat.PerTransponder, "requires -ic on")]
[AsciiResponse("PH", AsciiResponseRepeat.PerTransponder, "requires -ip on")]
[AsciiResponse("RD", AsciiResponseRepeat.PerTransponder, "read transponder command only")]
[AsciiResponse("RP", AsciiResponseRepeat.PerTransponder, "find tag command only")]
[AsciiResponse("QT", AsciiResponseRepeat.PerTransponder, "read transponder command only")]
[AsciiResponse("WW", AsciiResponseRepeat.PerTransponder, "write transponder command only")]
public IEnumerable<TransponderData> Transponders { get; }

Property Value

IEnumerable<TransponderData>

Methods

OnTransponderReceived(TransponderData, bool)

Called for each transponder received in the response

protected virtual void OnTransponderReceived(TransponderData transponder, bool moreToFollow)

Parameters

transponder TransponderData

The transponder to report

moreToFollow bool

True if more transponder are already queued

Events

TransponderReceived

Raised when a transponder is received

public event EventHandler<TransponderDataEventArgs> TransponderReceived

Event Type

EventHandler<TransponderDataEventArgs>