Enum TPCANParameter

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<TPCANParameter>, java.lang.constant.Constable

    public enum TPCANParameter
    extends java.lang.Enum<TPCANParameter>
    Parameter definition.
    • Enum Constant Detail

      • PCAN_DEVICE_NUMBER

        public static final TPCANParameter PCAN_DEVICE_NUMBER
        Deprecated.
        Deprecated parameter. Use PCAN_DEVICE_ID instead
        PCAN-USB device number parameter
      • PCAN_DEVICE_ID

        public static final TPCANParameter PCAN_DEVICE_ID
        PCAN-USB device number parameter
      • PCAN_5VOLTS_POWER

        public static final TPCANParameter PCAN_5VOLTS_POWER
        PCAN-PC Card 5-Volt power parameter
      • PCAN_RECEIVE_EVENT

        public static final TPCANParameter PCAN_RECEIVE_EVENT
        PCAN receive event handler parameter
      • PCAN_MESSAGE_FILTER

        public static final TPCANParameter PCAN_MESSAGE_FILTER
        PCAN message filter parameter
      • PCAN_API_VERSION

        public static final TPCANParameter PCAN_API_VERSION
        PCAN-Basic API version parameter
      • PCAN_CHANNEL_VERSION

        public static final TPCANParameter PCAN_CHANNEL_VERSION
        PCAN device channel version parameter
      • PCAN_BUSOFF_AUTORESET

        public static final TPCANParameter PCAN_BUSOFF_AUTORESET
        PCAN Reset-On-Busoff parameter
      • PCAN_LISTEN_ONLY

        public static final TPCANParameter PCAN_LISTEN_ONLY
        PCAN Listen-Only parameter
      • PCAN_LOG_LOCATION

        public static final TPCANParameter PCAN_LOG_LOCATION
        Directory path for trace files
      • PCAN_LOG_STATUS

        public static final TPCANParameter PCAN_LOG_STATUS
        Debug-Trace activation status
      • PCAN_LOG_CONFIGURE

        public static final TPCANParameter PCAN_LOG_CONFIGURE
        Configuration of the debugged information (LOG_FUNCTION_***)
      • PCAN_LOG_TEXT

        public static final TPCANParameter PCAN_LOG_TEXT
        Custom insertion of text into the log file
      • PCAN_CHANNEL_CONDITION

        public static final TPCANParameter PCAN_CHANNEL_CONDITION
        Availability status of a PCAN-Channel
      • PCAN_HARDWARE_NAME

        public static final TPCANParameter PCAN_HARDWARE_NAME
        PCAN hardware name parameter
      • PCAN_RECEIVE_STATUS

        public static final TPCANParameter PCAN_RECEIVE_STATUS
        Message reception status of a PCAN-Channel
      • PCAN_CONTROLLER_NUMBER

        public static final TPCANParameter PCAN_CONTROLLER_NUMBER
        CAN-Controller number of a PCAN-Channel
      • PCAN_TRACE_LOCATION

        public static final TPCANParameter PCAN_TRACE_LOCATION
        Directory path for PCAN trace files
      • PCAN_TRACE_STATUS

        public static final TPCANParameter PCAN_TRACE_STATUS
        CAN tracing activation status
      • PCAN_TRACE_SIZE

        public static final TPCANParameter PCAN_TRACE_SIZE
        Configuration of the maximum file size of a CAN trace
      • PCAN_TRACE_CONFIGURE

        public static final TPCANParameter PCAN_TRACE_CONFIGURE
        Configuration of the trace file storing mode (TRACE_FILE_***)
      • PCAN_CHANNEL_IDENTIFYING

        public static final TPCANParameter PCAN_CHANNEL_IDENTIFYING
        Physical identification of a USB based PCAN-Channel by blinking its associated LED
      • PCAN_CHANNEL_FEATURES

        public static final TPCANParameter PCAN_CHANNEL_FEATURES
        Capabilities of a PCAN device (FEATURE_***)
      • PCAN_BITRATE_ADAPTING

        public static final TPCANParameter PCAN_BITRATE_ADAPTING
        Using of an existing bit rate (PCAN-View connected to a channel)
      • PCAN_BITRATE_INFO

        public static final TPCANParameter PCAN_BITRATE_INFO
        Configured Bit rate as Btr0Btr1 value
      • PCAN_BITRATE_INFO_FD

        public static final TPCANParameter PCAN_BITRATE_INFO_FD
        Configured Bit rate as TPCANBitrateFD string
      • PCAN_BUSSPEED_NOMINAL

        public static final TPCANParameter PCAN_BUSSPEED_NOMINAL
        Configured nominal CAN Bus speed as Bits per seconds
      • PCAN_BUSSPEED_DATA

        public static final TPCANParameter PCAN_BUSSPEED_DATA
        Configured CAN data speed as Bits per seconds
      • PCAN_IP_ADDRESS

        public static final TPCANParameter PCAN_IP_ADDRESS
        Remote address of a LAN channel as string in IPv4 format
      • PCAN_LAN_SERVICE_STATUS

        public static final TPCANParameter PCAN_LAN_SERVICE_STATUS
        Status of the Virtual PCAN-Gateway Service
      • PCAN_ALLOW_STATUS_FRAMES

        public static final TPCANParameter PCAN_ALLOW_STATUS_FRAMES
        Status messages reception status within a PCAN-Channel
      • PCAN_ALLOW_RTR_FRAMES

        public static final TPCANParameter PCAN_ALLOW_RTR_FRAMES
        RTR messages reception status within a PCAN-Channel
      • PCAN_ALLOW_ERROR_FRAMES

        public static final TPCANParameter PCAN_ALLOW_ERROR_FRAMES
        Error messages reception status within a PCAN-Channel
      • PCAN_INTERFRAME_DELAY

        public static final TPCANParameter PCAN_INTERFRAME_DELAY
        Delay, in microseconds, between sending frames
      • PCAN_ACCEPTANCE_FILTER_11BIT

        public static final TPCANParameter PCAN_ACCEPTANCE_FILTER_11BIT
        Filter over code and mask patterns for 11-Bit messages
      • PCAN_ACCEPTANCE_FILTER_29BIT

        public static final TPCANParameter PCAN_ACCEPTANCE_FILTER_29BIT
        Filter over code and mask patterns for 29-Bit messages
      • PCAN_IO_DIGITAL_CONFIGURATION

        public static final TPCANParameter PCAN_IO_DIGITAL_CONFIGURATION
        Output mode of 32 digital I/O pin of a PCAN-USB Chip. 1: Output-Active 0 : Output Inactive
      • PCAN_IO_DIGITAL_VALUE

        public static final TPCANParameter PCAN_IO_DIGITAL_VALUE
        Value assigned to a 32 digital I/O pins of a PCAN-USB Chip
      • PCAN_IO_DIGITAL_SET

        public static final TPCANParameter PCAN_IO_DIGITAL_SET
        Value assigned to a 32 digital I/O pins of a PCAN-USB Chip - Multiple digital I/O pins to 1 = High
      • PCAN_IO_DIGITAL_CLEAR

        public static final TPCANParameter PCAN_IO_DIGITAL_CLEAR
        Clear multiple digital I/O pins to 0
      • PCAN_IO_ANALOG_VALUE

        public static final TPCANParameter PCAN_IO_ANALOG_VALUE
        Get value of a single analog input pin
      • PCAN_FIRMWARE_VERSION

        public static final TPCANParameter PCAN_FIRMWARE_VERSION
        Get the version of the firmware used by the device associated with a PCAN-Channel
      • PCAN_ATTACHED_CHANNELS_COUNT

        public static final TPCANParameter PCAN_ATTACHED_CHANNELS_COUNT
        Get the amount of PCAN channels attached to a system
      • PCAN_ATTACHED_CHANNELS

        public static final TPCANParameter PCAN_ATTACHED_CHANNELS
        Get information about PCAN channels attached to a system
      • PCAN_ALLOW_ECHO_FRAMES

        public static final TPCANParameter PCAN_ALLOW_ECHO_FRAMES
        Echo messages reception status within a PCAN-Channel
      • PCAN_DEVICE_PART_NUMBER

        public static final TPCANParameter PCAN_DEVICE_PART_NUMBER
        Get the part number associated to a device
    • Method Detail

      • values

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

        public static TPCANParameter valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getValue

        public int getValue()
        The identifier of the CAN parameter
        Returns:
        Identifier of the CAN parameter
      • customizableParameters

        public static TPCANParameter[] customizableParameters()
        Returns the list of PCAN Parameters which are customizable as array
        Returns:
        the list of PCAN Parameters which are customizable as array
      • getParameterDescription

        public static java.lang.String getParameterDescription​(TPCANParameter param)
        Returns a description for the given TPCANParameter
        Parameters:
        param - TPCANParameter for which we need description
        Returns:
        a string description for the given TPCANParameter