Package org.netxms.client.datacollection

Class MeasurementUnit

java.lang.Object

org.netxms.client.datacollection.MeasurementUnit

public class MeasurementUnit
extends Object

Represents measurement unit information.

Field Summary

Fields

Modifier and Type	Field	Description
static final MeasurementUnit	BPS_IEC
static final MeasurementUnit	BPS_METRIC
static final MeasurementUnit	BYTES_IEC
static final MeasurementUnit	BYTES_METRIC
static final MeasurementUnit	HZ
static final Set<String>	UNITS_WITHOUT_MULTIPLIERS

Constructor Summary

Constructors

Constructor	Description
MeasurementUnit(String name)	Create measurement unit from scratch with automatically calculated multiplier power
MeasurementUnit(String name, int multiplierPower)	Create measurement unit from scratch
MeasurementUnit(NXCPMessage msg, long baseId)	Create measurement unit object from NXCP message.

Method Summary

Modifier and Type	Method	Description
int	getMultipierPower()	Get fixed multiplier power.
String	getName()	Get unit name.
boolean	isBinary()	Check if unit uses binary (IEC) multipliers
String	toString()
boolean	useMultiplierForUnit()	If small multipliers should be used for current unit

Methods inherited from class java.lang.Object

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

Field Details

BYTES_IEC

public static final MeasurementUnit BYTES_IEC

BYTES_METRIC

public static final MeasurementUnit BYTES_METRIC

BPS_IEC

public static final MeasurementUnit BPS_IEC

BPS_METRIC

public static final MeasurementUnit BPS_METRIC

HZ

public static final MeasurementUnit HZ

UNITS_WITHOUT_MULTIPLIERS

public static final Set<String> UNITS_WITHOUT_MULTIPLIERS

Constructor Details

MeasurementUnit

public MeasurementUnit(String name,
 int multiplierPower)

Create measurement unit from scratch

Parameters:

name - unit name

multiplierPower - multiplier power (0 for automatically calculated)

MeasurementUnit

public MeasurementUnit(String name)

Create measurement unit from scratch with automatically calculated multiplier power

Parameters:

name - unit name

MeasurementUnit

public MeasurementUnit(NXCPMessage msg,
 long baseId)

Create measurement unit object from NXCP message.

Parameters:

msg - NXCP message

baseId - base field ID

Method Details

getName

public String getName()

Get unit name.

Returns:

unit name

isBinary

public boolean isBinary()

Check if unit uses binary (IEC) multipliers

Returns:

true if unit uses binary multipliers

getMultipierPower

public int getMultipierPower()

Get fixed multiplier power.

Returns:

fixed multiplier power or 0 if automatic multiplier power selection should be used

useMultiplierForUnit

public boolean useMultiplierForUnit()

If small multipliers should be used for current unit

Returns:

true if small multipliers can be used for current unit

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()