Lockedout – Echelon OpenLNS User Manual

Page 776

Advertising
background image

OpenLNS Programmer's Reference

739

been made

.

statusObject

The ObjectStatus object to be acted

on.

Data Type

Boolean.

Read/Write

Read only.

Added to API

Prior to LNS Release 3.0.

LockedOut

Summary

Indicates

whether the

LonMarkObject

is in an operable state,

or whether the

LonMarkObject

can report this information

.

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 operable state. If this property is True, then the

LonMarkObject

is online, but is not in an operable state.

ReportMask property.

Indicates whether the

LonMarkObject

can report that it is locked out and

inoperable.

Availability

Local, full, and lightweight clients.

Syntax

lockedOutFlag = statusObject. LockedOut

Element

Description

lockedOutFlag

A Boolean value indicating

whether

the

LonMarkObject

is in an operable

state

, or

whether the

LonMarkObject

can report that it is locked out and

inoperable

.

Status Property
TRUE
.

The

LonMarkObject

is

online, but is not in an

operable state

.

FALSE.

The

LonMarkObject

is

online, and it is an operable

state

.

ReportMask Property
TRUE
. The LonMarkObject

can

report that it is locked out

and inoperable

.

FALSE. The LonMarkObject

can not

report that it is locked out

and inoperable

.

statusObject

The ObjectStatus object to be acted

on.

Advertising