com.ghgande.j2mod.modbus.msg

Class ReadCommEventLogResponse

java.lang.Object

com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

com.ghgande.j2mod.modbus.msg.ModbusResponse

com.ghgande.j2mod.modbus.msg.ReadCommEventLogResponse

All Implemented Interfaces:

ModbusMessage

public class ReadCommEventLogResponse
extends ModbusResponse

Class implementing a ReadCommEventCounterResponse.

Version:

2.0 (March 2016)

Author:

Julie Haugh (jfh@ghgande.com), Steve O'Hara (4NG)

Nested Class Summary

Nested classes/interfaces inherited from class com.ghgande.j2mod.modbus.msg.ModbusResponse

ModbusResponse.AuxiliaryMessageTypes

Constructor Summary

Constructors

Constructor and Description
ReadCommEventLogResponse() Constructs a new ReadCommEventLogResponse instance.

Method Summary

Modifier and Type	Method and Description
int	getEvent(int index) getEvent -- get an event from the event log.
int	getEventCount() getEvents -- get device's event counter.
byte[]	getEvents()
byte[]	getMessage() getMessage -- format the message into a byte array.
int	getMessageCount() getMessageCount -- get device's message counter.
int	getStatus() getStatus -- get the device's status.
void	readData(DataInput din) readData -- input the Modbus message from din.
void	setEvent(int index, int event) setEvent -- store an event number in the event log
void	setEventCount(int count) setEventCount -- set the device's event counter.
void	setEvents(byte[] events)
void	setEvents(int count)
void	setMessageCount(int count) setMessageCount -- set device's message counter.
void	setStatus(int status) setStatus -- set the device's status.
void	writeData(DataOutput dout) writeData -- output the completed Modbus message to dout

Methods inherited from class com.ghgande.j2mod.modbus.msg.ModbusResponse

createModbusResponse, getAuxiliaryType, setAuxiliaryType

Methods inherited from class com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

getDataLength, getFunctionCode, getHexMessage, getOutputLength, getProtocolID, getTransactionID, getUnitID, isHeadless, readFrom, setDataLength, setHeadless, setHeadless, setProtocolID, setTransactionID, setUnitID, writeTo

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReadCommEventLogResponse

public ReadCommEventLogResponse()

Constructs a new ReadCommEventLogResponse instance.

Method Detail

getStatus

public int getStatus()

getStatus -- get the device's status.

Returns:

int

setStatus

public void setStatus(int status)

setStatus -- set the device's status.

Parameters:

status - Status to set

getEventCount

public int getEventCount()

getEvents -- get device's event counter.

Returns:

Number of events

setEventCount

public void setEventCount(int count)

setEventCount -- set the device's event counter.

Parameters:

count - Set the event count

getMessageCount

public int getMessageCount()

getMessageCount -- get device's message counter.

Returns:

Number of messages

setMessageCount

public void setMessageCount(int count)

setMessageCount -- set device's message counter.

Parameters:

count - Number of messages

getEvent

public int getEvent(int index)

getEvent -- get an event from the event log.

Parameters:

index - Index of the event

Returns:

Event ID

getEvents

public byte[] getEvents()

setEvents

public void setEvents(byte[] events)

setEvents

public void setEvents(int count)

setEvent

public void setEvent(int index,
                     int event)

setEvent -- store an event number in the event log

Parameters:

index - Event position

event - Event ID

writeData

public void writeData(DataOutput dout)
               throws IOException

writeData -- output the completed Modbus message to dout

Specified by:

writeData in class ModbusMessageImpl

Parameters:

dout - the DataOutput to be written to.

Throws:

IOException - If the data cannot be written

readData

public void readData(DataInput din)
              throws IOException

readData -- input the Modbus message from din. If there was a header, such as for Modbus/TCP, it will have been read already.

Specified by:

readData in class ModbusMessageImpl

Parameters:

din - the DataInput to read from.

Throws:

IOException - If the data cannot be read

getMessage

public byte[] getMessage()

getMessage -- format the message into a byte array.

Returns:

Response as byte array