Echelon OpenLNS - Manual (Page 831)

OpenLNS Programmer's Reference 794
Methods
The Routers object contains the following methods .
• Add
• AddEx
• AddReference
• ItemByHandle
• ItemByNeuronID
• Remove
• RemoveEx
Add
Summary Defines a new Router object. A router consists of two halves,
NearSide and FarSide.
This method adds a router to the system, but does not install
the physical router. The Commission method is used to
install the physical router after that router is defined using
this method.
Adding a router to the system is a two-step operation:
definition and commissioning.
1. The Add method is used to define the router.
2. The Commission method is used to write the network
image on the physical router, including its network
addresses (one for each side) .
The Add method can be used whether OpenLNS is physically
attached to the network or not, and while the network
management mode (MgmtMode property) is set to
lcaMgmtModePropagateConfigUpdates (0) or
lcaMgmtModeDeferConfigUpdates (1).
To modify router buffers, the router should be added using
the AddEx method. See the BufferConfiguration object for
more information.
Availability Local, full, and lightweight clients.
Syntax routerObject = routersColl.Add(routerName, nearChannel,
farChannel, routerType)
Element Description
routerObject The newly defined Router object.
routersColl The Routers collection object.
routerName A String containing the name of
the new Router.
nearChannel The Channel object for the router's
near channel.
farChannel The Channel object for the router's
far channel.