Enum TPCANParameterValue

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

    public enum TPCANParameterValue
    extends java.lang.Enum<TPCANParameterValue>
    Parameter values definition
    • Nested Class Summary

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

        java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int MAX_LENGTH_HARDWARE_NAME
      Maximum length of the name of a device: 32 characters + terminator
      static int MAX_LENGTH_VERSION_STRING
      Maximum length of a version string: 17 characters + terminator
      static int MIN_LENGTH_ERROR_STRING
      Recommended length for an error string: 255 characters + terminator
    • Method Summary

      Modifier and Type Method Description
      int getValue()
      The value of the CAN parameter's value
      static TPCANParameterValue parseCondition​(int value)
      Parses a int value into the TPCANParameterValue PCAN_CHANNEL_AVAILABLE, PCAN_CHANNEL_ILLEGAL, PCAN_CHANNEL_OCCUPIED or PCAN_CHANNEL_UNOCCUPIED
      static java.util.EnumSet<TPCANParameterValue> parseFeatures​(int value)
      Parses a int value into the TPCANParameterValue PCAN_CHANNEL_AVAILABLE, PCAN_CHANNEL_ILLEGAL, PCAN_CHANNEL_OCCUPIED or PCAN_CHANNEL_UNOCCUPIED
      static TPCANParameterValue parseFilterStatus​(int value)
      Parses a int value into the TPCANParameterValue PCAN_FILTER_CLOSE, PCAN_FILTER_OPEN or PCAN_FILTER_CUSTOM.
      static TPCANParameterValue parseOnOff​(int value)
      Parses a int value into the TPCANParameterValue PCAN_PARAMETER_ON or PCAN_PARAMETER_OFF
      static TPCANParameterValue valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static TPCANParameterValue[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

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

      • PCAN_PARAMETER_OFF

        public static final TPCANParameterValue PCAN_PARAMETER_OFF
        The PCAN parameter is not set (inactive)
      • PCAN_PARAMETER_ON

        public static final TPCANParameterValue PCAN_PARAMETER_ON
        The PCAN parameter is set (active)
      • PCAN_FILTER_CLOSE

        public static final TPCANParameterValue PCAN_FILTER_CLOSE
        The PCAN filter is closed. No messages will be received
      • PCAN_FILTER_OPEN

        public static final TPCANParameterValue PCAN_FILTER_OPEN
        The PCAN filter is fully opened. All messages will be received
      • PCAN_FILTER_CUSTOM

        public static final TPCANParameterValue PCAN_FILTER_CUSTOM
        The PCAN filter is custom configured. Only registered messages will be received
      • PCAN_CHANNEL_UNAVAILABLE

        public static final TPCANParameterValue PCAN_CHANNEL_UNAVAILABLE
        The PCAN-Channel handle is illegal
      • PCAN_CHANNEL_AVAILABLE

        public static final TPCANParameterValue PCAN_CHANNEL_AVAILABLE
        The PCAN-Channel handle is valid to connect/initialize
      • PCAN_CHANNEL_OCCUPIED

        public static final TPCANParameterValue PCAN_CHANNEL_OCCUPIED
        The PCAN-Channel handle is valid, but is already being used
      • PCAN_CHANNEL_PCANVIEW

        public static final TPCANParameterValue PCAN_CHANNEL_PCANVIEW
        The PCAN-Channel handle is already being used by a PCAN-View application, but is available to connect
      • LOG_FUNCTION_DEFAULT

        public static final TPCANParameterValue LOG_FUNCTION_DEFAULT
        Logs system exceptions / errors
      • LOG_FUNCTION_ENTRY

        public static final TPCANParameterValue LOG_FUNCTION_ENTRY
        Logs the entries to the PCAN-Basic API functions
      • LOG_FUNCTION_PARAMETERS

        public static final TPCANParameterValue LOG_FUNCTION_PARAMETERS
        Logs the parameters passed to the PCAN-Basic API functions
      • LOG_FUNCTION_LEAVE

        public static final TPCANParameterValue LOG_FUNCTION_LEAVE
        Logs the exits from the PCAN-Basic API functions
      • LOG_FUNCTION_WRITE

        public static final TPCANParameterValue LOG_FUNCTION_WRITE
        Logs the CAN messages passed to the CAN_Write function
      • LOG_FUNCTION_READ

        public static final TPCANParameterValue LOG_FUNCTION_READ
        Logs the CAN messages received within the CAN_Read function
      • LOG_FUNCTION_ALL

        public static final TPCANParameterValue LOG_FUNCTION_ALL
        Logs all possible information within the PCAN-Basic API functions
      • TRACE_FILE_SINGLE

        public static final TPCANParameterValue TRACE_FILE_SINGLE
        A single file is written until it size reaches PCAN_TRACE_SIZE
      • TRACE_FILE_SEGMENTED

        public static final TPCANParameterValue TRACE_FILE_SEGMENTED
        Traced data is distributed in several files with size PCAN_TRACE_SIZE
      • TRACE_FILE_DATE

        public static final TPCANParameterValue TRACE_FILE_DATE
        Includes the date into the name of the trace file
      • TRACE_FILE_TIME

        public static final TPCANParameterValue TRACE_FILE_TIME
        Includes the start time into the name of the trace file
      • TRACE_FILE_OVERWRITE

        public static final TPCANParameterValue TRACE_FILE_OVERWRITE
        Causes the overwriting of available traces (same name)
      • TRACE_FILE_DATA_LENGTH

        public static final TPCANParameterValue TRACE_FILE_DATA_LENGTH
        Causes using the data length column ('l') instead of the DLC column ('L') in the trace file
      • FEATURE_FD_CAPABLE

        public static final TPCANParameterValue FEATURE_FD_CAPABLE
        Device supports flexible data-rate (CAN-FD)
      • FEATURE_DELAY_CAPABLE

        public static final TPCANParameterValue FEATURE_DELAY_CAPABLE
        Device supports a delay between sending frames (FPGA based USB devices)
      • FEATURE_IO_CAPABLE

        public static final TPCANParameterValue FEATURE_IO_CAPABLE
        Device supports I/O functionality for electronic circuits (USB-Chip devices)
      • SERVICE_STATUS_STOPPED

        public static final TPCANParameterValue SERVICE_STATUS_STOPPED
        The service is not running
      • SERVICE_STATUS_RUNNING

        public static final TPCANParameterValue SERVICE_STATUS_RUNNING
        The service is running
    • Field Detail

      • MAX_LENGTH_HARDWARE_NAME

        public static final int MAX_LENGTH_HARDWARE_NAME
        Maximum length of the name of a device: 32 characters + terminator
        See Also:
        Constant Field Values
      • MAX_LENGTH_VERSION_STRING

        public static final int MAX_LENGTH_VERSION_STRING
        Maximum length of a version string: 17 characters + terminator
        See Also:
        Constant Field Values
      • MIN_LENGTH_ERROR_STRING

        public static final int MIN_LENGTH_ERROR_STRING
        Recommended length for an error string: 255 characters + terminator
        See Also:
        Constant Field Values
    • Method Detail

      • values

        public static TPCANParameterValue[] 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 TPCANParameterValue 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 value of the CAN parameter's value
        Returns:
        Value of the CAN parameter's value
      • parseOnOff

        public static TPCANParameterValue parseOnOff​(int value)
        Parses a int value into the TPCANParameterValue PCAN_PARAMETER_ON or PCAN_PARAMETER_OFF
        Parameters:
        value - parsed value
        Returns:
        Corresponding TPCANParameterValue
      • parseCondition

        public static TPCANParameterValue parseCondition​(int value)
        Parses a int value into the TPCANParameterValue PCAN_CHANNEL_AVAILABLE, PCAN_CHANNEL_ILLEGAL, PCAN_CHANNEL_OCCUPIED or PCAN_CHANNEL_UNOCCUPIED
        Parameters:
        value - parsed value
        Returns:
        Corresponding TPCANParameterValue
      • parseFilterStatus

        public static TPCANParameterValue parseFilterStatus​(int value)
        Parses a int value into the TPCANParameterValue PCAN_FILTER_CLOSE, PCAN_FILTER_OPEN or PCAN_FILTER_CUSTOM.
        Parameters:
        value - parsed value
        Returns:
        Corresponding TPCANParameterValue
      • parseFeatures

        public static java.util.EnumSet<TPCANParameterValue> parseFeatures​(int value)
        Parses a int value into the TPCANParameterValue PCAN_CHANNEL_AVAILABLE, PCAN_CHANNEL_ILLEGAL, PCAN_CHANNEL_OCCUPIED or PCAN_CHANNEL_UNOCCUPIED
        Parameters:
        value - parsed value
        Returns:
        Corresponding TPCANParameterValue