public class DirectionConfig
extends java.lang.Object
Constructor and Description |
---|
DirectionConfig()
The default constructor, sets
DirectionMode to DirectionMode.HighPerformance and the tag age interval
to five seconds. |
Modifier and Type | Method and Description |
---|---|
void |
enableSector(short sector)
Adds the specified sector to the list of sectors that should be monitored for tag
entrances, exits, and updates.
|
java.lang.Short[] |
getEnabledSectors() |
DirectionFieldOfView |
getFieldOfView() |
boolean |
getIsMaxTxPower() |
DirectionMode |
getMode() |
short |
getTagAgeIntervalSeconds()
The "age interval" specifies how long a tag needs to go unseen before
it's removed from the population of tags tracked for direction and an
exit report is sent.
|
double |
getTxPowerinDbm() |
short |
getUpdateIntervalSeconds()
Specifies how often update reports are sent when
updates are enabled.
|
short |
getUserTagPopulationLimit() |
boolean |
isDiagnosticReportEnabled()
When enabled, diagnostic reports are generated at each update interval
and sent to the application
|
boolean |
isEntryReportEnabled()
When enabled, an entry report is sent immediately upon the tag
entering the field of view of the reader.
|
boolean |
isExitReportEnabled()
When enabled, an exit report is generated when the tag has not been
seen by the reader in the tag age Interval.
|
boolean |
isSectorConfigurationValid()
Deprecated.
|
boolean |
isSectorEnabled(short sector)
Tests if the specified sector is in the list of sectors that should be monitored for tag
entrances, exits, and updates.
|
boolean |
isUpdateReportEnabled()
When update reports are enabled, direction reports are sent by the reader
periodically for all tags in the direction database
|
void |
removeAllSectors()
Removes all sectors from the list of sectors that should be monitored for tag
entrances, exits, and updates.
|
void |
removeSector(short sector)
Removes the specified sector from the list of sectors that should be monitored for tag
entrances, exits, and updates.
|
void |
setDiagnosticReportEnabled(boolean diagnosticReportEnabled)
When enabled, diagnostic reports are generated at each update interval
and sent to the application
|
void |
setEntryReportEnabled(boolean entryReportEnabled)
When enabled, an entry report is sent immediately upon the tag
entering the field of view of the reader.
|
void |
setExitReportEnabled(boolean exitReportEnabled)
When enabled, an exit report is generated when the tag has not been
seen by the reader in the tag age Interval.
|
void |
setFieldOfView(DirectionFieldOfView fieldOfView)
Sets the field of view for tag direction tracking.
|
void |
setIsMaxTxPower(boolean maxTxPower) |
void |
setMode(DirectionMode mode) |
void |
setTagAgeIntervalSeconds(short tagAgeIntervalSeconds)
The "age interval" specifies how long a tag needs to go unseen before
it's removed from the population of tags tracked for direction and an
exit report is sent.
|
void |
setTxPowerinDbm(double txPowerinDbm) |
void |
setUpdateIntervalSeconds(short updateIntervalSeconds)
Specifies how often update reports are sent when
updates are enabled.
|
void |
setUpdateReportEnabled(boolean updateReportEnabled) |
void |
setUserTagPopulationLimit(short userTagPopulationLimit) |
public DirectionConfig()
DirectionMode
to DirectionMode.HighPerformance
and the tag age interval
to five seconds.public void enableSector(short sector)
sector
- The desired sector to enable for the reader with direction role capabilities.public void removeSector(short sector)
sector
- A number between 2 and 9 corresponding to the sector space beneath the xArray.public void removeAllSectors()
public boolean isSectorEnabled(short sector)
sector
- A number between 2 and 9 corresponding to the sector space beneath the xArray.@Deprecated public boolean isSectorConfigurationValid()
public java.lang.Short[] getEnabledSectors()
public short getUserTagPopulationLimit()
public void setUserTagPopulationLimit(short userTagPopulationLimit)
userTagPopulationLimit
- A user specified tag population limit.public boolean getIsMaxTxPower()
public void setIsMaxTxPower(boolean maxTxPower)
maxTxPower
- Set to true if the maximum reader transmit power is desired. Set false
if a custom transmit power is desired.public double getTxPowerinDbm()
public void setTxPowerinDbm(double txPowerinDbm)
txPowerinDbm
- Sets the transmission power to be usedpublic short getTagAgeIntervalSeconds()
public void setTagAgeIntervalSeconds(short tagAgeIntervalSeconds)
tagAgeIntervalSeconds
- the desired value for the tag age intervalpublic short getUpdateIntervalSeconds()
LocationConfig.setUpdateReportEnabled(boolean)
public void setUpdateIntervalSeconds(short updateIntervalSeconds)
updateIntervalSeconds
- the time between report generation, in seconds. If the provided
value is zero or negative, a value of 1 will be applied.LocationConfig.setUpdateReportEnabled(boolean)
public boolean isUpdateReportEnabled()
LocationReport
public void setUpdateReportEnabled(boolean updateReportEnabled)
updateReportEnabled
- When true, update reports on the current
population of tags will be sent.LocationReport
public boolean isEntryReportEnabled()
LocationReport
public void setEntryReportEnabled(boolean entryReportEnabled)
entryReportEnabled
- true to enable entry reportsLocationReport
public boolean isExitReportEnabled()
LocationConfig.setTagAgeIntervalSeconds(short)
,
LocationReport
public void setExitReportEnabled(boolean exitReportEnabled)
exitReportEnabled
- true to enable exit reportsLocationReport
public boolean isDiagnosticReportEnabled()
LocationReport
public void setDiagnosticReportEnabled(boolean diagnosticReportEnabled)
diagnosticReportEnabled
- true to enable diagnostic reportsLocationReport
public DirectionFieldOfView getFieldOfView()
public void setFieldOfView(DirectionFieldOfView fieldOfView)
fieldOfView
- Determines which "rings" are enabled when reading and tracking tags.public DirectionMode getMode()
public void setMode(DirectionMode mode)
mode
- Sets the performance/sensitivity mode for this direction reporting session.