Subnetid, Subnets – Echelon OpenLNS User Manual

Page 861

Advertising
background image

OpenLNS Programmer's Reference

824

Added to API

Depends on the object used to access the property. Generally,

this property exists for an object as soon as the object is

added to the API.

SubnetId

Summary

Contains the ID of the subnet.

Availability

Local, full, and lightweight clients.

Syntax

returnValue = object.

SubnetId

Element

Description

returnValue

The subnet ID of the device.

object

The

Subnet

to be acted on.

Data Type

Integer.

Read/Write

Read only.

Added to API

Prior to LNS Release 3.0.

Subnets

The Subnets object

represents a collection of

Subnet

objects. Subnets are typically added

automatically when routers or devices are added. In most cases there is no reason for your

application to manually allocate subnets. Subnets can be explicitly added using the

Add

method of the

System

object's

Subnets

collection. This allows an LCA application to force a

given set of devices onto the same subnet to be able to take advantage of subnet broadcast

messaging.

The Subnets collection accessed through the AppDevice or RouterSide objects always

returns a collection containing the single subnet associated with the device's primary

domain.

The Subnets collection accessed through the System

object represents all of the subnets

in a system.

The following table summarizes the Subnets object.

Description

A collection of

Subnet

objects.

Added to API

LNS Release 3.0.

Accessed Through

AppDevice

object.

RouterSide

object.

System

object.

Default Property

Item

Methods

Add

Remove

Properties

ClassId

Count

Item

Parent

_NewEnum

Advertising