Echelon OpenLNS - Manual (Page 391)

OpenLNS Programmer's Reference 354
not available. In this case, Systeme Internationale measurement units, and U.S. options
for everything else, will be used to display all formatted data.
• Index 4, ISO8601DateAndTime. When you use this FormatLocale object as the
CurrentFormatLocale, all properties will be set to be the same as the LonMark
Compatibility
settings, except for the localized time and date formats, which will be
based on the ISO 8601 standard. This standard helps avoid confusion that may be
caused by the many different national notations used for dates and times, and increases
the portability of computer user interfaces.
For more details on these FormatLocale objects, including the settings used for each
property, see the OpenLNS Programmer’s Guide.
You can determine which FormatLocale object will be used by your application by writing to
the CurrentFormatLocale property of the ObjectServer object. Note that you can only write to
the CurrentFormatLocale property and the FormatLocale object acting as the
CurrentFormatLocale before your application has opened any networks and formatted any
data. Operations that will cause your application to format data include acquiring a
DataPoint object, and reading or writing the value of a ConfigProperty or NetworkVariable
object. If you write to the CurrentFormatLocale property (or to the FormatLocale object
assigned to the CurrentFormatLocale property) after performing any of these operations, the
LCA, #122 lcaErrReadOnlyInContext exception will be thrown.
The following table summarizes the FormatLocales object.
Description Contains all the FormatLocale objects that have been added
to the Object Server.
Added to API LNS Release 3.20.
Accessed Through ObjectServer object.
Default Property Item.
Methods • Add
• Remove
Properties • ClassId
• Count
• Item
• Parent
• _NewEnum
Methods
The FormatLocales contains the following methods .
• Add
• Remove
Add
Summary Defines a new FormatLocale object.
A FormatLocale object contains a series of properties that
reflect a geographical area’s conventions. These properties
determine how data stored in the FormattedValue properties
of DataPoint objects will be displayed when that
FormatLocale is used by an application. This includes options