Class SimDeviceJNI

    • Constructor Detail

      • SimDeviceJNI

        public SimDeviceJNI()
    • Method Detail

      • createSimDevice

        public static int createSimDevice​(String name)
        Creates a simulated device.

        The device name must be unique. 0 is returned if the device name already exists. If multiple instances of the same device are desired, recommend appending the instance/unique identifer in brackets to the base name, e.g. "device[1]".

        0 is returned if not in simulation.

        Parameters:
        name - device name
        Returns:
        simulated device handle
      • freeSimDevice

        public static void freeSimDevice​(int handle)
        Frees a simulated device.

        This also allows the same device name to be used again. This also frees all the simulated values created on the device.

        Parameters:
        handle - simulated device handle
      • createSimValue

        public static int createSimValue​(int device,
                                         String name,
                                         boolean readonly,
                                         HALValue initialValue)
        Creates a value on a simulated device.

        Returns 0 if not in simulation; this can be used to avoid calls to Set/Get functions.

        Parameters:
        device - simulated device handle
        name - value name
        readonly - if the value should not be written from simulation side
        initialValue - initial value
        Returns:
        simulated value handle
      • createSimValueDouble

        public static int createSimValueDouble​(int device,
                                               String name,
                                               boolean readonly,
                                               double initialValue)
        Creates a double value on a simulated device.

        Returns 0 if not in simulation; this can be used to avoid calls to Set/Get functions.

        Parameters:
        device - simulated device handle
        name - value name
        readonly - if the value should not be written from simulation side
        initialValue - initial value
        Returns:
        simulated value handle
      • createSimValueEnum

        public static int createSimValueEnum​(int device,
                                             String name,
                                             boolean readonly,
                                             String[] options,
                                             int initialValue)
        Creates an enumerated value on a simulated device.

        Enumerated values are always in the range 0 to numOptions-1.

        Returns 0 if not in simulation; this can be used to avoid calls to Set/Get functions.

        Parameters:
        device - simulated device handle
        name - value name
        readonly - if the value should not be written from simulation side
        options - array of option descriptions
        initialValue - initial value (selection)
        Returns:
        simulated value handle
      • createSimValueBoolean

        public static int createSimValueBoolean​(int device,
                                                String name,
                                                boolean readonly,
                                                boolean initialValue)
        Creates a boolean value on a simulated device.

        Returns 0 if not in simulation; this can be used to avoid calls to Set/Get functions.

        Parameters:
        device - simulated device handle
        name - value name
        readonly - if the value should not be written from simulation side
        initialValue - initial value
        Returns:
        simulated value handle
      • getSimValue

        public static HALValue getSimValue​(int handle)
        Gets a simulated value.
        Parameters:
        handle - simulated value handle
        Returns:
        The current value
      • getSimValueDouble

        public static double getSimValueDouble​(int handle)
        Gets a simulated value (double).
        Parameters:
        handle - simulated value handle
        Returns:
        The current value
      • getSimValueEnum

        public static int getSimValueEnum​(int handle)
        Gets a simulated value (enum).
        Parameters:
        handle - simulated value handle
        Returns:
        The current value
      • getSimValueBoolean

        public static boolean getSimValueBoolean​(int handle)
        Gets a simulated value (boolean).
        Parameters:
        handle - simulated value handle
        Returns:
        The current value
      • setSimValue

        public static void setSimValue​(int handle,
                                       HALValue value)
        Sets a simulated value.
        Parameters:
        handle - simulated value handle
        value - the value to set
      • setSimValueDouble

        public static void setSimValueDouble​(int handle,
                                             double value)
        Sets a simulated value (double).
        Parameters:
        handle - simulated value handle
        value - the value to set
      • setSimValueEnum

        public static void setSimValueEnum​(int handle,
                                           int value)
        Sets a simulated value (enum).
        Parameters:
        handle - simulated value handle
        value - the value to set
      • setSimValueBoolean

        public static void setSimValueBoolean​(int handle,
                                              boolean value)
        Sets a simulated value (boolean).
        Parameters:
        handle - simulated value handle
        value - the value to set