# Package com.impinj.octane

- Interface Summary
  Interface | Description
  --- | ---
  AntennaChangeListener | Your application can implement this interface to receive antenna change events.
  BufferOverflowListener | Your application can implement this interface to receive buffer overflow events.
  BufferWarningListener | Your application can implement this interface to receive buffer warnings.
  ConnectionAttemptListener | Your application can implement this interface to receive connection attempt events.
  ConnectionCloseListener | Your application can implement this interface to receive connection close events.
  ConnectionLostListener | Your application can implement this interface to receive connection close events.
  DiagnosticsReportListener | Your application can implement this interface to receive xarray diagnostic report events.
  DirectionReportListener | Your application must implement this interface to receive direction reports.
  GpiChangeListener | Your application can implement this interface to receive GPI change events.
  KeepaliveListener | Your application can implement this interface to receive keepalive events.
  KeepaliveTimeoutListener | An internal class used by the SDK to watch for keepalive timeouts
  LocationReportListener | Your application can implement this interface to receive location reports.
  ReaderStartListener | Your application can implement this interface to receive reader start events.
  ReaderStopListener | Your application can implement this interface to receive reader stop events.
  TagOpCompleteListener | Your application can implement this interface to receive tag operation events.
  TagReportListener | Your application can implement this interface to receive tag report events.

- Class Summary
  Class | Description
  --- | ---
  AntennaConfig | This class hold the antenna configuration information.
  AntennaConfigGroup | This class hold the collection of antenna configuration.
  AntennaEvent | This class contains the information about a change in antenna state.
  AntennaHubStatus | Speedway Revolution readers can be outfitted with antenna hubs which allows the reader to operate more antenna ports.
  AntennaHubStatusGroup | Contains the collection of antenna Hub status for the antenna hubs connected to the ImpinjReader.
  AntennaIds | Helper class used when identifying that all antennas should be used when configuring a tag operation.
  AntennaStatus | Class containing The status information for an individual antenna port.
  AntennaStatusGroup | The collection of antenna statuses for the readers antennas
  AntennaUtilities | Static class that provides utility functions for getting antenna patterns.
  AutoStartConfig | The ImpinjReader can be configured to start inventory automatically based on several inputs including General purpose input (GPI) and time.
  AutoStopConfig | The ImpinjReader can be configured to stop inventory automatically based on several inputs including General purpose input (GPI) and time.
  BackgroundWorker | An internal class that is currently unused
  BitPointers | These constants point to bit locations in memory for common fields.
  BlockPermalockMask | Uses to specify which blocks to permalock.
  BufferOverflowEvent | This event carries information on a buffer overflow event.
  BufferWarningEvent | This class holds the buffer warning event information.
  ConnectionAttemptEvent | This event carries information on a connection attempt.
  ConnectionCloseEvent | This event carries information on a connection close.
  DiagnosticReport | xArray diagnostic report
  DirectionConfig | A container that holds all of the configuration options for xArray's Direction feature.
  DirectionReport | DirectionReport that is received by implementors of `DirectionReportListener`, instantiated and populated by `ImpinjReader`
  FeatureSet | The FeatureSet class holds the capabilities and features of an Impinj reader.
  FilterSettings | These filter settings describe the inventory filters applied by the reader.
  GpiConfig | This class holds the configuration for a single General Purpose Input
  GpiConfigGroup | Hold the configuration for a collection of General Purpose Inputs
  GpiEvent | Class used to encapsulate the details of a GPI change reader event.
  GpiStatus | Contains the information on the status of a single GPI
  GpiStatusGroup | Container class encapsulating all of the GPI status objects.
  GpoConfig | Container class for holding the configuration of a single General Purpose output
  GpoConfigGroup | Container class for holding the General Purpose Output (GPO) configuration for the readers set of output
  GpsCoordinates | A container class to hold latitude and longitude information
  ImpinjReader | This is the main class for the Octane SDK Java.
  ImpinjTimestamp | Timestamp class supporting Impinj Reader and LLRP timestamp data.
  KeepaliveConfig | A class to hold the settings of the keepalive feature
  KeepaliveEvent | This event carries information on a keepalive event.
  KeepaliveTimer | An internal class that watches the keep alive messages from the reader
  LocationConfidenceFactors | Contains the confidence factors for a location report.
  LocationConfig | A container that holds all of the configuration options for xArray location
  LocationReport | xArray location report.
  LockTagResult | Class to carry the result of a lock operation
  LowDutyCycleSettings | The Impinj reader can operation automatically in a low duty cycle mode, performing continuous inventory when tags are present, but reducing the duty cycle of the inventory when tags have been absent from the field for some time.
  MarginReadMask | Used to specify the mask to margin read
  PcBits | Helper class used to encode and decode the PC word.
  PlacementConfig | Since xArray reports location, it requires knowledge of its exact placement, especially when there are multiple xArrays reporting location and the user requires a consistent coordinate system.
  ReaderStartEvent | This event carries information on a reader start event.
  ReaderStopEvent | This event carries information on a reader stop event.
  ReportConfig | container class to specify the contents of tag Reports
  RshellEngine | This class allows the application to generate rshell commands and process the rshell responses.
  RshellReply | This class helps the user parse and decode the tokens from a rshell reply.
  RxSensitivityTableEntry | The reader can operate at different sensitivity levels to provide coarse control of the range of the device.
  SectorConfig | Contains sector configuration for xArray.
  Settings | This is a container class for all of the knobs that control reader behavior.
  SpatialConfig | Class used to define the configuration for a reader with location or direction role capabilities.
  Status | The status class holds information on the current status of reader functions.
  Tag | A container class to hold information about a tag.
  TagBlockPermalockOp | Used to perform a block permalock operation on a tag
  TagBlockPermalockOpResult | Used to report the status of a block permalock operations
  TagData | A class to hold tag data including EPCs, user memory data, TID memory etc.
  TagFilter | A class to hold the configuration of a tag inventory filter.
  TagKillOp | Class used to specify a tag kill operation.
  TagKillOpResult | Class to contain the results of a tag Kill operation
  TagLockOp | Class to contain the information to perform a tag Lock operation.
  TagLockOpResult | Class to contain the results of a tag lock operation
  TagMarginReadOp | Used to perform a margin read operation on a tag
  TagMarginReadOpResult | Used to report the status of margin read operations
  TagModelDetails | A class that decodes the tag model details from the TID memory read
  TagOp | A base class to hold information to perform a tag operation like read, write, lock, and kill.
  TagOpReport | Container class used to encapsulate all tag operation results.
  TagOpResult | Parent class that contains the results of an individual tag operation
  TagOpSequence | Class for containing and configuring a sequence of tag operations that are submitted to the reader
  TagQtGetOp | A class to contain the QT get operation
  TagQtGetOpResult | A class to contain the QtGetOp result
  TagQtSetOp | A class to contain the QTSet operation data
  TagQtSetOpResult | a class to contain the results of a qt set operation
  TagReadOp | A class to contain the data for a tag read operation
  TagReadOpResult | a class to contain the read operation results
  TagReport | a container class to carry a tag report
  TagWriteOp | A class to contain the data for a tag write operation
  TagWriteOpResult | A class to contain the results of a tag write operation
  TargetTag | Helper class used to identify a specific tag or set of tags on which to perform a tag operation operation.
  TiltSensorValue | Holds the X, Y, and Z values returned by the tilt sensor.
  TxPowerTableEntry | a class to contain a list of available transmit power options
  WordPointers | Helper class used when defining tag memory accesses.that use word pointers
  XArrayConfig | Deprecated

- Enum Summary
  Enum | Description
  --- | ---
  AntennaEventType | The reader uses an internal mechanism to detect whether antennas are connected or disconnected from each antenna port.
  AutoStartMode | The ImpinjReader can be configured to start inventory automatically based on several inputs including General purpose input (GPI) and time.
  AutoStopMode | The ImpinjReader can be configured to stop inventory automatically based on several inputs including General purpose input (GPI) and time.
  BlockPermalockResult | An enumeration to hold the block permalock result.
  CommunicationsStandardType | This enumerations defines the regulatory rules under which this device operates
  ConnectAsyncResult | Enumeration used to specify the result of an asynchronous connection attempt
  DirectionFieldOfView | Specified if a narrow or wide ring should be used when reading and tracking tag direction.
  DirectionMode | Provides the options available for tweaking the xArray's operation when in direction mode.
  DirectionReportType | DirectionReportType is an enum used to indicate the event that caused a `DirectionReport` to be sent.
  DirectionTagPopulationStatus | Specifies the overflow status of a Direction Report
  GpoMode | An enumeration that holds the possible GPO configuration values.
  HubConnectedStatus | Container class to hold Impinj Antenna Hub Information
  HubFaultStatus | Container class to hold antenna hub fault information
  KillResultStatus | An enumeration that describes the result of a kill tag operation
  LocationReportType | The type of the location report generated by the reader.
  LockMemoryBank | An enumeration describing which memory bank to lock
  LockResultStatus | The status of a lock operation
  LockType | An enumeration that holds the type of lock operation to perform
  MarginReadResult | An enumeration to hold the margin read result.
  MemoryBank | Gen2 defines several memory banks.
  QtAccessRange | Enumeration used to determine whether to configure the tag in reduced sensitivity (i.e.
  QtDataProfile | Enumeration used to determine which QT data profile to use.
  QtGetConfigResultStatus | An enumeration to describe the result of a QT Get Command operation
  QtPersistence | Enumeration used to determine whether the QT set command should persist
  QtSetConfigResultStatus | An enumeration to describe the result of a QT Set Command operation
  ReaderMode | An enumeration defining the choices for the communications parameters used between the reader and tags.
  ReaderModel | All the possible reader models, mapped to their model numbers.
  ReadResultStatus | An enumeration that conveys the status of a tag read operation
  ReportMode | The reader has several ways it can generate the tag reports that result from reader inventory operations.
  SearchMode | This enumeration describes the method the reader uses to search for tags.
  SequenceState | Enumeration for defining the operation state for a sequence.
  SequenceTriggerType | A tag operation sequence has a stop trigger that defines when the reader should stop executing the tag operation.
  SpatialMode | An enumeration to describe a reader with direction or location role capabilities' operational mode.
  TagFilterMode | enumerates the different ways the two tag filters can be combined during the inventory operation
  TagFilterOp | What to do when comparing tag filters against the data patterns
  TagLockState | An enumeration for determining which lock operation to perform on the tag memory bank; this determines what state to leave the tag memory bank in.
  TagModelName | an enumeration to contain the tag model names.
  WriteResultStatus | a enumeration to report the results of a write operation
  XArrayMode | Deprecated

- Exception Summary
  Exception | Description
  --- | ---
  OctaneSdkException | When errors occur in the SDK, this exception is thrown.