Package org.openmuc.jdlms

Class SnWriteParameter

java.lang.Object

org.openmuc.jdlms.SnWriteParameter

public class SnWriteParameter
extends java.lang.Object

This class represents the the struct of parameters used to invoke the DLMS write service.

Method Summary

Modifier and Type	Method	Description
T	getAddress()	Get the address of the element to be modified.
DataObject	getData()	The new data to set.
static SnWriteParameter	newAttributeWriteParameter(int attributeAddress, DataObject data)	Create a new write parameter to alter the value of a COSEM attribute.
static SnWriteParameter	newAttributeWriteParameter(SnAddressSpec attributeAddress, DataObject data)	Create a new write parameter to alter the value of a COSEM attribute.
static SnWriteParameter	newMethodWriteParameter(int methodName)	Create a new write parameter to invoke a COSEM method with no arguments and no return value.
static SnWriteParameter	newMethodWriteParameter(int methodName, DataObject invocationParameter)	Create a new write parameter to invoke a COSEM method with arguments, but no return value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

newAttributeWriteParameter

public static SnWriteParameter newAttributeWriteParameter(SnAddressSpec attributeAddress,
                                                          DataObject data)

Create a new write parameter to alter the value of a COSEM attribute.

Parameters:

attributeAddress - the address specification of the attribute.

data - the data to be set.

Returns:

the new write parameter.

newAttributeWriteParameter

public static SnWriteParameter newAttributeWriteParameter(int attributeAddress,
                                                          DataObject data)

Create a new write parameter to alter the value of a COSEM attribute.

Parameters:

attributeAddress - the address specification of the attribute.

data - the data to be set.

Returns:

the new write parameter.

newMethodWriteParameter

public static SnWriteParameter newMethodWriteParameter(int methodName)

Create a new write parameter to invoke a COSEM method with no arguments and no return value.

Parameters:

methodName - the short name of the method.

Returns:

the new write parameter.

newMethodWriteParameter

public static SnWriteParameter newMethodWriteParameter(int methodName,
                                                       DataObject invocationParameter)

Create a new write parameter to invoke a COSEM method with arguments, but no return value.

Parameters:

methodName - the short name of the method.

invocationParameter - the method invocation parameter.

Returns:

the new write parameter.

getData

public DataObject getData()

The new data to set.

Returns:

the data.

getAddress

public T getAddress()

Get the address of the element to be modified.

Returns:

the address.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object