Package org.netxms.client.objects

Class Sensor

java.lang.Object

org.netxms.client.objects.AbstractObject

org.netxms.client.objects.GenericObject

org.netxms.client.objects.DataCollectionTarget

org.netxms.client.objects.Sensor

All Implemented Interfaces:

PollingTarget

public class Sensor
extends DataCollectionTarget
implements PollingTarget

Mobile device object

Field Summary

Fields

Modifier and Type	Field	Description
static int	COMM_DLMS
static int	COMM_LORAWAN
static String[]	COMM_METHOD
static String[]	DEV_CLASS_NAMES
protected org.netxms.base.MacAddress	macAddress
static int	SENSOR_ACTIVE
static int	SENSOR_CLASS_UNKNOWN	Sensor device class
static int	SENSOR_CONF_UPDATE_PENDING
static int	SENSOR_ELECTR_METER
static int	SENSOR_PROTO_UNKNOWN	Sensor communication protocol type
static int	SENSOR_PROVISIONED	Sensor flags
static int	SENSOR_REGISTERED
static int	SENSOR_UPS
static int	SENSOR_WATER_METER

Fields inherited from class org.netxms.client.objects.DataCollectionTarget

DCF_DISABLE_CONF_POLL, DCF_DISABLE_DATA_COLLECT, DCF_DISABLE_STATUS_POLL, DCSF_NETWORK_PATH_PROBLEM, DCSF_UNREACHABLE, overviewDciData, tooltipDciData

Fields inherited from class org.netxms.client.objects.AbstractObject

accessList, backupZoneProxyId, BUSINESSSERVICEROOT, CALCULATE_DEFAULT, CALCULATE_MOST_CRITICAL, CALCULATE_MULTIPLE_THRESHOLDS, CALCULATE_SINGLE_THRESHOLD, children, comments, creationTime, customAttributes, DASHBOARDROOT, dashboards, drillDownObjectId, fixedPropagatedStatus, geolocation, guid, image, inheritAccessRights, inMaintenanceMode, isDeleted, moduleData, NETWORK, NETWORKMAPROOT, OBJECT_ACCESSPOINT, OBJECT_AGENTPOLICY, OBJECT_AGENTPOLICY_CONFIG, OBJECT_AGENTPOLICY_LOGPARSER, OBJECT_BUSINESSSERVICE, OBJECT_BUSINESSSERVICEROOT, OBJECT_CHASSIS, OBJECT_CLUSTER, OBJECT_CONDITION, OBJECT_CONTAINER, OBJECT_CUSTOM, OBJECT_DASHBOARD, OBJECT_DASHBOARDGROUP, OBJECT_DASHBOARDROOT, OBJECT_GENERIC, OBJECT_INTERFACE, OBJECT_MOBILEDEVICE, OBJECT_NETWORK, OBJECT_NETWORKMAP, OBJECT_NETWORKMAPGROUP, OBJECT_NETWORKMAPROOT, OBJECT_NETWORKSERVICE, OBJECT_NODE, OBJECT_NODELINK, OBJECT_POLICYGROUP, OBJECT_POLICYROOT, OBJECT_RACK, OBJECT_SENSOR, OBJECT_SERVICEROOT, OBJECT_SLMCHECK, OBJECT_SUBNET, OBJECT_TEMPLATE, OBJECT_TEMPLATEGROUP, OBJECT_TEMPLATEROOT, OBJECT_VPNCONNECTOR, OBJECT_ZONE, objectClass, objectId, objectName, parents, POLICYROOT, postalAddress, primaryZoneProxyId, PROPAGATE_DEFAULT, PROPAGATE_FIXED, PROPAGATE_RELATIVE, PROPAGATE_TRANSLATED, PROPAGATE_UNCHANGED, REPORTROOT, responsibleUsers, SERVICEROOT, session, status, statusCalculationMethod, statusPropagationMethod, statusShift, statusSingleThreshold, statusThresholds, statusTransformation, TEMPLATEROOT, trustedNodes, urls, ZONE0

Constructor Summary

Constructors

Constructor	Description
Sensor(org.netxms.base.NXCPMessage msg, NXCSession session)	Object constructor from message

Method Summary

Modifier and Type	Method	Description
boolean	canHaveAgent()	Identify if this object can have NetXMS agent.
boolean	canHaveInterfaces()	Identify if this object can have network interfaces.
boolean	canHavePollerNode()	Identify if this object can have poller node property.
boolean	canUseEtherNetIP()	Identify if this object can use EtherNet/IP for communications.
AgentCacheMode	getAgentCacheMode()	Get agent cache mode.
int	getCommProtocol()
SensorConfig	getConfig()
String	getDescription()
String	getDeviceAddress()
int	getDeviceClass()
int	getFlags()	Get object flags.
int	getFrameCount()
int	getFrequency()
int	getIfXTablePolicy()	Get ifXTable usage policy.
Date	getLastConnectionTime()
org.netxms.base.MacAddress	getMacAddress()
String	getMetaType()
String	getObjectClassName()
long	getPollerNodeId()	Get poller node ID.
long	getProxyId()
SensorRegistrationConfig	getRegConfig()
String	getSerialNumber()
int	getSignalNoise()
int	getSignalStrenght()
Set<String>	getStrings()	Get all strings in object
String	getVendor()
boolean	isAlarmsVisible()	If this method returns true object can have visible alarms.
boolean	isAllowedOnMap()	If this method returns true object is allowed to be on custom network map.

Methods inherited from class org.netxms.client.objects.DataCollectionTarget

getOverviewDciData, getTooltipDciData

Methods inherited from class org.netxms.client.objects.AbstractObject

addString, getAccessList, getAllChildren, getAllChildren, getAllParents, getAllParents, getBackupZoneProxyId, getChildIdList, getChildren, getChildrenAsArray, getComments, getCreationTime, getCustomAttribute, getCustomAttributes, getCustomAttributeValue, getDashboards, getDrillDownObjectId, getEffectiveRights, getFixedPropagatedStatus, getGeolocation, getGuid, getImage, getModuleData, getObjectClass, getObjectId, getObjectName, getParentCount, getParentIdList, getParents, getParentsAsArray, getPostalAddress, getPrimaryZoneProxyId, getResponsibleUsers, getStatus, getStatusCalculationMethod, getStatusPropagationMethod, getStatusShift, getStatusSingleThreshold, getStatusThresholds, getStatusTransformation, getTrustedNodes, getUrls, hasAccessibleChildren, hasChildren, hashCode, hasParents, hasUrls, isChildOf, isChildOf, isDefaultImage, isDeleted, isDirectChildOf, isDirectParentOf, isInheritAccessRights, isInMaintenanceMode, isParentOf, isParentOf, setSession

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.netxms.client.objects.PollingTarget

getObjectId, getObjectName

Field Detail

SENSOR_PROVISIONED

public static final int SENSOR_PROVISIONED

Sensor flags

See Also:

Constant Field Values

SENSOR_REGISTERED

public static final int SENSOR_REGISTERED

See Also:

Constant Field Values

SENSOR_ACTIVE

public static final int SENSOR_ACTIVE

See Also:

Constant Field Values

SENSOR_CONF_UPDATE_PENDING

public static final int SENSOR_CONF_UPDATE_PENDING

See Also:

Constant Field Values

SENSOR_PROTO_UNKNOWN

public static final int SENSOR_PROTO_UNKNOWN

Sensor communication protocol type

See Also:

Constant Field Values

COMM_LORAWAN

public static final int COMM_LORAWAN

See Also:

Constant Field Values

COMM_DLMS

public static final int COMM_DLMS

See Also:

Constant Field Values

COMM_METHOD

public static final String[] COMM_METHOD

SENSOR_CLASS_UNKNOWN

public static final int SENSOR_CLASS_UNKNOWN

Sensor device class

See Also:

Constant Field Values

SENSOR_UPS

public static final int SENSOR_UPS

See Also:

Constant Field Values

SENSOR_WATER_METER

public static final int SENSOR_WATER_METER

See Also:

Constant Field Values

SENSOR_ELECTR_METER

public static final int SENSOR_ELECTR_METER

See Also:

Constant Field Values

DEV_CLASS_NAMES

public static final String[] DEV_CLASS_NAMES

macAddress

protected org.netxms.base.MacAddress macAddress

Constructor Detail

Sensor

public Sensor(org.netxms.base.NXCPMessage msg,
              NXCSession session)

Object constructor from message

Parameters:

msg -

session -

Method Detail

isAllowedOnMap

public boolean isAllowedOnMap()

Description copied from class: AbstractObject

If this method returns true object is allowed to be on custom network map. Default implementation always returns false.

Overrides:

isAllowedOnMap in class AbstractObject

Returns:

true if object is allowed to be on custom network map

isAlarmsVisible

public boolean isAlarmsVisible()

Description copied from class: AbstractObject

If this method returns true object can have visible alarms. Default implementation always returns false.

Overrides:

isAlarmsVisible in class AbstractObject

Returns:

true if object can contain visible alarms

getObjectClassName

public String getObjectClassName()

Overrides:

getObjectClassName in class AbstractObject

Returns:

Name of NetXMS object's class

getStrings

public Set<String> getStrings()

Description copied from class: AbstractObject

Get all strings in object

Overrides:

getStrings in class AbstractObject

Returns:

set of all strings in object

getVendor

public final String getVendor()

Returns:

the vendor

getSerialNumber

public final String getSerialNumber()

Returns:

the serialNumber

getFlags

public int getFlags()

Description copied from interface: PollingTarget

Get object flags.

Specified by:

getFlags in interface PollingTarget

Returns:

the flags

getMacAddress

public org.netxms.base.MacAddress getMacAddress()

Returns:

the macAddress

getFrameCount

public int getFrameCount()

Returns:

the frameCount

getSignalStrenght

public int getSignalStrenght()

Returns:

the signalStrenght

getFrequency

public int getFrequency()

Returns:

the frequency

getDeviceClass

public int getDeviceClass()

Returns:

the deviceClass

getCommProtocol

public int getCommProtocol()

Returns:

the commProtocol

getDeviceAddress

public String getDeviceAddress()

Returns:

the deviceAddress

getMetaType

public String getMetaType()

Returns:

the metaType

getDescription

public String getDescription()

Returns:

the description

getLastConnectionTime

public Date getLastConnectionTime()

Returns:

the lastConnectionTime

getProxyId

public long getProxyId()

Returns:

the proxyId

getSignalNoise

public int getSignalNoise()

Returns:

the signalNoise

getRegConfig

public SensorRegistrationConfig getRegConfig()

Returns:

the regConfig

getConfig

public SensorConfig getConfig()

Returns:

the config

getIfXTablePolicy

public int getIfXTablePolicy()

Description copied from interface: PollingTarget

Get ifXTable usage policy.

Specified by:

getIfXTablePolicy in interface PollingTarget

Returns:

ifXTable usage policy

getAgentCacheMode

public AgentCacheMode getAgentCacheMode()

Description copied from interface: PollingTarget

Get agent cache mode.

Specified by:

getAgentCacheMode in interface PollingTarget

Returns:

agent cache mode

See Also:

PollingTarget.getAgentCacheMode()

getPollerNodeId

public long getPollerNodeId()

Description copied from interface: PollingTarget

Get poller node ID.

Specified by:

getPollerNodeId in interface PollingTarget

Returns:

poller node ID or 0 if object cannot have poler node

See Also:

PollingTarget.getPollerNodeId()

canHaveAgent

public boolean canHaveAgent()

Description copied from interface: PollingTarget

Identify if this object can have NetXMS agent.

Specified by:

canHaveAgent in interface PollingTarget

Returns:

true if this object can have NetXMS agent

See Also:

PollingTarget.canHaveAgent()

canHaveInterfaces

public boolean canHaveInterfaces()

Description copied from interface: PollingTarget

Identify if this object can have network interfaces.

Specified by:

canHaveInterfaces in interface PollingTarget

Returns:

true if this object can have network interfaces

See Also:

PollingTarget.canHaveInterfaces()

canHavePollerNode

public boolean canHavePollerNode()

Description copied from interface: PollingTarget

Identify if this object can have poller node property.

Specified by:

canHavePollerNode in interface PollingTarget

Returns:

true if this object can have poller node property

See Also:

PollingTarget.canHavePollerNode()

canUseEtherNetIP

public boolean canUseEtherNetIP()

Description copied from interface: PollingTarget

Identify if this object can use EtherNet/IP for communications.

Specified by:

canUseEtherNetIP in interface PollingTarget

Returns:

true if this object can use EtherNet/IP for communications

See Also:

PollingTarget.canUseEtherNetIP()