Units, Unitsadder, Unitsadder p – Echelon OpenLNS User Manual

Page 407

Advertising
background image

OpenLNS Programmer's Reference

370

Read/Write

Read/write.

Added to API

LNS Release 3.0.

Units

Summary

Indicates the name of the units that apply to values using

this format specification

.

Availability

Local, full, lightweight, and independent clients. Independent

clients can only access

FormatSpec

objects through monitor

points in permanent monitor sets.

Syntax

units = fsObject.Units

Element

Description

units

The name of the units.

fsObject

The

FormatSpec

object to be acted on.

Data Type

String.

Read/Write

Read only.

Added to API

LNS Release 3.0.

UnitsAdder

Summary

Determines how the scaled value of the data point or monitor

point will be unit-converted for display as a formatted value

when your application reads the

FormattedValue

propery

.

When your application reads the

FormattedValue

property of

a data point or monitor point, the OpenLNS Object Server

converts the scaled value of the data point or monitor point

so that it can be display as a formatted value.
To unit-convert the value, OpenLNS first multiplies it by the

value in the

UnitsMultiplier

property. It then adds the value

stored in the UnitsAdder property. The resulting value will

be appropriate for the

units

that apply to this format

specification.
Different data formats for the same data type will be on

different scales. For example, the SNVT_temp_f data type

contains the temperature in degrees Celcius. In order to

display the temperature in Fahrenheit, you would have to

multiply the value by 1.8 (9/5), and then add 32.

Availability

Local, full, lightweight, and independent clients. Independent

clients can only access

FormatSpec

objects through monitor

points in permanent monitor sets.

Syntax

units = fsObject.UnitsAdder

Element

Description

unitsAdder

The value to be added.

fsObject

The

FormatSpec

object to be acted on.

Advertising