SAP ABAP Class CL_OPC_EVENT_SUBSCRIPTION (Substitute for OPC Alarms/Events Subscription)
Hierarchy
☛
EA-APPL (Software Component) SAP Enterprise Extension PLM, SCM, Financials
⤷
PP-PI-PMA (Application Component) Process Management
⤷
COOPC (Package) OPC Interface (Open Process Control)
EA-APPL (Software Component) SAP Enterprise Extension PLM, SCM, Financials⤷
PP-PI-PMA (Application Component) Process Management⤷
COOPC (Package) OPC Interface (Open Process Control)Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_OPC_ROOT | OPC Superclass | 20011025 |
Properties
| Class | CL_OPC_EVENT_SUBSCRIPTION | |
| Short Description | Substitute for OPC Alarms/Events Subscription | |
| Super Class | CL_OPC_ROOT | OPC Superclass |
| Instantiability of a Class | 0 | Private |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | COOPC | OPC Interface (Open Process Control) |
| Created | 20011023 | SAP |
| Last change | 20011025 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  CIOPC |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 2 | CNTB |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 3 | CTOPC |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 4 | GFW |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 5 | SHLP |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_OPC_EVENT_SUBSCRIPTION has no interface implemented.
Friends
Class CL_OPC_EVENT_SUBSCRIPTION has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CM_SUBSCR_TAB |
Static Attribute | Private | Type reference (TYPE) | TY_SUBSCR_TAB | Table with All Instances | 20011023 | ||
| 2 | CO_AUTHACT_SUBSCR |
Constant | Protected | Type reference (TYPE) | ACTIV_AUTH | '89' | Authorization Activity "Activate Subscription" | 20020116 | |
| 3 | M_APPL_HANDLE |
Instance attribute | Protected | Type reference (TYPE) | COOPC_APPL_HANDLE | Application-Specific Handle | 20011023 | ||
| 4 | M_APPL_ID |
Instance attribute | Protected | Type reference (TYPE) | COOPC_APPL_ID | Name of Application | 20011023 | ||
| 5 | M_PLANT |
Instance attribute | Public | Type reference (TYPE) | WERKS_D | Plant | 20011023 | ||
| 6 | M_SUBSCRALIAS |
Instance attribute | Public | Type reference (TYPE) | COOPC_EVTSUBSCRALIAS | Alias Name of OPC Subscription | 20011023 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ACTIVATE |
Instance method | Public | Method | Create and Activate Subscription on OPC Server | 20020114 |
| 2 | CHECK |
Instance method | Public | Method | Check if Subscription Exists on OPC Server | 20011025 |
| 3 | CONSTRUCTOR |
Instance method | Public | Constructor | Constructor (Private) | 20011023 |
| 4 | DEACTIVATE |
Instance method | Public | Method | Remove Subscription on OPC Server | 20020114 |
| 5 | DISABLE |
Instance method | Public | Method | Disable Subscription Temporarily (!) | 20020114 |
| 6 | ENABLE |
Instance method | Public | Method | Enable Subscription | 20020114 |
| 7 | GET_DETAILS |
Instance method | Public | Method | Get Details on Subscription Definition from Customizing | 20011023 |
| 8 | GET_INSTANCE |
Static method | Public | Method | Get Subscription Instance | 20011023 |
| 9 | GET_SUBSCR_HANDLE |
Instance method | Protected | Method | Create Unique Subscription Handle | 20011023 |
| 10 | RECEIVE_NOTIF |
Static method | Public | Method | INTERNAL: Receive Event Notification | 20011023 |
Events
Class CL_OPC_EVENT_SUBSCRIPTION has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_SUBSCR_TAB | Private | See coding | Instance Management of this Class | 20011023 | |
|
| 2 | TY_SUBSCR_WA | Private | See coding | Instance Management of this Class | 20011023 | |
Method Signatures
Method ACTIVATE Signature
Method ACTIVATE on class CL_OPC_EVENT_SUBSCRIPTION has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  ALREADY_SUBSCRIBED |
Subskription ist bereits vorhanden | 20020114 | |
| 2 | FAILED |
Allgemeiner Fehler bei der Subskription | 20020114 |
Method CHECK Signature
Method CHECK on class CL_OPC_EVENT_SUBSCRIPTION has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | FAILED |
Prüfung fehlgeschlagen (z.B. wegen Verbindungsproblemen) | 20011025 | |
| 2 | NOT_SUBSCRIBED |
Es liegt keine Subskription auf dem Server vor | 20011025 |
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
APPL_HANDLE | Call by reference | Type reference (TYPE) | COOPC_APPL_HANDLE | Applikationsspezifischer Handle | 20011023 | ||
| 2 | Importing |
APPL_ID | Call by reference | Type reference (TYPE) | COOPC_APPL_ID | Name der Applikation | 20011023 | ||
| 3 | Importing |
PLANT | Value transfer | Type reference (TYPE) | WERKS_D | Werk der Subskription | 20011023 | ||
| 4 | Importing |
SUBSCRALIAS | Call by reference | Type reference (TYPE) | COOPC_EVTSUBSCRALIAS | Aliasname der OPC-Subskription | 20011023 |
Method CONSTRUCTOR on class CL_OPC_EVENT_SUBSCRIPTION has no exception.
Method DEACTIVATE Signature
Method DEACTIVATE on class CL_OPC_EVENT_SUBSCRIPTION has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | FAILED |
Fehlgeschlagen | 20020114 |
Method DISABLE Signature
Method DISABLE on class CL_OPC_EVENT_SUBSCRIPTION has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | FAILED |
Fehlgeschlagen | 20020114 |
Method ENABLE Signature
Method ENABLE on class CL_OPC_EVENT_SUBSCRIPTION has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | FAILED |
Fehlgeschlagen | 20020114 |
Method GET_DETAILS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ATTEMPTS | Call by reference | Type reference (TYPE) | COOPC_ATTEMPTS | Maximale Anzahl der Zugriffsversuche auf einen Server | 20011113 | ||
| 2 | Exporting |
ATTPTTIME | Call by reference | Type reference (TYPE) | COOPC_ATTPTTIME | Zeit zwischen zwei Zugriffsversuchen | 20011113 | ||
| 3 | Exporting |
BUFFERTIME | Call by reference | Type reference (TYPE) | COOPC_BUFFERTIME | Pufferzeit des OPC-Servers in Millisekunden | 20011023 | ||
| 4 | Exporting |
EVTTYPE_CONDTN | Call by reference | Type reference (TYPE) | COOPC_EVTTYPE_COND | Flag: Event-Typ 'condition-related' | 20011023 | ||
| 5 | Exporting |
EVTTYPE_SIMPLE | Call by reference | Type reference (TYPE) | COOPC_EVTTYPE_SIMPLE | Flag: Event-Typ 'simple' | 20011023 | ||
| 6 | Exporting |
EVTTYPE_TRACKG | Call by reference | Type reference (TYPE) | COOPC_EVTTYPE_TRACK | Flag: Event-Typ 'tracking-related' | 20011023 | ||
| 7 | Exporting |
EVT_AREAS | Call by reference | Type reference (TYPE) | RCOOPC_EVTSOURCE_TAB | Tabelle von Event-Areas | 20011023 | ||
| 8 | Exporting |
EVT_CATEGORIES | Call by reference | Type reference (TYPE) | RCOOPC_EVTCAT_TAB | Tabelle von Event-Kategorien | 20011023 | ||
| 9 | Exporting |
EVT_REASONS | Call by reference | Type reference (TYPE) | RCOOPC_EVTCF | Sammlung der Event-Gründe (Flags) | 20011217 | ||
| 10 | Exporting |
EVT_SOURCES | Call by reference | Type reference (TYPE) | RCOOPC_EVTSOURCE_TAB | Tabelle von Event-Quellen | 20011023 | ||
| 11 | Exporting |
PLANT | Call by reference | Type reference (TYPE) | WERKS_D | Werk der Subskription | 20011023 | ||
| 12 | Exporting |
SERVERALIAS | Call by reference | Type reference (TYPE) | COOPC_SERVERALIAS | Name des OPC-Servers | 20011023 | ||
| 13 | Exporting |
SERVERDESCR | Call by reference | Type reference (TYPE) | COOPC_SERVERTXT | Kurzbeschreibung des OPC-Servers | 20011023 | ||
| 14 | Exporting |
SERVERID | Call by reference | Type reference (TYPE) | COOPC_SERVERID | ID des OPC-Servers | 20011023 | ||
| 15 | Exporting |
SERVERRFCDEST | Call by reference | Type reference (TYPE) | COOPC_RFCDEST | RFC-Destination des OPC-Servers | 20011023 | ||
| 16 | Exporting |
SEVERITY_HIGH | Call by reference | Type reference (TYPE) | COOPC_EVTSEVERITY | Höchste Schwere / Priorität des Events (0 - 1000) | 20011023 | ||
| 17 | Exporting |
SEVERITY_LOW | Call by reference | Type reference (TYPE) | COOPC_EVTSEVERITY | Niedrigste Schwere / Priorität des Events (0 - 1000) | 20011023 | ||
| 18 | Exporting |
SUBSCRALIAS | Call by reference | Type reference (TYPE) | COOPC_EVTSUBSCRALIAS | Aliasname für eine Event-Subskriptions-Definition | 20011023 | ||
| 19 | Exporting |
SUBSCRDESCR | Call by reference | Type reference (TYPE) | COOPC_EVTSUBSCRTXT | Beschreibung einer Event-Subskriptions-Definition | 20011023 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | NOT_FOUND |
Aliasname existiert im angegebenen Werk nicht | 20011023 | |
| 2 | NOT_VALID |
Customizing ist fehlerhaft | 20011023 |
Method GET_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
APPL_HANDLE | Call by reference | Type reference (TYPE) | COOPC_APPL_HANDLE | Applikationsspezifischer Handle | 20011023 | ||
| 2 | Importing |
APPL_ID | Call by reference | Type reference (TYPE) | COOPC_APPL_ID | ID der rufenden Applikation | 20011023 | ||
| 3 | Exporting |
O_INSTANCE | Call by reference | Object reference (TYPE REF TO) | CL_OPC_EVENT_SUBSCRIPTION | Instanz einer Subskription | 20011023 | ||
| 4 | Importing |
PLANT | Value transfer | Type reference (TYPE) | WERKS_D | Werk der Subskription | 20011023 | ||
| 5 | Importing |
SUBSCRALIAS | Call by reference | Type reference (TYPE) | COOPC_EVTSUBSCRALIAS | Aliasname der OPC-Subskription | 20011023 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | NOT_EXISTING |
Aliasname existiert im angegebenen Werk nicht | 20011023 |
Method GET_SUBSCR_HANDLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
HANDLE | Value transfer | Type reference (TYPE) | COOPC_EVTSUBSCRHANDLE | Eindeutiger Event-Subscription-Handle | 20011023 |
Method GET_SUBSCR_HANDLE on class CL_OPC_EVENT_SUBSCRIPTION has no exception.
Method RECEIVE_NOTIF Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
NOTIFICATIONS | Call by reference | Type reference (TYPE) | RCOOPC_EVTNOTIF_TAB | Tabelle von Event-Notifikationen | 20011023 |
Method RECEIVE_NOTIF on class CL_OPC_EVENT_SUBSCRIPTION has no exception.
History
| Last changed by/on | SAP | 20011025 |
| SAP Release Created in | 110 |
