org.netxms.base

Class NXCPMessageField

java.lang.Object

org.netxms.base.NXCPMessageField

public class NXCPMessageField
extends Object

NXCP message field (variable)

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_BINARY
static int	TYPE_FLOAT
static int	TYPE_INETADDR
static int	TYPE_INT16
static int	TYPE_INT64
static int	TYPE_INTEGER
static int	TYPE_STRING

Constructor Summary

Constructors

Constructor and Description
NXCPMessageField(byte[] nxcpDataField) Create NXCPVariable from NXCP message data field
NXCPMessageField(long varId, byte[] value)
NXCPMessageField(long varId, Double value)
NXCPMessageField(long varId, InetAddress value)
NXCPMessageField(long varId, InetAddressEx value)
NXCPMessageField(long varId, int varType, Long value)
NXCPMessageField(long varId, long[] value) Create binary variable from long[]
NXCPMessageField(long varId, Long[] value) Create binary variable from Long[]
NXCPMessageField(long varId, String value)
NXCPMessageField(long varId, UUID value)

Method Summary

Modifier and Type	Method and Description
byte[]	createNXCPDataField() Create NXCP DF structure
byte[]	getAsBinary() Get variable's value as byte array
InetAddress	getAsInetAddress() Get field's value as IP address
InetAddressEx	getAsInetAddressEx() Get field's value as IP address/mask pair
Long	getAsInteger() Get variable's value as long integer
Double	getAsReal() Get variable's value as floating point number
String	getAsString() Get variable's value as string
long[]	getAsUInt32Array() Get variable's value as array of long integers.
Long[]	getAsUInt32ArrayEx() Get variable's value as array of long integers.
UUID	getAsUUID() Get variable's value as UUID
long	getVariableId()
int	getVariableType()
void	setVariableId(long variableId)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_INTEGER

public static final int TYPE_INTEGER

See Also:

Constant Field Values

TYPE_STRING

public static final int TYPE_STRING

See Also:

Constant Field Values

TYPE_INT64

public static final int TYPE_INT64

See Also:

Constant Field Values

TYPE_INT16

public static final int TYPE_INT16

See Also:

Constant Field Values

TYPE_BINARY

public static final int TYPE_BINARY

See Also:

Constant Field Values

TYPE_FLOAT

public static final int TYPE_FLOAT

See Also:

Constant Field Values

TYPE_INETADDR

public static final int TYPE_INETADDR

See Also:

Constant Field Values

Constructor Detail

NXCPMessageField

public NXCPMessageField(long varId,
                        int varType,
                        Long value)

Parameters:

varId -

varType -

value -

NXCPMessageField

public NXCPMessageField(long varId,
                        String value)

Parameters:

varId -

value -

NXCPMessageField

public NXCPMessageField(long varId,
                        Double value)

Parameters:

varId -

value -

NXCPMessageField

public NXCPMessageField(long varId,
                        byte[] value)

Parameters:

varId -

value -

NXCPMessageField

public NXCPMessageField(long varId,
                        long[] value)

Create binary variable from long[]

Parameters:

varId - Variable ID

value - Value

NXCPMessageField

public NXCPMessageField(long varId,
                        Long[] value)

Create binary variable from Long[]

Parameters:

varId - Variable ID

value - Value

NXCPMessageField

public NXCPMessageField(long varId,
                        InetAddress value)

Parameters:

varId -

value -

NXCPMessageField

public NXCPMessageField(long varId,
                        InetAddressEx value)

Parameters:

varId -

value -

NXCPMessageField

public NXCPMessageField(long varId,
                        UUID value)

Parameters:

varId -

value -

NXCPMessageField

public NXCPMessageField(byte[] nxcpDataField)
                 throws IOException

Create NXCPVariable from NXCP message data field

Parameters:

nxcpDataField -

Throws:

IOException

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getAsInteger

public Long getAsInteger()

Get variable's value as long integer

Returns:

Variable's value as long integer

getAsReal

public Double getAsReal()

Get variable's value as floating point number

Returns:

Variable's value as floating point number

getAsString

public String getAsString()

Get variable's value as string

Returns:

Variable's value as string

getAsBinary

public byte[] getAsBinary()

Get variable's value as byte array

Returns:

Variable's value as byte array

getAsInetAddress

public InetAddress getAsInetAddress()

Get field's value as IP address

Returns:

Field's value as IP address

getAsInetAddressEx

public InetAddressEx getAsInetAddressEx()

Get field's value as IP address/mask pair

Returns:

Field's value as IP address/mask pair

getAsUUID

public UUID getAsUUID()

Get variable's value as UUID

Returns:

Variable's value as UUID

getAsUInt32Array

public long[] getAsUInt32Array()

Get variable's value as array of long integers. Variable should be of binary type, and integer values should be packet as DWORD's in network byte order.

Returns:

Variable's value as array of long integers

getAsUInt32ArrayEx

public Long[] getAsUInt32ArrayEx()

Get variable's value as array of long integers. Variable should be of binary type, and integer values should be packet as DWORD's in network byte order.

Returns:

Variable's value as array of long integers

getVariableId

public long getVariableId()

Returns:

the variableId

setVariableId

public void setVariableId(long variableId)

Parameters:

variableId - the variableId to set

getVariableType

public int getVariableType()

Returns:

the variableType

createNXCPDataField

public byte[] createNXCPDataField()
                           throws IOException

Create NXCP DF structure

Returns:

encoded NXCP data field as byte array

Throws:

IOException