Addreference, Itembyhandle – Echelon OpenLNS User Manual

Page 834

Advertising
background image

OpenLNS Programmer's Reference

797

network management mode is set to

lcaMgmtModePropagateConfigUpdate

s (0).

Added to API

Prior to LNS Release 3.0.

AddReference

Summary

Adds a

Router

object reference to a

Routers

collection.

This method

can be

used to add an existing Router to

multiple Subsystem objects (by invoking this method on the

Routers collection in those Subsystem objects). For example,

an application might contain both a logical hierarchy for the

system (where each subsystem represents a function, such as

lighting control or the first stage of a batch process) and a

physical hierarchy for the system (where each subsystem

represents a physical place such as a room or cell). This

method allows Routers

to be placed within both hierarchies in

the appropriate subsystems.
When initially defining a router, it is first added to a single

subsystem. References to the router may then be added to

other subsystems. The router is not deleted from the

OpenLNS database or decommissioned until all references

have been deleted. The router’s association with the first

subsystem is also treated as a reference, so it may be

removed from its initial subsystem at any time.
If AddReference is used to "add" a router discovered in one of

the Discovered.<xxx> subsystems, invoking this method will

cause the router to be removed from its original discovered

subsystem.

Availability

Local, full, and lightweight clients.

Syntax

collection.AddReference object

Element

Description

collection

The

Routers

collection to gain the

reference.

object

The

Router

object to be added.

Added to API

Prior to LNS Release 3.0.

ItemByHandle

Summary

Retrieves a

Router

object, specified by its handle, from a

Routers

collection. The

Router

object to be retrieved must be

specified by its handle.

Availability

Local, full, and lightweight clients.

Syntax

object = coll.ItemByHandle(handle)

Element

Description

object

The

Router

object retrieved from the

Advertising