Function Reference

Alphabetical List

---

OPC Data Access (DA) Functions supporting OPC data access OPC Historical Data Access (HDA) Functions supporting OPC historical data access

Back to Top

OPC Data Access (DA)

• Object Creation and Configuration

• Server Exploration

• Data Access

• OPC Data Visualization

• Logging and Buffering

• Simulink Support

• Utilities

Back to Top of Section

Object Creation and Configuration

addgroup	Add data access group to opcda object
additem	Add data access items to dagroup object
clonegroup	Clone group into new private group on same client
connect	Connect OPC Toolbox client to server
copyobj	Make copy of OPC data access object
delete	Remove OPC Toolbox objects from memory
disconnect	Disconnect OPC Toolbox client from server
disp	Summary of information for OPC Toolbox objects
get	OPC Toolbox object properties
isvalid	True for undeleted OPC Toolbox objects
makepublic	Convert private group into public group
opcda	Construct OPC data access object
removepublicgroup	Remove public group from server
set	Configure or display OPC Toolbox object properties

Back to Top of Section

Server Exploration

flatnamespace	Flatten hierarchical OPC name space
getnamespace (opcda)	OPC data access server name space
opcserverinfo	Version, server, and status information
serveritemprops	Property information for items in OPC server name space
serveritems	Query server or name space for fully qualified item IDs

Back to Top of Section

Data Access

cancelasync	Cancel asynchronous read and write operations
opc.daQualityString	OPC data access part of quality ID as strings
read	Read data synchronously from OPC groups or items
readasync	Read data asynchronously from group or items
refresh	Read all active items in group
write	Write values to group or items
writeasync	Asynchronously write values to group or items

Back to Top of Section

OPC Data Visualization

trend

Display graphical trend of OPC data for group

Back to Top of Section

Logging and Buffering

flushdata	Remove all logged data records associated with dagroup object
getdata	Logged records from OPC Toolbox engine to MATLAB workspace
opcread	Read logged records from disk to MATLAB workspace
opcstruct2array	Convert OPC data from structure to array format
opcstruct2timeseries	Convert OPC data from structure to time series format
peekdata	Preview most recently acquired data
start	Start a logging task
stop	Stop a logging task
wait	Suspend MATLAB execution until object stops logging

Back to Top of Section

Simulink Support

genslread	Generate Simulink OPC Read block from MATLAB group object
genslwrite	Generate Simulink OPC Write block from MATLAB group object

Back to Top of Section

Utilities

cleareventlog	Clear event log, discarding all events
load	Load OPC Toolbox objects from MAT-file
obj2mfile	Convert OPC Toolbox object to MATLAB code
opccallback	Event information for OPC Toolbox callbacks
opcfind	Find OPC Toolbox objects with specific properties
opchelp	Help for OPC Toolbox data access function or property
opcqid	Construct quality ID from item's quality string
opcqparts	Extract quality parts from OPC quality ID
opcqstr	Convert OPC quality ID into readable string
opcregister	Install and register OPC Foundation Core Components
opcreset	Disconnect and delete all OPC Toolbox objects
opcsupport	Run OPC Toolbox troubleshooting utility
opctool	Open OPC Tool GUI
openosf	Open OPC Tool GUI session file
propinfo	Property information for OPC Toolbox objects
save	Save OPC Toolbox objects to MAT-file
showopcevents	Event log summary for OPC Toolbox events

Back to Top

OPC Historical Data Access (HDA)

• Server Connection

• Data Retrieval

• AggregateType Methods

• ItemAttributes Methods

• Data Manipulation

• General HDA Functions

Back to Top of Section

Server Connection

connect	Connect OPC Toolbox client to server
delete	Remove OPC Toolbox objects from memory
disconnect	Disconnect OPC Toolbox client from server
getNameSpace (opchda)	OPC historical data access server name space
isConnected	True if HDA Client is connected to server
opc.hda.Client	Construct an OPC Historical Data Access Client
opc.hda.reset	Disconnect and delete all OPC HDA Client objects

Back to Top of Section

Data Retrieval

readAtTime	Read data from an OPC HDA server at specified times
readItemAttributes	Read item attribute values from OPC HDA server
readModified	Read modified data from an OPC HDA server
readProcessed	Read server-aggregated data from an OPC HDA server
readRaw	Read raw data stored over a time range from HDA server

Back to Top of Section

AggregateType Methods

getDescription	Get description of OPC HDA Aggregate Type or Item Attribute
getIDFromname	Translate OPC HDA aggregate type or item attribute name to numeric identifier
getIDList	Get all aggregate type or item attribute IDs
getNameList	Get all aggregate type or item attribute names

Back to Top of Section

ItemAttributes Methods

getDescription	Get description of OPC HDA Aggregate Type or Item Attribute
getIDFromname	Translate OPC HDA aggregate type or item attribute name to numeric identifier
getIDList	Get all aggregate type or item attribute IDs
getNameList	Get all aggregate type or item attribute names

Back to Top of Section

Data Manipulation

arrayHasSameTimeStamp	True if all elements of OPC HDA data object have same time stamp vector
double	Convert OPC HDA data object array to double type matrix
getIndexFromID	Indices matching OPC HDA data item IDs
int16	Convert OPC HDA data object array to int16 matrix
int32	Convert OPC HDA Data object array to int32 matrix
int64	Convert OPC HDA Data object array to int64 matrix
int8	Convert OPC HDA data object array to int8 matrix
logical	Convert OPC HDA data object array to logical matrix
plot	Plot OPC HDA data object as lines
resample	Resample OPC HDA data object to have defined time stamps
showValues	Display table of values for OPC HDA data object
single	Convert OPC HDA Data object array to single type matrix
stairs	Plot OPC HDA data object as stairstep graph
tsintersect	Intersection of time stamp in OPC HDA data object
tsunion	Union of time stamps in an OPC HDA data object
uint16	Convert OPC HDA data object array to uint16 matrix
uint32	Convert OPC HDA data object array to uint32 matrix
uint64	Convert OPC HDA data object array to uint64 matrix
uint8	Convert OPC HDA data object array to uint8 matrix

Back to Top of Section

General HDA Functions

opc.getDateDisplayFormat	Format for date display of OPC objects
opc.hda.getServerInfo	Query host for installed HDA servers
opc.hdaQualityString	OPC historical data access part of quality ID as strings
opc.setDateDisplayFormat	Set format for date display of OPC objects

OPC HDA Item Attributes

Functions — Alphabetical List

© 1984-2012- The MathWorks, Inc.    -   Site Help   -   Patents   -   Trademarks   -   Privacy Policy   -   Preventing Piracy   -   RSS