cyber_effects_mgr_handle_get()
Abstract
Gets a handle to the cyber-effects manager located in the node of the current process.
Syntax
cyber_effects_mgr_handle_get ()
| Argument | Type | Description |
|---|---|---|
| no arguments |
Return Type
CyberT_Effect_Mgr*
Handle to the cyber-effects manager, or OPC_NIL if a CEM doesn’t exist in the node
Header
cyber_effects.h
Example
From ip_rte_central_cpu function block:
/* Cyber Effects settings */
effects_mgr_ptr = cyber_effects_mgr_handle_get ();
/* If a Cyber Effects manager is present in the node... */
if (effects_mgr_ptr != OPC_NIL)
{
...
/* Register effects available in this process model */
...
}
Details
This function is used by a client module to obtain a handle to the cyber-effects manager. The handle must be stored in a state variable because it is needed to register effects, to identify interrupts requesting the execution of effects, and to execute the effects.