kernel.modbus.StandaloneModbusPortConfiguration Class Reference

Inheritance diagram for kernel.modbus.StandaloneModbusPortConfiguration:

Collaboration diagram for kernel.modbus.StandaloneModbusPortConfiguration:

Public Member Functions
String	getPortName ()
void	setPortName (String portName)
int	getStopBits ()
void	setStopBits (int stopBits)
int	getParityBits ()
void	setParityBits (int parityBits)
int	getDataBits ()
void	setDataBits (int dataBits)
int	getBaudRate ()
void	setBaudRate (int baudRate)
String	getEncoding ()
void	setEncoding (String encoding)
SerialParameters	getSerialParameters ()

Additional Inherited Members
Public Attributes inherited from kernel.modbus.ModbusPortConfiguration
String	ASCII_ENCODING = Modbus.SERIAL_ENCODING_ASCII
String	RTU_ENCODING = Modbus.SERIAL_ENCODING_RTU
int	BAUD_RATE_19200 = 19200
Public Attributes inherited from kernel.serial_ports.PortConfiguration
int	DATABITS_8 = RXTXPort.DATABITS_8
int	BAUD_RATE_9600 = 9600
int	PARITY_NONE = RXTXPort.PARITY_NONE
int	STOPBITS_1 = RXTXPort.STOPBITS_1

Detailed Description

Contains methods required to configure a MODBUS serial port

Definition at line 9 of file StandaloneModbusPortConfiguration.java.

Member Function Documentation

int kernel.modbus.StandaloneModbusPortConfiguration.getBaudRate

(

)

Returns

The desired baud rate

Implements kernel.serial_ports.PortConfiguration.

Definition at line 110 of file StandaloneModbusPortConfiguration.java.

                            {
        return this.baudRate;
    }

int kernel.modbus.StandaloneModbusPortConfiguration.getDataBits

(

)

Returns

The desired number of parity bits

Implements kernel.serial_ports.PortConfiguration.

Definition at line 94 of file StandaloneModbusPortConfiguration.java.

                            {
        return this.dataBits;
    }

String kernel.modbus.StandaloneModbusPortConfiguration.getEncoding

(

)

Returns

The current character encoding

Implements kernel.modbus.ModbusPortConfiguration.

Definition at line 132 of file StandaloneModbusPortConfiguration.java.

                               {
        return this.encoding;
    }

int kernel.modbus.StandaloneModbusPortConfiguration.getParityBits

(

)

Returns

The number of parity bits

Implements kernel.serial_ports.PortConfiguration.

Definition at line 78 of file StandaloneModbusPortConfiguration.java.

                              {
        return this.parityBits;
    }

String kernel.modbus.StandaloneModbusPortConfiguration.getPortName

(

)

Returns

The port name

Implements kernel.modbus.ModbusPortConfiguration.

Definition at line 46 of file StandaloneModbusPortConfiguration.java.

                               {
        return this.portName;
    }

SerialParameters kernel.modbus.StandaloneModbusPortConfiguration.getSerialParameters

(

)

Returns

An instance of SerialParameters that contains the desired connection parameters.

Implements kernel.modbus.ModbusPortConfiguration.

Definition at line 149 of file StandaloneModbusPortConfiguration.java.

                                                 {
        SerialParameters parameters = new SerialParameters();

        parameters.setPortName(portName);
        parameters.setStopbits(stopBits);
        parameters.setParity(parityBits);
        parameters.setDatabits(dataBits);
        parameters.setBaudRate(baudRate);
        parameters.setEncoding(encoding);

        return parameters;
    }

int kernel.modbus.StandaloneModbusPortConfiguration.getStopBits

(

)

Returns

The number of stop bits

Implements kernel.serial_ports.PortConfiguration.

Definition at line 62 of file StandaloneModbusPortConfiguration.java.

                            {
        return this.stopBits;
    }

void kernel.modbus.StandaloneModbusPortConfiguration.setBaudRate

(

int

baudRate

)

Parameters

baudRate

The desired Baud rate

Implements kernel.modbus.ModbusPortConfiguration.

Definition at line 118 of file StandaloneModbusPortConfiguration.java.

                                         {
        if (baudRate <= 0){
            throw new IllegalArgumentException(
                    "Attempted to set a baud rate less than or equal to 0. " +
                            "This is not allowed"
            );
        }
        this.baudRate = baudRate;
    }

void kernel.modbus.StandaloneModbusPortConfiguration.setDataBits

(

int

dataBits

)

Parameters

dataBits

The data bits in an RS232 frame

Implements kernel.modbus.ModbusPortConfiguration.

Definition at line 102 of file StandaloneModbusPortConfiguration.java.

                                         {
        this.dataBits = dataBits;
    }

void kernel.modbus.StandaloneModbusPortConfiguration.setEncoding

(

String

encoding

)

Parameters

encoding

The string encoding to use

Implements kernel.modbus.ModbusPortConfiguration.

Definition at line 140 of file StandaloneModbusPortConfiguration.java.

                                            {
        this.encoding = encoding;
    }

void kernel.modbus.StandaloneModbusPortConfiguration.setParityBits

(

int

parityBits

)

Parameters

parityBits

The number of parity bits

Implements kernel.modbus.ModbusPortConfiguration.

Definition at line 86 of file StandaloneModbusPortConfiguration.java.

                                             {
        this.parityBits = parityBits;
    }

void kernel.modbus.StandaloneModbusPortConfiguration.setPortName

(

String

portName

)

Parameters

portName

The port name to use

Implements kernel.modbus.ModbusPortConfiguration.

Definition at line 54 of file StandaloneModbusPortConfiguration.java.

                                            {
        this.portName = portName;
    }

void kernel.modbus.StandaloneModbusPortConfiguration.setStopBits

(

int

stopBits

)

Parameters

stopBits

The number of stop bits in the RS232 connection

Implements kernel.modbus.ModbusPortConfiguration.

Definition at line 70 of file StandaloneModbusPortConfiguration.java.

                                         {
        this.stopBits = stopBits;
    }

---

The documentation for this class was generated from the following file:

• StandaloneModbusPortConfiguration.java