Filterbysource, Filtercode – Echelon OpenLNS User Manual

Page 523

Advertising
background image

OpenLNS Programmer's Reference

486

FilterBySource

Summary

Indicates whether message tag values will be filtered by the

source device

.

This property can be combined with the FilterByCode

property to allow only message tags with certain codes from

certain sources to be passed to your client application via a

MsgMonitorPoint object.

Availability

Local, full, lightweight, and independent clients. Note that

temporary

MonitorSet

objects and temporary monitor points

are not available on Independent clients.

Syntax

filterBySource =msgMonOpts.FilterBySource

Element

Description

filterBySource A Boolean value.

TRUE.

Message tag values are filtered

by the target

AppDevice

object

that was specified when the

monitored message tag point

was created (using the Add

method)

.

FALSE.

The message tag source is

ignored

.

msgMonOpts

The

MsgMonitorOptions

object.

Data Type

Boolean.

Read/Write

Read/write.

Added to API

LNS Release 3.0.

FilterCode

Summary

Contains the filter code that will be used if the

FilterByCode

property is set to True

.

Each explicit message contains a 1-byte message code along

with the message data. If the FilterByCode property is set to

True and this property is set, only messages with a message

code matching the value of this property will be passed to the

client via the MsgMonitorPoint objects using this

MsgMonitorOptions obect.

Availability

Local, full, lightweight, and independent clients. Note that

temporary

MonitorSet

objects and temporary monitor points

are not available on Independent clients.

Syntax

filterCode =msgMonOpts.FilterCode

Element

Description

filterCode

The filter code.

This element may be set to a value

between 0–255; however, messages with

Advertising