Reportmask – Echelon OpenLNS User Manual

Page 471

Advertising
background image

OpenLNS Programmer's Reference

434

Element

Description

progName

The programmatic name of the object.

Object

The

LonMarkObject

to be acted on.

Data Type

String.

Read/Write

Read-only for static

LonMarkObject

objects. Read/write for

dynamic

LonMarkObject

objects. You can check if a

LonMarkObject

is dynamic or static by reading the

IsDynamic

property.

When writing to this property, you should note that some

devices, such as the SmartServer, require that all network

variables within the device have a unique programmatic

name. In addition, all network variables contained within a

custom

Interface

object must have unique programmatic

names. If you attempt to assign a duplicate programmatic

name to a network variable on such a device, the operation

will fail, and the LCA, #132

lcaErrUniqueNvNameRequired exception will be thrown.

Added to API

Prior to LNS Release 3.0.

ReportMask

Summary

Returns an

ObjectStatus

object which reports which

LonMark status attributes are supported by this

LonMarkObject

.

Some LonMarkObject

objects

do not support all of the status

attributes contained in an ObjectStatus object. You can use

the ReportMask property to determine which ones are not

supported. If you access an ObjectStatus object through the

ReportMask property, the object represents a report mask. In

this case, the values of each property of the ObjectStatus

object reflect whether or not the LonMarkObject supports the

related status attribute. Use the Status property to retrieve

an ObjectStatus object you can use to read the actual values

of the supported attributes.
For example, consider the AlarmNotifyDisabled property of

the ObjectStatus object. The AlarmNotifyDisabled property

contained in an ObjectStatus object accessed through the

Status property of a LonMarkObject indicates whether alarm

notification has been disabled on the LonMarkObject. The

AlarmNotifyDisabled property contained in an ObjectStatus

object accessed through the ReportMark property of a

LonMarkObject indicates whether or not you can disable

alarm notification on the LonMarkObject.
You can upate the information contained in the ObjectStatus

report mask object by writing the value

lcaLonMarkObjectRequestReportMask (5) to the

Request property of the LonMarkObject.

Availability

Local, full, and lightweight clients.

Advertising