Package org.netxms.client.datacollection
Class DciValue
java.lang.Object
org.netxms.client.datacollection.DciValue
- Direct Known Subclasses:
SimpleDciValue
,TableDciValue
DCI value
-
Field Summary
Modifier and TypeFieldDescriptionprotected Threshold
protected boolean
protected String
protected DataType
protected int
protected String
protected int
protected int
protected long
protected MeasurementUnit
protected int
static final int
static final int
static final int
protected String
protected long
protected boolean
protected DataOrigin
protected int
protected long
protected Date
protected String
-
Constructor Summary
ModifierConstructorDescriptionprotected
DciValue()
Simple constructor for DciValueprotected
DciValue
(NXCPMessage msg, long base) Constructor for creating DciValue from NXCP message -
Method Summary
Modifier and TypeMethodDescriptionstatic DciValue
createFromMessage
(NXCPMessage msg, long base) Factory method to create correct DciValue subclass from NXCP message.format
(String formatString, TimeFormatter formatter) Returns formated DCI value or string with format error and correct type of DCI value;Get DCI comments.int
Get DCi description.int
int
getFlags()
getFormattedValue
(boolean useMultipliers, TimeFormatter formatter) Returns formated DCI value or string with format error and correct type of DCI value;long
getId()
int
int
Get multipliers selection.getName()
long
int
final long
Get severity of active thresholdgetValue()
Get current (last collected) DCI value.boolean
boolean
toString()
-
Field Details
-
MULTIPLIERS_DEFAULT
public static final int MULTIPLIERS_DEFAULT- See Also:
-
MULTIPLIERS_YES
public static final int MULTIPLIERS_YES- See Also:
-
MULTIPLIERS_NO
public static final int MULTIPLIERS_NO- See Also:
-
id
protected long id -
nodeId
protected long nodeId -
templateDciId
protected long templateDciId -
name
-
description
-
value
-
comments
-
source
-
dataType
-
status
protected int status -
errorCount
protected int errorCount -
dcObjectType
protected int dcObjectType -
timestamp
-
activeThreshold
-
flags
protected int flags -
measurementUnit
-
multiplier
protected int multiplier -
noValueObject
protected boolean noValueObject -
anomalyDetected
protected boolean anomalyDetected
-
-
Constructor Details
-
DciValue
protected DciValue()Simple constructor for DciValue -
DciValue
Constructor for creating DciValue from NXCP message- Parameters:
msg
- NXCP messagebase
- Base field ID for value object
-
-
Method Details
-
createFromMessage
Factory method to create correct DciValue subclass from NXCP message.- Parameters:
msg
- NXCP messagebase
- Base variable ID for value object- Returns:
- DciValue object
-
format
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 valueformatter
- date/time formatter- Returns:
- The format
-
getFormattedValue
Returns formated DCI value or string with format error and correct type of DCI value;- Parameters:
useMultipliers
- the string into which will be placed DCI valueformatter
- date/time formatter- Returns:
- The format
-
getId
public long getId()- Returns:
- the id
-
getName
- Returns:
- the name
-
getDescription
Get DCi description.- Returns:
- DCI description
-
getValue
Get current (last collected) DCI value.- Returns:
- current DCI value
-
getComments
Get DCI comments.- Returns:
- DCI comments
-
getSource
- Returns:
- the source
-
getDataType
- Returns:
- the dataType
-
getStatus
public int getStatus()- Returns:
- the status
-
getTimestamp
- Returns:
- the timestamp
-
getNodeId
public long getNodeId()- Returns:
- the nodeId
-
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
Get severity of active threshold- Returns:
- severity of active threshold or NORMAL if there are no active thresholds
-
getFlags
public int getFlags()- Returns:
- the flags
-
getMultipliersSelection
public int getMultipliersSelection()Get multipliers selection.- Returns:
- multiplier usage mode (DEFAULT, YES, or NO)
-
getMostCriticalSeverity
- Returns:
- the mostCriticalSeverity
-
getMeasurementUnit
- Returns:
- the unitName
-
getMultiplier
public int getMultiplier()- Returns:
- the multiplier
-
isNoValueObject
public boolean isNoValueObject()- Returns:
- the noValueObject
-
isAnomalyDetected
public boolean isAnomalyDetected()- Returns:
- the anomalyDetected
-
toString
-