Typeindex – Echelon OpenLNS User Manual

Page 209

Advertising
background image

OpenLNS Programmer's Reference

172

account for changes to the configuration

property’s type. Only configuration

properties that apply to network

variables can inherit types.
For example, consider a configuration

property with the

TypeInherits

property

set to 1. If an application changes the

type of the network variable to which

the configuration property belongs, then

OpenLNS changes the type of the

configuration property automatically,

since the

TypeInherits

property is set to

1. You would need to know about this

change when reading the value of the

configuration property, and you can use

this property to keep track of which

configuration properties may be

modified by OpenLNS in this fashion.

configProperty The

ConfigProperty

object being acted

upon.

Data Type

Short.

Read/Write

Read only.

Added to API

LNS Release 3.20.

TypeIndex

Summary

Returns the type index of the configuration property.
Each

ConfigProperty

object uses a type defined in the

standard LonMark resource files, or in a user-defined

resource file. This property returns the index assigned to that

type within the resource file containing its definition.
If the

Mode

property is set to lcaResourceScopeStandard

(0), then the

ConfigProperty

object’s type is defined in the

standard resource files.

Availability

Local, full, lightweight, and independent clients.

Syntax

typeIndexValue = cpObject.TypeIndex

Element

Description

cpObject

The

ConfigProperty

object to be acted

on.

typeIndexValue

The type index for the specified

ConfigProperty

object.

Data Type

Integer.

Read/Write

Read only.

Added to API

Prior to LNS Release 3.0.

Advertising