Class TagFilter

Namespace

TechnologySolutions.Rfid

Assembly

TechnologySolutions.Rfid.Operations.dll

Declares the transponder or transponders to be returned from an RFID operation

Create a filter to identify transponders with a specific EPC

// Return all the transponders that have EPC '001122334455668877aabbccddeeff' using an output power of 20dBm
TagFilter.ForEpc("001122334455668877aabbccddeeff").ForInventory().ExpectMany().AtPower(20);
// Find the one transponder with the specified serialized TID (manufacturer TID with unique serial number)
TagFilter.ForTid(TagMemory.Parse("E280117020001089CCEB08DF")).ForTagFinding().ExpectOne();
// Return all the transponders where the user memory does not start with two blank words
TagFilter.ForMemory(MemoryBank.User, "FFFFFFFF", 0, 32).ForInventory().NonMatching();

public class TagFilter

Inheritance

object

TagFilter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

TagFilterExtensions.Report(TagFilter, TagFields)

TagFilterExtensions.ReportDefaults(TagFilter)

Properties

BitLength

Gets the number of bits to compare between Memory and Mask

public int BitLength { get; }

Property Value

int

BitOffset

Gets the offset in bits into Memory to start matching Mask

public int BitOffset { get; }

Property Value

int

Hint

Gets a hint as to what this filter is to be used for

public TagFilterHint Hint { get; }

Property Value

TagFilterHint

Invert

Gets a value indicating whether to return the matching (false) or non-matching (true) transponders

public bool Invert { get; }

Property Value

bool

Mask

Gets the mask to match against the Memory

public TagMemory Mask { get; }

Property Value

TagMemory

Memory

Gets the memory bank to filter on

public MemoryBank Memory { get; }

Property Value

MemoryBank

OutputPower

Gets the output power to use in dBm or null (Nothing in Visual Basic) to use the default / current value

public int? OutputPower { get; }

Property Value

int?

Session

Gets the session to use

public int Session { get; }

Property Value

int

Remarks

This value is based upon TagPopulationTarget and Hint unless explicitly set

TagPopulationTarget

Gets the approximate number of transponders we are expecting to identify

public int TagPopulationTarget { get; }

Property Value

int

Methods

All()

Returns a tag filter that does not select to filter transponders

public static TagFilter All()

Returns

TagFilter

AtPower(int?)

Returns a tag filter with the output power specified

public TagFilter AtPower(int? outputPower)

Parameters

outputPower int?

The required output power in dBm or null (Nothing in Visual Basic) of the default / current output power

Returns

TagFilter

The tag filter with the power specified

ExpectMany()

Returns a tag filter that is targeting a large number of transponders

public TagFilter ExpectMany()

Returns

TagFilter

The filter expecting more than 1000 transponders

ExpectOne()

Returns the tag filter that is targeting a single transponder

public TagFilter ExpectOne()

Returns

TagFilter

The filter with an expected population of 1

ExpectPopulation(int)

Returns a tag filter expecting the approximate specified tag population

public TagFilter ExpectPopulation(int tagCount)

Parameters

tagCount int

The approximate number of transponders to expect

Returns

TagFilter

The filter expecting the specified population

ForEpc(string)

Returns a tag filter to identify transponders by matching the specified EPC

public static TagFilter ForEpc(string epcHex)

Parameters

epcHex string

The EPC to match as a hex (base 16) string

Returns

TagFilter

A tag filter to return transponders with the EPC specified

ForEpc(TagMemory)

Returns a tag filter to identify transponders by matching the specified EPC

public static TagFilter ForEpc(TagMemory epc)

Parameters

epc TagMemory

The EPC to match

Returns

TagFilter

A tag filter to return transponders with the EPC specified

ForInventory()

Returns a TagFilter with the Hint set to Inventory

public TagFilter ForInventory()

Returns

TagFilter

The TagFilter with the hint set

ForMemory(MemoryBank, string, int, int)

Returns a tag filter to identify transponders where the specified memory matches the mask at bitOffset for bitLength

public static TagFilter ForMemory(MemoryBank memory, string maskHex, int bitOffset, int bitLength)

Parameters

memory MemoryBank

The memory bank to match

maskHex string

The bit pattern to match to

bitOffset int

The offset in bits into the memory bank to start the comparison

bitLength int

The number of bits to compare

Returns

TagFilter

The tag filter that matches the specified mask

ForMemory(MemoryBank, TagMemory, int, int)

Returns a tag filter to identify transponders where the specified memory matches the mask at bitOffset for bitLength

public static TagFilter ForMemory(MemoryBank memory, TagMemory mask, int bitOffset, int bitLength)

Parameters

memory MemoryBank

The memory bank to match

mask TagMemory

The bit pattern to match to

bitOffset int

The offset in bits into the memory bank to start the comparison

bitLength int

The number of bits to compare

Returns

TagFilter

The tag filter that matches the specified mask

ForTagAccess()

Returns a TagFilter with the Hint set to TagAccess

public TagFilter ForTagAccess()

Returns

TagFilter

The TagFilter with the hint set

ForTagFinding()

Returns a TagFilter with the Hint set to TagFinding

public TagFilter ForTagFinding()

Returns

TagFilter

The TagFilter with the hint set

ForTid(TagMemory)

Returns a tag filter to identify transponders by matching the specified TID

public static TagFilter ForTid(TagMemory tid)

Parameters

tid TagMemory

The TID to match

Returns

TagFilter

A tag filter to return transponders with the TID specified

Matching()

Returns the tag filter for transponders that match the mask at the specified location

public TagFilter Matching()

Returns

TagFilter

The filter for transponders that match this filter

NonMatching()

Returns the tag filter for transponders that DOES NOT match the mask at the specified location

public TagFilter NonMatching()

Returns

TagFilter

The filter for transponders that

UseSession(int)

Overrides the ExpectPopulation(int) and ForHint(TagFilterHint) to explicitly set the session to use (must be called after)

public TagFilter UseSession(int session)

Parameters

session int

The session flag to use

Returns

TagFilter

The filter with the specified session flag