Package eu.mihosoft.devcom

Interface PortConfig

All Superinterfaces:
Cloneable, eu.mihosoft.vmf.runtime.core.Immutable, eu.mihosoft.vmf.runtime.core.ReadOnly, ReadOnlyWithName, eu.mihosoft.vmf.runtime.core.VObject, WithName
All Known Implementing Classes:
PortConfigImpl
public interface PortConfig extends eu.mihosoft.vmf.runtime.core.VObject, ReadOnlyWithName, Cloneable, eu.mihosoft.vmf.runtime.core.Immutable
A representation of the immutable model object eu.mihosoft.devcom.PortConfig.

COM port configuration used to configure a physical or virtual COM port.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    PortConfig.Builder
     

    Nested classes/interfaces inherited from interface eu.mihosoft.devcom.WithName

    WithName.Behavior

  • Method Summary

    Modifier and Type
    Method
    Description
    PortConfig
    asReadOnly()
    Returns a read-only wrapper of 'PortConfig'.
    PortConfig
    clone()
    Returns a deep clone of this object.
    int
    getBaudRate()
    Returns the value of the 'baudRate' property.
    String
    getName()
    Returns the value of the 'name' property.
    int
    getNumberOfDataBits()
    Returns the value of the 'numberOfDataBits' property.
    ParityBits
    getParityBits()
    Returns the value of the 'parityBits' property.
    int
    getSafetyTimeout()
    Returns the value of the 'safetyTimeout' property.
    StopBits
    getStopBits()
    Returns the value of the 'stopBits' property.
    int
    getWriteTimeout()
    Returns the value of the 'writeTimeout' property.
    boolean
    isRS485ModeEnabled()
    Returns the value of the 'rS485ModeEnabled' property.
    static PortConfig.Builder
    newBuilder()
    Returns a new builder for creating a 'PortConfig' instance.
    static eu.mihosoft.vmf.runtime.core.Type
    type()
    Returns the Type object of this model type.

    Methods inherited from interface eu.mihosoft.vmf.runtime.core.ReadOnly

    asModifiable

    Methods inherited from interface eu.mihosoft.vmf.runtime.core.VObject

    vmf

  • Method Details

    • getBaudRate

      int getBaudRate()
      Returns the value of the 'baudRate' property.

      The baud rate used for sending and receiving data.

      Returns:
      the value of the 'baudRate' property.

    • getName

      String getName()
      Returns the value of the 'name' property.

      The port name used to identify the port, e.g. 'COM3'.

      Specified by:
      getName in interface ReadOnlyWithName
      Specified by:
      getName in interface WithName
      Returns:
      the value of the 'name' property.
      See Also:
      • eu.mihosoft.devcom.WithName#setName(java.lang.String)

    • getNumberOfDataBits

      int getNumberOfDataBits()
      Returns the value of the 'numberOfDataBits' property.

      The number of data bits (usually 8).

      Returns:
      the value of the 'numberOfDataBits' property.

    • getParityBits

      ParityBits getParityBits()
      Returns the value of the 'parityBits' property.

      The number of parity bits.

      Returns:
      the value of the 'parityBits' property.

    • isRS485ModeEnabled

      boolean isRS485ModeEnabled()
      Returns the value of the 'rS485ModeEnabled' property.

      Determines, whether RS485 mode should be enabled

      Returns:
      the value of the 'rS485ModeEnabled' property.

    • getSafetyTimeout

      int getSafetyTimeout()
      Returns the value of the 'safetyTimeout' property.

      Safety timeout used for opening the port (in milliseconds).

      Returns:
      the value of the 'safetyTimeout' property.

    • getStopBits

      StopBits getStopBits()
      Returns the value of the 'stopBits' property.

      The number of stop bits.

      Returns:
      the value of the 'stopBits' property.

    • getWriteTimeout

      int getWriteTimeout()
      Returns the value of the 'writeTimeout' property.

      Write timeout (in milliseconds).

      Returns:
      the value of the 'writeTimeout' property.

    • type

      static eu.mihosoft.vmf.runtime.core.Type type()
      Returns the Type object of this model type.
      Returns:
      Type object

    • newBuilder

      static PortConfig.Builder newBuilder()
      Returns a new builder for creating a 'PortConfig' instance.
      Returns:
      a new builder for creating a 'PortConfig' instance

    • asReadOnly

      PortConfig asReadOnly()
      Returns a read-only wrapper of 'PortConfig'. Since this model object is immutable this method does not perform any conversion and returns this object in unmodified form.
      Specified by:
      asReadOnly in interface ReadOnlyWithName
      Specified by:
      asReadOnly in interface eu.mihosoft.vmf.runtime.core.VObject
      Specified by:
      asReadOnly in interface WithName
      Returns:
      a read-only wrapper of 'PortConfig'

    • clone

      PortConfig clone()
      Returns a deep clone of this object.
      Specified by:
      clone in interface ReadOnlyWithName
      Specified by:
      clone in interface eu.mihosoft.vmf.runtime.core.VObject
      Specified by:
      clone in interface WithName
      Returns:
      a deep clone of this object