Sourceoptions, Sourceoptions p, S sourceoptions – Echelon OpenLNS User Manual

Page 286

Advertising
background image

OpenLNS Programmer's Reference

249

Data Type

Integer.

Read/Write

Read/write.

Added to API

LNS Release 3.20.

SourceOptions

Summary

You can use this property to determine which options were

used when the DataPoint

was created. In doing so, you can

determine what information will be returned or altered when

you read or write to the value of that DataPoint.
This property is most useful for DataPoints that were

acquired through ConfigProperty objects. You can create such

DataPoints with the GetDataPoint method. When you do so,

you will use the options element to specify how OpenLNS will

reconcile differences between the value of the ConfigProperty

in the OpenLNS database, and on the physical device, when

you read or write to the value of the DataPoint.
You can read this property to determine which options were

used when the DataPoint

was created, and in doing so

determine what information will be returned or altered when

you read or write to the value of that DataPoint. You can also

write to the SourceOptions property to change the behavior of

the DataPoint

when you write to its value.

If the DataPoint

was not created for use with a

ConfigProperty object, this property will return the

lcaDataSourceOptionsNotACp (-1) value. In this case, the

property is read-only.

Availability

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

some objects containing this property are not available to

Independent clients.

Syntax

options =

dpObject

.SourceOptions

Element

Description

options

A Long value indicating which options were

used when the DataPoint was created. The

possible values, which are stored in the

ConstDataSourceOptions constant, are as

follows:

0 lcaDataSourceOptionsNormal
The value of the

ConfigProperty

will be

updated in the OpenLNS database and in

the physical device each time you write to

the value of the

DataPoint

.

If the source ConfigProperty is

device-specific

,

the value will be read

directly from the device w

hen you read the

value of the

DataPoint

.

If the source ConfigProperty is not

Advertising