UGrokItApi.IUgiInventoryDelegate Interface Reference

Overview

A UgiInventoryDelegate object is passed to the StartInventory method of the Ugi singleton. This object receives notification when inventory events happen.

Instance Methods
void	InventoryDidStart ()
	The reader has started doing inventory. This can happen multiple times during a single startInventory call, since the reader can be connected and disconnected from the host. More...
void	InventoryDidStop (UgiInventory.InventoryResults result)
	The reader has stopped doing inventory. This can happen multiple times during a single startInventory call, since the reader can be connected and disconnected from the host More...
bool	InventoryFilter (UgiEpc epc)
	Determine whether a newly found tag should be filtered out (not sent to inventoryTagFound or inventoryTagChanged, not put into the tags array). More...
void	InventoryTagChanged (UgiTag tag, bool firstFind)
	The visibility of a tag has changed. More...
void	InventoryTagFound (UgiTag tag, UgiDetailedPerReadData[] detailedPerReadData)
	A new tag has been found More...
void	InventoryTagSubsequentFinds (UgiTag tag, int count, UgiDetailedPerReadData[] detailedPerReadData)
	A previously found tag has been found again More...
void	InventoryHistoryInterval ()
	A history interval has passed More...

Instance Method Documentation

InventoryDidStart()

void UGrokItApi.IUgiInventoryDelegate.InventoryDidStart

(

)

The reader has started doing inventory. This can happen multiple times during a single startInventory call, since the reader can be connected and disconnected from the host.

InventoryDidStop()

void UGrokItApi.IUgiInventoryDelegate.InventoryDidStop

(

UgiInventory.InventoryResults

result

)

The reader has stopped doing inventory. This can happen multiple times during a single startInventory call, since the reader can be connected and disconnected from the host

Parameters

result

Result of the inventory

InventoryFilter()

bool UGrokItApi.IUgiInventoryDelegate.InventoryFilter

(

UgiEpc

epc

)

Determine whether a newly found tag should be filtered out (not sent to inventoryTagFound or inventoryTagChanged, not put into the tags array).

Parameters

epc	The new EPC the reader has found

Returns

trueto filter out the EPC

InventoryTagChanged()

void UGrokItApi.IUgiInventoryDelegate.InventoryTagChanged	(	UgiTag	tag,
		bool	firstFind
	)

The visibility of a tag has changed.

• A tag has been found for the first time
• A tag has not been seen for the history period (interval * depth)
• A tag that had not been seen for the history period has reappeared

Parameters

tag	The tag that has changed
firstFind	true if this is the first time this tag has been found

InventoryTagFound()

void UGrokItApi.IUgiInventoryDelegate.InventoryTagFound	(	UgiTag	tag,
		UgiDetailedPerReadData []	detailedPerReadData
	)

A new tag has been found

Parameters

tag	The tag that has been found
detailedPerReadData	Array of UgiDetailedPerReadData obejcts, if detailed per-read data was requested

InventoryTagSubsequentFinds()

void UGrokItApi.IUgiInventoryDelegate.InventoryTagSubsequentFinds	(	UgiTag	tag,
		int	count,
		UgiDetailedPerReadData []	detailedPerReadData
	)

A previously found tag has been found again

Parameters

tag	The tag
count	The number of finds since inventoryTagSubsequentFinds was last called
detailedPerReadData	Array of UgiDetailedPerReadData obejcts, if detailed per-read data was requested

InventoryHistoryInterval()

void UGrokItApi.IUgiInventoryDelegate.InventoryHistoryInterval

(

)

A history interval has passed