Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

OPC Toolbox Functions

Alphabetical List By Category
addgroupAdd data access group to opcda object
additemAdd data access items to dagroup object
arrayHasSameTimeStampTrue if all elements of OPC HDA data object have same time stamp vector
browsenamespace (opcda)Graphically browse OPC DA server name space
browseNameSpace (opchda)Graphically browse OPC HDA server name space
browseNamespace (opcua)Graphically browse name space and select nodes from server
cancelasyncCancel asynchronous read and write operations
cleareventlogClear event log, discarding all events
clonegroupClone group into new private group on same client
connectConnect OPC Toolbox client to server
connect (opcua)Connect OPC UA client to server
copyobjMake copy of OPC data access object
deleteRemove OPC Toolbox objects from memory
disconnectDisconnect OPC Toolbox client from server
disconnect (opcua)Disconnect OPC UA client from its server
dispSummary of information for OPC Toolbox objects
doubleConvert OPC HDA data object array to double type matrix
findDescription (opcua)Find OPC UA servers containing specified description
findNodeById (opcua)Find nodes by namespace index and identifier
findNodeByName (opcua)Find nodes by name
flatnamespaceFlatten hierarchical OPC name space
flushdataRemove all logged data records associated with dagroup object
genslreadGenerate Simulink OPC Read block from MATLAB group object
genslwriteGenerate Simulink OPC Write block from MATLAB group object
getOPC Toolbox object properties
getAllChildren (opcua)Recursively retrieve all children of node
getdataRetrieve logged records from OPC Toolbox engine to MATLAB workspace
getDescription Get description of OPC HDA aggregate type or item attribute
getIDFromNameTranslate OPC HDA aggregate type or item attribute name to numeric identifier
getIDListGet all aggregate type or item attribute IDs
getIndexFromIDIndices matching OPC HDA data item IDs
getNameListGet all aggregate type or item attribute names
getnamespace (opcda)OPC data access server name space
getNameSpace (opchda)OPC historical data access server name space
getNamespace (opcua)Namespace of server associated with client
getNodeAttributes (opcua)Read server node attributes
getServerStatus (opcua)Status of OPC UA server
int16Convert OPC HDA data object array to int16 matrix
int32Convert OPC HDA data object array to int32 matrix
int64Convert OPC HDA data object array to int64 matrix
int8Convert OPC HDA data object array to int8 matrix
isConnectedTrue if HDA Client is connected to server
isConnected (opcua)Determine if OPC UA client object is connected to server
isEmptyNode (opcua)True for empty nodes of OPC UA node array
isObjectType (opcua)True for object nodes of OPC UA server
isvalidTrue for undeleted OPC Toolbox objects
isVariableType (opcua)True for variable nodes of OPC UA server
loadLoad OPC Toolbox objects from MAT-file
logicalConvert OPC HDA data object array to logical matrix
makepublicConvert private group into public group
obj2mfileConvert OPC Toolbox object to MATLAB code
opc.daQualityStringOPC data access part of quality ID
opc.daSupportOPC Toolbox data access troubleshooting utility
opc.getDateDisplayFormatFormat for date display of OPC objects
opc.hda.ClientCreate OPC historical data access client
opc.hda.getServerInfoQuery host for installed HDA servers
opc.hda.resetDisconnect and delete all OPC HDA client objects
opc.hdaQualityStringOPC historical data access part of quality ID
opc.hdaSupportOPC Toolbox HDA troubleshooting utility
opc.setDateDisplayFormatSet format for date display of OPC objects
opc.ua.AggregateFnIdOPC UA node aggregate function ID enumeration
opc.ua.ClientOPC UA client object
opc.ua.NodeOPC UA node object
opc.ua.ServerInfoOPC UA server information object
opccallbackEvent information for OPC Toolbox callbacks
opcdaConstruct OPC data access object
opcDataAccessExplorerOpen OPC Data Access Explorer app
opcfindFind OPC Toolbox objects with specific properties
opchdaCreate OPC historical data access client
opchdaserverinfoQuery host for installed HDA servers
opchelpHelp for OPC Toolbox data access function or property
opcqidConstruct quality ID from item quality
opcqpartsExtract quality parts from OPC quality ID
opcqstrConvert OPC quality ID into readable text
opcreadRead logged records from disk to MATLAB workspace
opcregisterInstall and register OPC Foundation Core Components
opcresetDisconnect and delete all OPC Toolbox objects
opcserverinfoVersion, server, and status information
opcstruct2arrayConvert OPC data from structure to array format
opcstruct2timeseriesConvert OPC data from structure to time series format
opcsupportOPC Toolbox troubleshooting utility
opcua (opcua)Construct OPC UA client object
opcuanode (opcua)Construct OPC UA node objects
opcuaserverinfo (opcua)Query host for installed OPC UA servers
openosfOpen OPC Data Access Explorer session file
peekdataPreview most recently acquired data
plot Plot OPC HDA data object as lines
propinfoProperty information for OPC Toolbox objects
readRead data synchronously from OPC groups or items
readasyncRead data asynchronously from group or items
readAtTimeRead data from an OPC HDA server at specified times
readAtTime (opcua)Read historical data from nodes of an OPC UA server at specific times
readHistory (opcua)Read historical data from nodes on OPC UA server
readItemAttributesRead item attribute values from OPC HDA server
readModifiedRead modified data from an OPC HDA server
readProcessedRead server-aggregated data from an OPC HDA server
readProcessed (opcua)Read aggregate data from nodes of an OPC UA server
readRawRead raw data stored over a time range from HDA server
readValue (opcua)Read values from nodes on OPC UA server
refreshRead all active items in group
removepublicgroupRemove public group from server
resampleResample OPC HDA data object to have defined time stamps
saveSave OPC Toolbox objects to MAT-file
serveritempropsProperty information for items in OPC server name space
serveritemsQuery server or name space for fully qualified item IDs
setConfigure or display OPC Toolbox object properties
showopceventsEvent log summary for OPC Toolbox events
showValuesDisplay table of values for OPC HDA data object
singleConvert OPC HDA Data object array to single type matrix
stairsPlot OPC HDA data object as stairstep graph
startStart a logging task
stopStop a logging task
trendDisplay graphical trend of OPC data for group
tsintersectIntersection of time stamp in OPC HDA data object
tsunionUnion of time stamps in an OPC HDA data object
uint16Convert OPC HDA data object array to uint16 matrix
uint32Convert OPC HDA data object array to uint32 matrix
uint64Convert OPC HDA data object array to uint64 matrix
uint8Convert OPC HDA data object array to uint8 matrix
waitSuspend MATLAB execution until object stops logging
writeWrite values to group or items
writeasyncAsynchronously write values to group or items
writeValue (opcua)Write values to nodes on OPC UA server
Was this topic helpful?