Inalarm – Echelon OpenLNS User Manual

Page 773

Advertising
background image

OpenLNS Programmer's Reference

736

InAlarm

Summary

Indicates

whether the

LonMarkObject

is currently in an

alarm condition, or whether the

LonMarkObject

is capable of

reporting an alarm condition

.

This description of this property depends on whether it was

accessed through the Status or ReportMask properties of a

LonMarkObject.

Status property.

Indicates whether the

LonMarkObject

is an alarm condition. If this property is True, then the

LonMarkObject

is an alarm condition.

ReportMask property.

Indicates whether the

LonMarkObject

can report an an alarm condition. If this

property is True, then the

LonMarkObject

can report an

alarm condition

.

You can get more information about the alarm status of a

LonMarkObject by reading its LonMarkAlarm property.

Availability

Local, full, and lightweight clients.

Syntax

inAlarmFlag = statusObject. InAlarm

Element

Description

inAlarmFlag

A Boolean value indicating whether

whether the

LonMarkObject

is

currently in an alarm condition

, or

whether the

LonMarkObject

can

report an alarm condition

.

Status Property
TRUE
.

The

LonMarkObject

is in an

alarm condition

.

FALSE.

The

LonMarkObject

is not

in an alarm condition

.

ReportMask Property
TRUE
. The LonMarkObject

can

report an alarm condition

disabled

.

FALSE. The LonMarkObject

can not

report an alarm condition

.

statusObject

The ObjectStatus object to be acted

on.

Data Type

Boolean.

Read/Write

Read only.

Added to API

Prior to LNS Release 3.0.

Advertising