Path, Routerdevices, S routerdevices – Echelon OpenLNS User Manual

Page 872

Advertising
background image

OpenLNS Programmer's Reference

835

Path

Summary

Contains the full system and subsystem pathname for this

subsystem.
Pathnames may be used in place of names when fetching

Subsystem objects from the System's Subsystems collection

via the Item

property.

The pathname for a subsystem is the system name and the

subsystem hierarchy leading to that subsystem, with all

names separated by periods. The system name is optional. An

example pathname is My

System

.Discovered.Installed.

None of the top-level subsystems can have the same name as

the system because the resulting subsystem path name

would be ambiguous (for example, if a top-level subsystem in

the My

System

system was named My

System

, a pathname

of "My

System

" could represent either the system name or a

top-level subsystem name).
If this pathname is to be passed remotely, it may be up to 170

characters in length.
If this pathname is only to be used locally, there is no defined

limit. Pathnames greater that 170 characters must not be

used if remote OpenLNS clients will be used that need to

access the subsystems with long path names.

Availability

Local, full, and lightweight clients.

Syntax

subsystemPath = subsystemObject.Path

Element

Description

subsystemPath

The full pathname of the subsystem.

subsystemObject

The Subsystem object to be acted on.

Data Type

String.

Read/Write

Read only.

Added to API

Prior to LNS Release 3.0.

RouterDevices

Summary

Returns the

Routers

collection for the specified

Subsystem

.

This collection contains all the

Router

objects installed in the

specified

Subsystem

.

Note: A newly discovered uninstalled router (by service pin,

or device discovery) will not appear in the ALL subsystem's

RouterDevices collection until the

Discovered.Uninstalled.RouterDevices collection is

accessed.

Availability

Local, full, and lightweight clients.

Syntax

routersCollection = object.RouterDevices

Advertising