Bandwidth Property

General info

Label

Bandwidth

Description

OPC Server specific information. A suggested use is that it returns the approximate percent of bandwidth currently in use by the server. If multiple links are in use it could return the 'worst case' link.

Data type

String

Type

Regular

Code

555

Symbolic name

MODEL_PROP_BANDWIDTH

Lua access code

syslib.model.properties.Bandwidth

Available since

1.0
Parent properties

OpcComCStateInformation

Attributes

Name Tooltip
PROP_VISIBLE The property is visible in DataStudio and can be read by the inmation APIs.
PROP_VOLATILE The property exists during runtime of the service only and is not saved to the image.
PROP_DETECTABLE Property is detectable by system-driven server endpoint investigation.

Examples

Read from or write to the Bandwidth property.

  • Lua

  • C#

-- Read from the Bandwidth
syslib.getvalue("<OBJECT FULL PATH>.OPCComCRuntimeInformation.OpcComCStateInformation.Bandwidth")

-- Write to the Bandwidth
syslib.setvalue("<OBJECT FULL PATH>.OPCComCRuntimeInformation.OpcComCStateInformation.Bandwidth", "new value")
TcpConfig tcpcfg = new TcpConfig() { HostNameOrIp = "localhost", Port = 6512 };
SecurityCredentials sc = new SecurityCredentials() { ProfileName = "<username>", Password = "<password>" };
StatelessInterface sli = new StatelessInterface(tcpcfg);

// Read from the Bandwidth
Result result = sli.ReadValue(sc, new ReadItem("<OBJECT FULL PATH>.OPCComCRuntimeInformation.OpcComCStateInformation.Bandwidth"));
// Write to the Bandwidth
Result result = sli.WriteValue(sc, new WriteItem("new value", "<OBJECT FULL PATH>.OPCComCRuntimeInformation.OpcComCStateInformation.Bandwidth"));