Enum Class ChannelType

java.lang.Object
java.lang.Enum<ChannelType>
com.dsi.ant.message.ChannelType
All Implemented Interfaces:
Serializable, Comparable<ChannelType>, Constable

public enum ChannelType extends Enum<ChannelType>
The possible types an ANT channel can be assigned as.
Since:
4.0
  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Primarily transmits data but can receive in reverse direction.
    Primarily receives data but can transmit in reverse direction.
    Transmits and receives data to/from multiple ANT channels with a shared channel ID.
    Primarily receives and transmits data from/to a master transmitting to multiple ANT channels with a shared channel ID.
    Can only receive data, as such, this channel type can only use the broadcast data type and should not be used if the application requires any form of confirmation or acknowledgement of the successful receipt of data.
    The received value for channel type does not match the possible channel types.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    The number of bytes used for the channel type.
  • Method Summary

    Modifier and Type
    Method
    Description
    create(int rawValue)
    Creates the ChannelType from the raw value.
    int
    Returns the raw value of this ChannelType.
    boolean
    Checks if this channel type is a slave (RX) device.
    Returns the enum constant of this class with the specified name.
    static ChannelType[]
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • BIDIRECTIONAL_SLAVE

      public static final ChannelType BIDIRECTIONAL_SLAVE
      Primarily receives data but can transmit in reverse direction.
      Since:
      4.0
    • BIDIRECTIONAL_MASTER

      public static final ChannelType BIDIRECTIONAL_MASTER
      Primarily transmits data but can receive in reverse direction.
      Since:
      4.0
    • SHARED_BIDIRECTIONAL_SLAVE

      public static final ChannelType SHARED_BIDIRECTIONAL_SLAVE
      Primarily receives and transmits data from/to a master transmitting to multiple ANT channels with a shared channel ID.
      Since:
      4.0
    • SHARED_BIDIRECTIONAL_MASTER

      public static final ChannelType SHARED_BIDIRECTIONAL_MASTER
      Transmits and receives data to/from multiple ANT channels with a shared channel ID.
      Since:
      4.0
    • SLAVE_RECEIVE_ONLY

      public static final ChannelType SLAVE_RECEIVE_ONLY
      Can only receive data, as such, this channel type can only use the broadcast data type and should not be used if the application requires any form of confirmation or acknowledgement of the successful receipt of data. Receive only mode is only recommended for diagnostic applications using continuous scan mode.
      Since:
      4.11.1
    • UNKNOWN

      public static final ChannelType UNKNOWN
      The received value for channel type does not match the possible channel types.
      Since:
      4.0
  • Field Details

    • SIZE_CHANNEL_TYPE

      public static final int SIZE_CHANNEL_TYPE
      The number of bytes used for the channel type.
      Since:
      4.0
      See Also:
  • Method Details

    • values

      public static ChannelType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static ChannelType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • getRawValue

      public int getRawValue()
      Returns the raw value of this ChannelType. Applications should use the enumeration values directly.
      Returns:
      The raw value.
      Since:
      4.0
    • create

      public static ChannelType create(int rawValue)
      Creates the ChannelType from the raw value. Applications should access the enumeration types directly.
      Returns:
      The channel type
      Since:
      4.0
    • isSlave

      public boolean isSlave()
      Checks if this channel type is a slave (RX) device.
      Returns:
      True, if the channel type is a slave. False, otherwise.
      Since:
      4.0