org.netxms.client.datacollection

Class DciValue

java.lang.Object

org.netxms.client.datacollection.DciValue

Direct Known Subclasses:

SimpleDciValue, TableDciValue

public abstract class DciValue
extends Object

DCI value

Field Summary

Fields

Modifier and Type	Field and Description
protected int	dataType
protected String	description
protected long	id
protected String	name
protected long	nodeId
protected int	source
protected int	status
protected String	value

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DciValue() Simple constructor for DciValue
protected	DciValue(long nodeId, org.netxms.base.NXCPMessage msg, long base) Constructor for creating DciValue from NXCP message

Method Summary

Modifier and Type	Method and Description
static DciValue	createFromMessage(long nodeId, org.netxms.base.NXCPMessage msg, long base) Factory method to create correct DciValue subclass from NXCP message.
String	format(String formatString) Returns formated DCI value or string with format error and correct type of DCI value;
Threshold	getActiveThreshold()
int	getDataType()
int	getDcObjectType()
String	getDescription()
int	getErrorCount()
long	getId()
String	getName()
long	getNodeId()
int	getSource()
int	getStatus()
long	getTemplateDciId()
Severity	getThresholdSeverity() Get severity of active threshold
Date	getTimestamp()
String	getValue()

Methods inherited from class java.lang.Object

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

Field Detail

id

protected long id

nodeId

protected long nodeId

name

protected String name

description

protected String description

value

protected String value

source

protected int source

dataType

protected int dataType

status

protected int status

Constructor Detail

DciValue

protected DciValue()

Simple constructor for DciValue

DciValue

protected DciValue(long nodeId,
                   org.netxms.base.NXCPMessage msg,
                   long base)

Constructor for creating DciValue from NXCP message

Parameters:

nodeId - owning node ID

msg - NXCP message

base - Base field ID for value object

Method Detail

createFromMessage

public static DciValue createFromMessage(long nodeId,
                                         org.netxms.base.NXCPMessage msg,
                                         long base)

Factory method to create correct DciValue subclass from NXCP message.

Parameters:

nodeId - owning node ID

msg - NXCP message

base - Base variable ID for value object

Returns:

DciValue object

format

public String format(String formatString)

Returns formated DCI value or string with format error and correct type of DCI value;

Parameters:

formatString - the string into which will be placed DCI value

Returns:

The format

getId

public long getId()

Returns:

the id

getName

public String getName()

Returns:

the name

getDescription

public String getDescription()

Returns:

the description

getValue

public String getValue()

Returns:

the value

getSource

public int getSource()

Returns:

the source

getDataType

public int getDataType()

Returns:

the dataType

getStatus

public int getStatus()

Returns:

the status

getTimestamp

public Date getTimestamp()

Returns:

the timestamp

getNodeId

public long getNodeId()

Returns:

the nodeId

getActiveThreshold

public Threshold getActiveThreshold()

Returns:

the activeThreshold

getDcObjectType

public int getDcObjectType()

Returns:

the dcObjectType

getErrorCount

public int getErrorCount()

Returns:

the errorCount

getTemplateDciId

public final long getTemplateDciId()

Returns:

the templateDciId

getThresholdSeverity

public Severity getThresholdSeverity()

Get severity of active threshold

Returns:

severity of active threshold or NORMAL if there are no active thresholds