Scope – Echelon OpenLNS User Manual

Page 405

Advertising
background image

OpenLNS Programmer's Reference

368

will be set to match the program ID of the device

containing the monitor point or data point.

If the FormatSpec object applies to a data point obtained

through a ConfigProperty object, the ProgramId property

will be set to match the program ID of the resource file

that defines the configuration property type.

If the FormatSpec object applies to a message monitor

point, the ProgramId property will be set to

0000000000000000.

Availability

Local, full, and lightweight clients.

Syntax

programIdValue = formatSpec.ProgramId

Element

Description

programIdValu

e

The length of network variables (in

bytes) using the type referenced by this

FormatSpec

object.

formatSpec

The

FormatSpec

object to be acted on.

Data Type

String.

Read/Write

Read/write.

Added to API

LNS Release 3.20.

Scope

Summary

Each FormatSpec object references a type defined in a

LonMark resource file. This property indicates the scope of

the resource file that contains that type’s definition. The

scope of a resource file determines which devices will use the

types defined in that resource file.

Availability

Local, full, lightweight, and independent clients. Independent

clients can only access

FormatSpec

objects through monitor

points in permanent monitor sets.

Syntax

scopeValue = specObject.Scope

Element

Description

scopeValue

The scope of the device resource file

containing the definition of this type.
The possible values of this element, which

are stored in the

ConstResourceScope

constant, are as follows:
0 lcaResourceScopeStandard
This scope applies to all devices.
1 lcaResourceScopeClass
This scope applies to all devices of a

specified device class from any

manufacturer.

Advertising