Documentation Center

  • Trial Software
  • Product Updates

getDescription

Get description of OPC HDA aggregate type or item attribute

Syntax

DStr = getDescription(Obj, ID)
DStr = getDescription(Obj, NameStr)

Description

DStr = getDescription(Obj, ID) returns the description string associated with the aggregate type or item attribute given by ID. If ID is a vector, DStr is a cell array of description strings.

DStr = getDescription(Obj, NameStr) returns the description string associated with the aggregate type or item attribute given by the string NameStr. If NameStr is a cell array of strings, DStr is a cell array of description strings.

Examples

Get a description of all aggregate types provided by the Matrikon™ Simulation Server.

hdaObj = opchda('localhost', 'Matrikon.OPC.Simulation');
connect(hdaObj);
allDesc = getDescription(hdaObj.Aggregates)

Get a description of all item attributes provided by the Matrikon Simulation Server.

hdaObj = opchda('localhost', 'Matrikon.OPC.Simulation');
connect(hdaObj);
allDesc = getDescription(hdaObj.ItemAttributes)

See Also

Was this topic helpful?