Package jisa.addresses

Class ModbusAddress

  • All Implemented Interfaces:
    Address
    public class ModbusAddress
extends java.lang.Object
implements Address

    • Field Summary

    • Constructor Summary

      Constructors 
      Constructor Description
      ModbusAddress()  
      ModbusAddress​(java.lang.String portName, int address)  
      ModbusAddress​(java.util.Map<java.lang.String,​java.lang.Object> parameters)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getAddress()  
      java.util.Map<java.lang.String,​java.lang.Object> getParameters()
      Returns a map of this address' configurable parameters.
      java.lang.String getPortName()  
      java.lang.String getTypeName()
      Returns a textual representation of this address' type.
      java.lang.String getVISAString()
      Returns the standard VISA text representation of this address.
      void parseString​(java.lang.String text)
      Parses a text representation of this type of address, setting its parameters based on those in the text.
      void setAddress​(int address)  
      void setParameters​(java.util.Map<java.lang.String,​java.lang.Object> parameters)
      Set the parameters of this address from a given map.
      void setPortName​(java.lang.String portName)  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • ModbusAddress

        public ModbusAddress()

      • ModbusAddress

        public ModbusAddress​(java.lang.String portName,
                     int address)

      • ModbusAddress

        public ModbusAddress​(java.util.Map<java.lang.String,​java.lang.Object> parameters)

    • Method Detail

      • getPortName

        public java.lang.String getPortName()

      • setPortName

        public void setPortName​(java.lang.String portName)

      • getAddress

        public int getAddress()

      • setAddress

        public void setAddress​(int address)

      • getTypeName

        public java.lang.String getTypeName()
        Description copied from interface: Address
        Returns a textual representation of this address' type.
        Specified by:
        getTypeName in interface Address
        Returns:
        Type of address

      • getVISAString

        public java.lang.String getVISAString()
        Description copied from interface: Address
        Returns the standard VISA text representation of this address.
        Specified by:
        getVISAString in interface Address
        Returns:
        VISA text representation

      • getParameters

        public java.util.Map<java.lang.String,​java.lang.Object> getParameters()
        Description copied from interface: Address
        Returns a map of this address' configurable parameters.
        Specified by:
        getParameters in interface Address
        Returns:
        Map of parameters

      • setParameters

        public void setParameters​(java.util.Map<java.lang.String,​java.lang.Object> parameters)
        Description copied from interface: Address
        Set the parameters of this address from a given map.
        Specified by:
        setParameters in interface Address
        Parameters:
        parameters - Map of parameters to set

      • parseString

        public void parseString​(java.lang.String text)
                 throws InvalidAddressFormatException
        Description copied from interface: Address
        Parses a text representation of this type of address, setting its parameters based on those in the text.
        Specified by:
        parseString in interface Address
        Parameters:
        text - VISA/JISA text representation
        Throws:
        InvalidAddressFormatException - If the text representation is not formatted properly for this address type

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object