Package org.apache.plc4x.java.s7.readwrite

Class S7PayloadUserDataItem

java.lang.Object

org.apache.plc4x.java.s7.readwrite.S7PayloadUserDataItem

All Implemented Interfaces:

Message, Serializable

Direct Known Subclasses:

S7PayloadAlarm8, S7PayloadAlarmAckInd, S7PayloadAlarmS, S7PayloadAlarmSC, S7PayloadAlarmSQ, S7PayloadDiagnosticMessage, S7PayloadNotify, S7PayloadNotify8, S7PayloadUserDataItemClkFRequest, S7PayloadUserDataItemClkFResponse, S7PayloadUserDataItemClkRequest, S7PayloadUserDataItemClkResponse, S7PayloadUserDataItemClkSetRequest, S7PayloadUserDataItemClkSetResponse, S7PayloadUserDataItemCpuFunctionAlarmAckErrorResponse, S7PayloadUserDataItemCpuFunctionAlarmAckRequest, S7PayloadUserDataItemCpuFunctionAlarmAckResponse, S7PayloadUserDataItemCpuFunctionAlarmQueryRequest, S7PayloadUserDataItemCpuFunctionAlarmQueryResponse, S7PayloadUserDataItemCpuFunctionMsgSubscriptionAlarmResponse, S7PayloadUserDataItemCpuFunctionMsgSubscriptionRequest, S7PayloadUserDataItemCpuFunctionMsgSubscriptionResponse, S7PayloadUserDataItemCpuFunctionMsgSubscriptionSysResponse, S7PayloadUserDataItemCpuFunctionReadSzlNoDataRequest, S7PayloadUserDataItemCpuFunctionReadSzlRequest, S7PayloadUserDataItemCpuFunctionReadSzlResponse, S7PayloadUserDataItemCyclicServicesChangeDrivenPush, S7PayloadUserDataItemCyclicServicesChangeDrivenSubscribeResponse, S7PayloadUserDataItemCyclicServicesErrorResponse, S7PayloadUserDataItemCyclicServicesPush, S7PayloadUserDataItemCyclicServicesSubscribeRequest, S7PayloadUserDataItemCyclicServicesSubscribeResponse, S7PayloadUserDataItemCyclicServicesUnsubscribeRequest, S7PayloadUserDataItemCyclicServicesUnsubscribeResponse

public abstract class S7PayloadUserDataItem
extends Object
implements Message

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	S7PayloadUserDataItem.S7PayloadUserDataItemBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected int	dataLength
protected DataTransportErrorCode	returnCode
protected DataTransportSize	transportSize

Constructor Summary

Constructors

Constructor	Description
S7PayloadUserDataItem(DataTransportErrorCode returnCode, DataTransportSize transportSize, int dataLength)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
abstract Byte	getCpuFunctionGroup()
abstract Byte	getCpuFunctionType()
abstract Short	getCpuSubfunction()
int	getDataLength()
int	getLengthInBits()
int	getLengthInBytes()
DataTransportErrorCode	getReturnCode()
DataTransportSize	getTransportSize()
int	hashCode()
void	serialize(WriteBuffer writeBuffer)
protected abstract void	serializeS7PayloadUserDataItemChild(WriteBuffer writeBuffer)
static S7PayloadUserDataItem	staticParse(ReadBuffer readBuffer, Byte cpuFunctionGroup, Byte cpuFunctionType, Short cpuSubfunction)
static S7PayloadUserDataItem	staticParse(ReadBuffer readBuffer, Object... args)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

returnCode

protected final DataTransportErrorCode returnCode

transportSize

protected final DataTransportSize transportSize

dataLength

protected final int dataLength

Constructor Detail

S7PayloadUserDataItem

public S7PayloadUserDataItem(DataTransportErrorCode returnCode,
                             DataTransportSize transportSize,
                             int dataLength)

Method Detail

getCpuFunctionGroup

public abstract Byte getCpuFunctionGroup()

getCpuFunctionType

public abstract Byte getCpuFunctionType()

getCpuSubfunction

public abstract Short getCpuSubfunction()

getReturnCode

public DataTransportErrorCode getReturnCode()

getTransportSize

public DataTransportSize getTransportSize()

getDataLength

public int getDataLength()

serializeS7PayloadUserDataItemChild

protected abstract void serializeS7PayloadUserDataItemChild(WriteBuffer writeBuffer)
                                                     throws SerializationException

Throws:

SerializationException

serialize

public void serialize(WriteBuffer writeBuffer)
               throws SerializationException

Specified by:

serialize in interface Serializable

Throws:

SerializationException

getLengthInBytes

public int getLengthInBytes()

Specified by:

getLengthInBytes in interface Message

getLengthInBits

public int getLengthInBits()

Specified by:

getLengthInBits in interface Message

staticParse

public static S7PayloadUserDataItem staticParse(ReadBuffer readBuffer,
                                                Object... args)
                                         throws ParseException

Throws:

ParseException

staticParse

public static S7PayloadUserDataItem staticParse(ReadBuffer readBuffer,
                                                Byte cpuFunctionGroup,
                                                Byte cpuFunctionType,
                                                Short cpuSubfunction)
                                         throws ParseException

Throws:

ParseException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object