beautypg.com

Configclassflag – Echelon OpenLNS User Manual

Page 624

background image

OpenLNS Programmer's Reference

587

ConfigClassFlag

Summary

Indicates whether the network variable is a configuration

network variable (CPNV)

.

A CPNV is used for application configuration. This should

not be confused with a configuration property that is

implemented as a network variable, and the related

IsConfigProperty property.

Network

variables that implement configuration properties

are always CPNVs, and the ConfigClassFlag and

IsConfigProperty properties for these network variables are

set to True. However, as described below, a network variable

can be a CPNV without implementing a LonMark compliant

configuration property. In this case, the IsConfigProperty is

set to False.
Device developers can create config network variables to

implement configuration properties using the "config_prop"

or "cp" keywords. This implements a configuration property

by creating a CPNV with L

ON

M

ARK

compliant network

variable strings. See the NodeBuilder User’s Guide for more

information on the "config_prop" or "cp" keywords.
A CPNV may also be implemented using the "config"

keyword. Typically these network variables will not

implement configuration properties. However, legacy

applications may also implement a configuration property by

declaring a network variable with the "config" keyword, and

hard-coding the appropriate LonMark compliant

self-documentation string. See the NodeBuilder User’s Guide

for more information on the the "config" keyword.

Availability

Local, full, and lightweight clients.

Syntax

configClassFlag = nvObject.ConfigClassFlag

Element

Description

configClassFlag A Boolean value indicating whether

the network variable uses

authentication by default.

TRUE. T

he network variable is

declared as a CPNV

.

FALSE. T

he network variable is not

declared as a CPNV

.

nvObject

The

NetworkVariable

object being

queried.

Data Type

Boolean

Read/Write

Read only.

Added to API

Prior to LNS Release 3.0.