beautypg.com

Isconfigproperty – Echelon OpenLNS User Manual

Page 638

background image

OpenLNS Programmer's Reference

601

Syntax

index = object.Index

Element

Description

object

The object to be acted on.

index

Index of the network variable. The

valid values for this element are 0–14.

Data Type

Integer.

Read/Write

Read only.

Added to API

Prior to LNS Release 3.0.

IsConfigProperty

Summary

Indicates whether the network variable implements a

configuration property that conforms to the LonMark

interoperability guidelines.

A True value indicates that the network variable implements

a configuration property conforming to LonMark

interoperability guidelines. The related ConfigClassFlag

property will be set to True whenever the IsConfigProperty

property is set to True. However, as described below, some

network variables may have the ConfigClassFlag property

set to True, and still have the IsConfigProperty property set

to False.
Currently, there are two ways in which a device developer

can implement a configuration property as a network

variable:
1. Use the "config_prop" or "cp" keywords, which is the

recommended, newer method. This method automatically

creates a configuration network variable (CPNV) with an

appropriate SelfDocumentation string that specifies the

configuration property attributes. See the NodeBuilder

User’s Guide for more information on the "config_prop"

or "cp" keywords.

2. Use the "config" keyword. Any network variable

declared with the "config" keyword will have a

ConfigClassFlag value of True. However, in order to

implement a configuration property (and therefore have

the IsConfigProperty set to True), you must manually

provide a LonMark compliant SelfDocumentation string

that specify the attributes of the configuration property.

See the NodeBuilder User’s Guide for more information

on the "config" keyword.

Availability

Local, full, and lightweight clients.

Syntax

cpFlagValue = nvObject.

IsConfigProperty

Element

Description

cpFlagValue

A Boolean value.

TRUE. T

he network variable