Package com.smartgridready.communicator.modbus.api

Interface ModbusGatewayRegistry

  • All Known Implementing Classes:
    SGrModbusGatewayRegistry
    public interface ModbusGatewayRegistry
    An interface for a Modbus gateway registry.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      ModbusGateway attachGateway​(com.smartgridready.ns.v0.ModbusInterfaceDescription interfaceDescription, com.smartgridready.driver.api.modbus.GenDriverAPI4ModbusFactory driverFactory, java.lang.String key)
      Uses or creates a Modbus transport gateway for a given device.
      void detachAllGateways()
      Disconnects all Modbus transport gateways.
      void detachGateway​(com.smartgridready.ns.v0.ModbusInterfaceDescription interfaceDescription, java.lang.String key)
      Disconnects the Modbus transport gateway of a given device.
      void detachGateway​(java.lang.String identifier, java.lang.String key)
      Disconnects the Modbus transport gateway of a given device.
      java.util.List<java.lang.String> getAllGatewayIdentifiers()
      Gets all transport identifiers.

    • Method Detail

      • attachGateway

        ModbusGateway attachGateway​(com.smartgridready.ns.v0.ModbusInterfaceDescription interfaceDescription,
                            com.smartgridready.driver.api.modbus.GenDriverAPI4ModbusFactory driverFactory,
                            java.lang.String key)
                     throws com.smartgridready.driver.api.common.GenDriverException
        Uses or creates a Modbus transport gateway for a given device.
        Parameters:
        interfaceDescription - the device's Modbus interface description
        driverFactory - the Modbus driver factory
        key - the unique device object key
        Returns:
        a Modbus gateway instance
        Throws:
        com.smartgridready.driver.api.common.GenDriverException - when the gateway could not be attached

      • detachGateway

        void detachGateway​(com.smartgridready.ns.v0.ModbusInterfaceDescription interfaceDescription,
                   java.lang.String key)
            throws com.smartgridready.driver.api.common.GenDriverException
        Disconnects the Modbus transport gateway of a given device.
        Parameters:
        interfaceDescription - the device's Modbus interface description
        key - the unique device object key
        Throws:
        com.smartgridready.driver.api.common.GenDriverException - when no gateway could be detached

      • detachGateway

        void detachGateway​(java.lang.String identifier,
                   java.lang.String key)
            throws com.smartgridready.driver.api.common.GenDriverException
        Disconnects the Modbus transport gateway of a given device.
        Parameters:
        identifier - the transport identifier
        key - the unique device object key
        Throws:
        com.smartgridready.driver.api.common.GenDriverException - when no gateway could be detached

      • detachAllGateways

        void detachAllGateways()
        Disconnects all Modbus transport gateways.

      • getAllGatewayIdentifiers

        java.util.List<java.lang.String> getAllGatewayIdentifiers()
        Gets all transport identifiers.
        Returns:
        a list of strings