FB_OcaRoot

FB_OcaRoot 1:

The function block FB_OcaRoot provides basic OCA functionality. It is the function block from which all other function blocks inherit.

	No explicit call Since there is no code in the body of the function block, it should not be called explicitly. Instead, use the corresponding methods of the function block.

Methods

Name	Definition location	Description
GetClassIdentification	Local	This method can be used to query the ClassId and ClassVersion of the OCA object. If the query was successful, the result is output in the properties stClassID and stClassVersion.
GetLockable	Local	This method is used to query whether the OCA object can be locked. If the query was successful, the result is output in the property stLockable.
LockUnlock	Local	Method for unlocking or locking an OCA object If the method was executed successfully, the result is output in the property stObjectLocked.
GetRole	Local	OCA objects can have a text label to make their meaning easier to recognize. If the method call was successful, the result is output in the property stRole.
Subscription	Local	You can use this method to request OCA objects, generate notifications for value changes, or set up sending. If the method was executed successfully, the result is output in the property stSubscribed.

Properties

Name	Type	Access	Definition location	Description
sClassId	STRING	Get	Local	Unique class name
stClassId	ST_ClassIdProperty	Get	Local	Unique class name
stClassVersion	ST_UINT16Property	Get	Local	OCA ClassVersion
stLockable	ST_BooleanProperty	Get	Local	Indicates whether the object can be locked
stSubscribed	ST_BooleanProperty	Get	Local	Shows whether the object was requested to generate notifications when value changes occur
stRole	ST_StringProperty	Get	Local	Task of the object in the device (e.g. Config_InputEnable)
nONo	UDINT	Get	Local	Unique number with which the instantiated object is uniquely defined
sOcaObjectDescription	STRING(32)	Set	Local	Arbitrary object name. This is used to assign further object properties to the function block that were defined in the array aOcaDevices (located in the global variable list GVL_AES70).
stObjectLocked	ST_BooleanProperty	Get	Local	Indicates whether the object is locked.

	AES70 standard The names of variables and function blocks have been adapted to the AES70 standard where possible. Information about this communication protocol can be found at www.aes.org and www.ocaalliance.com.

Requirements

Development environment	Target platform	PLC libraries to include
TwinCAT v3.1.4022.2 or higher	PC or CX (x64, x86, ARM)	Tc3_AES70

See also: Example for using the function block FB_OcaRoot

Further Information