beautypg.com

Sourceindex – Echelon OpenLNS User Manual

Page 285

background image

OpenLNS Programmer's Reference

248

to avoid passing invalid data to data point.

Availability

Local, full, lightweight, and independent clients. Note that

some objects containing this property are not available to

Independent clients.

Syntax

value = dpObject.

RawValue

Element

Description

value

The value of the data point as a raw

byte array.

dpObject

The

DataPoint

object to be acted on.

Data Type

Variant.

Read/Write

Read/write.

Added to API

LNS Release 3.0.

SourceIndex

Summary

Each data point that is acquired through a ConfigProperty

object that represents arrays of elements must apply to a

single element within that array. This property applies

mainly to DataPoint objects that are acquired through

ConfigProperty objects.
Some ConfigProperty objects represent arrays of elements. In

this case, you need to create a separate data point to read

and write to each element in the array. When you create a

DataPoint object for such ConfigProperty objects with the

GetDataPoint method, you specify the index number of the

element to which the new DataPoint object should apply.

This property returns that index value. You can write to this

value if you want the

DataPoint object to appl

y to a different

element of the

ConfigProperty

array. These arrays are 0-

based, and the maximum index value is specified by the

Dimension

property of the source

ConfigProperty

object. You

may find this procedure simpler than creating a separate

data point for each element in the array.

For DataPoint objects that were not acquired through

ConfigProperty objects, this property will be initialized to 0,

and you should not write to it.

Availability

Local, full, lightweight, and independent clients. Note that

some objects containing this property are not available to

Independent clients.

Syntax

index = dataPoint.SourceIndex

Element

Description

index

The index number assigned to the

element associated with the data point.

dpObject

The

DataPoint

object to be acted on.