SAP ABAP Class CL_OPC_NAMESPACE_TREE (Tree for Namespace Browsing of OPC Server)
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)
⤷
⤷
Properties
| Class | CL_OPC_NAMESPACE_TREE | |
| Short Description | Tree for Namespace Browsing of OPC Server | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | COOPC | OPC Interface (Open Process Control) |
| Created | 20000914 | SAP |
| Last change | 20050109 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 2 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 3 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_OPC_NAMESPACE_TREE has no interface implemented.
Friends
Class CL_OPC_NAMESPACE_TREE has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Private | Type reference (TYPE) | TV_ITMNAME | 'DESCR' | Constant: Name of Text Column | 20000926 | ||
| 2 | Constant | Private | Type reference (TYPE) | TV_ITMNAME | 'QUALITY' | Constant: Name of Quality Column | 20000926 | ||
| 3 | Constant | Private | Type reference (TYPE) | TV_ITMNAME | 'TOKEN' | Constant: Name of Token Column | 20000926 | ||
| 4 | Constant | Private | Type reference (TYPE) | TV_ITMNAME | 'VALUE' | Constant: Name of Item Value Column | 20000926 | ||
| 5 | Constant | Private | Type reference (TYPE) | UI_FUNC | 'FLAT' | Constant: FCode "Flat Namespace" | 20000926 | ||
| 6 | Constant | Private | Type reference (TYPE) | UI_FUNC | 'REFRESH' | Constant: FCode "Refresf" | 20000926 | ||
| 7 | Constant | Private | Type reference (TYPE) | UI_FUNC | 'REFRESH_VALUES' | Constant: FCode "Refresh Values" | 20000926 | ||
| 8 | Constant | Private | Type reference (TYPE) | UI_FUNC | 'SELECT_SERVER' | Constant: FCode "Select Server" | 20000926 | ||
| 9 | Constant | Public | Type reference (TYPE) | CHAR1 | 'E' | Token Type "Alarms/Events Root" | 20011105 | ||
| 10 | Constant | Public | Type reference (TYPE) | CHAR1 | 'A' | Token Type "Alarms/Events Area" | 20011102 | ||
| 11 | Constant | Public | Type reference (TYPE) | CHAR1 | 'B' | Token Type "Data Access Node" | 20011102 | ||
| 12 | Constant | Public | Type reference (TYPE) | CHAR1 | 'J' | Token Type "Data Access Item Node" | 20011102 | ||
| 13 | Constant | Public | Type reference (TYPE) | CHAR1 | 'C' | Token Type "Alarms/Events Condition" | 20011102 | ||
| 14 | Constant | Public | Type reference (TYPE) | CHAR1 | 'T' | Token Type "Data Access Root" | 20011105 | ||
| 15 | Constant | Public | Type reference (TYPE) | CHAR1 | 'M' | Token Type "Info Text" | 20011105 | ||
| 16 | Constant | Public | Type reference (TYPE) | CHAR1 | 'I' | Token Type "Data Access Item" | 20011102 | ||
| 17 | Constant | Public | Type reference (TYPE) | CHAR1 | 'R' | Token Type "Root" | 20011105 | ||
| 18 | Constant | Public | Type reference (TYPE) | CHAR1 | 'S' | Token Type "Alarms/Events Source" | 20011102 | ||
| 19 | Constant | Public | Type reference (TYPE) | CHAR1 | 'D' | Token Type "Alarms/Events Subcondition" | 20011102 | ||
| 20 | Instance attribute | Private | Type reference (TYPE) | COOPC_BROWSEFILTERTYPE | Browse Type: Flat or Hierarchical | 20000926 | |||
| 21 | Instance attribute | Private | Type reference (TYPE) | TY_NODE_TAB | Namespace Buffer Table | 20000915 | |||
| 22 | Instance attribute | Private | Type reference (TYPE) | TV_NODEKEY | Last Node Key Taken | 20000915 | |||
| 23 | Instance attribute | Private | Type reference (TYPE) | CHAR20 | Token Type(s) that can Be Selected in Tree | 20011112 | |||
| 24 | Instance attribute | Private | Type reference (TYPE) | FLAG | Indicator: Browse Alarms/Events Area | 20011102 | |||
| 25 | Instance attribute | Private | Type reference (TYPE) | FLAG | Indicator: Browse Data Access Namespace | 20011102 | |||
| 26 | Instance attribute | Private | Type reference (TYPE) | COOPC_SERVERTXT | Short Text of OPC Server to Browse | 20000915 | |||
| 27 | Instance attribute | Private | Type reference (TYPE) | COOPC_SERVERID | ID of OPC Server to Browse | 20000915 | |||
| 28 | Instance attribute | Private | Type reference (TYPE) | COOPC_RFCDEST | RFC Destination of OPC Server to Browse | 20000915 | |||
| 29 | Instance attribute | Private | Object reference (TYPE REF TO) | CL_GUI_TOOLBAR | Reference to Toolbar Control | 20000915 | |||
| 30 | Instance attribute | Private | Object reference (TYPE REF TO) | CL_GUI_COLUMN_TREE | Reference to Tree Control | 20000915 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Private | Method | Alarms/Events Namespace Browsing | 20011102 | |
| 2 | Instance method | Private | Method | Alarms/Events Source Conditions Browsing | 20011102 | |
| 3 | Instance method | Private | Method | Alarms/Events Subsconditions Browsing | 20011102 | |
| 4 | Instance method | Private | Method | Data Access Namespace Browsing | 20011102 | |
| 5 | Instance method | Private | Method | Create Root Node | 20011105 | |
| 6 | Instance method | Public | Constructor | Create New Tree | 20000914 | |
| 7 | Instance method | Private | Method | Get Namespace Below a Certain Node | 20000914 | |
| 8 | Instance method | Private | Method | Determine New Node Key | 20000914 | |
| 9 | Instance method | Public | Method | Read Server Currently Browsed | 20000915 | |
| 10 | Instance method | Public | Method | Get Selected Entry in Tree | 20000915 | |
| 11 | Instance method | Private | Method | Create Tree Node Table | 20000914 | |
| 12 | Instance method | Private | Event handling method | Event Handler: Toolbar Button was Pressed | 20000914 | |
| 13 | Instance method | Private | Event handling method | Event Handler: Item was Selected in Tree (Double-Click) | 20000914 | |
| 14 | Instance method | Private | Event handling method | Event Handler: Node was Expanded in Tree | 20000914 | |
| 15 | Instance method | Public | Method | Refresh Tree Contents (Namespace Buffer is Withdrawn) | 20000915 | |
| 16 | Instance method | Private | Method | Refresh Item Value in Tree | 20000925 | |
| 17 | Instance method | Public | Method | Set Server to Browse | 20000915 |
Events
| # | Event | Type | Visibility | Description | Created on |
|---|---|---|---|---|---|
| 1 | TREEITEM_SELECTED | Instance Event (0) |
Public (2) |
An Entry in the Tree was Double-Clicked | 20000915 |
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_NODE_TAB | Private | See coding | Table Type of Internal OPC Namespace Table | 20000914 | |
|
| 2 | TY_NODE_WA | Private | See coding | Structure of Internal OPC Namespace Table | 20000914 | |
Method Signatures
Method BROWSE_AE_NAMESPACE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHILD_NODES | Call by reference | Type reference (TYPE) | TY_NODE_TAB | Tabelle der Kinderknoten | 20011102 | |||
| 2 | CURRENT_NODE | Call by reference | Type reference (TYPE) | TY_NODE_WA | Aktueller Knoten als Startpunkt zum Browsen | 20011102 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Fehlgeschlagen | 20011102 | ||
| 2 | Startknoten ist auf dem Server unbekannt | 20011102 |
Method BROWSE_AE_SOURCECOND Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHILD_NODES | Call by reference | Type reference (TYPE) | TY_NODE_TAB | Tabelle der Kinderknoten | 20011102 | |||
| 2 | CURRENT_NODE | Call by reference | Type reference (TYPE) | TY_NODE_WA | Aktueller Knoten als Startpunkt zum Browsen | 20011102 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Fehlgeschlagen | 20011102 | ||
| 2 | Startknoten ist auf dem Server unbekannt | 20011102 |
Method BROWSE_AE_SUBCOND Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHILD_NODES | Call by reference | Type reference (TYPE) | TY_NODE_TAB | Tabelle der Kinderknoten | 20011102 | |||
| 2 | CURRENT_NODE | Call by reference | Type reference (TYPE) | TY_NODE_WA | Aktueller Knoten als Startpunkt zum Browsen | 20011102 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Fehlgeschlagen | 20011102 | ||
| 2 | Startknoten ist auf dem Server unbekannt | 20011102 |
Method BROWSE_DA_NAMESPACE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHILD_NODES | Call by reference | Type reference (TYPE) | TY_NODE_TAB | Tabelle der Kinderknoten | 20011102 | |||
| 2 | CURRENT_NODE | Call by reference | Type reference (TYPE) | TY_NODE_WA | Aktueller Knoten als Startpunkt zum Browsen | 20011102 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Fehlgeschlagen | 20011102 | ||
| 2 | Startknoten ist auf dem Server unbekannt | 20011102 |
Method BROWSE_ROOT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHILD_NODES | Call by reference | Type reference (TYPE) | TY_NODE_TAB | Tabelle der Kinderknoten | 20011105 | |||
| 2 | CURRENT_NODE | Call by reference | Type reference (TYPE) | TY_NODE_WA | Aktueller Knoten als Startpunkt zum Browsen | 20011105 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Fehlgeschlagen | 20011105 | ||
| 2 | Startknoten ist auf dem Server unbekannt | 20011105 |
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | O_CONTAINER | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | Abstracter Container fuer GUI Controls | 20000914 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Instanziierung fehlgeschlagen | 20000915 |
Method GET_NAMESPACE_VIA_NODEKEY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHILD_NODES | Call by reference | Type reference (TYPE) | TY_NODE_TAB | Tabelle der Kinderknoten | 20000914 | |||
| 2 | PARENT_NODEKEY | Call by reference | Type reference (TYPE) | TV_NODEKEY | Schlüssel des Elternknotens | 20000914 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Interner Fehler | 20000914 | ||
| 2 | Elternknoten ist kein expandierbarer Knoten | 20000914 | ||
| 3 | Elternknoten unbekannt | 20000914 |
Method GET_NEXT_NODEKEY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | NODEKEY | Value transfer | Type reference (TYPE) | TV_NODEKEY | Schlüssel eines Knotens | 20000914 |
Method GET_NEXT_NODEKEY on class CL_OPC_NAMESPACE_TREE has no exception.
Method GET_OPC_SERVER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | SERVER_AE | Call by reference | Type reference (TYPE) | FLAG | Es wird die Alarms&Events-Area gebrowsed | 20011102 | |||
| 2 | SERVER_DA | Call by reference | Type reference (TYPE) | FLAG | Es wird der DataAccess-Namensraum gebrowsed | 20011102 | |||
| 3 | SERVER_DESCR | Call by reference | Type reference (TYPE) | COOPC_SERVERTXT | Kurzbeschreibung des zu browsenden OPC-Servers | 20000915 | |||
| 4 | SERVER_ID | Call by reference | Type reference (TYPE) | COOPC_SERVERID | ID des zu browsenden OPC-Servers | 20000915 | |||
| 5 | SERVER_RFCDEST | Call by reference | Type reference (TYPE) | COOPC_RFCDEST | RFC-Destination des zu browsenden OPC-Servers | 20000915 |
Method GET_OPC_SERVER on class CL_OPC_NAMESPACE_TREE has no exception.
Method GET_SELECTED_TREEITEM Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ITEM_DESCR | Call by reference | Type reference (TYPE) | TEXT80 | Beschreibung des Items | 20000915 | |||
| 2 | ITEM_ID | Call by reference | Type reference (TYPE) | TEXT255 | Voll qualifizierte ID (Item-/Area-/Source-ID) | 20000915 | |||
| 3 | SELECTION_ALLOWED | Call by reference | Type reference (TYPE) | FLAG | Flag: 'X' die Selektion dieses Tokentyps ist erlaubt | 20011112 | |||
| 4 | TOKEN_TYPE | Call by reference | Type reference (TYPE) | CHAR1 | Art des Tokens (siehe Tokentype-Konstanten) | 20011102 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Kein OPC-Item im Tree ausgewählt | 20000915 |
Method GET_TREE_NODES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ITEM_TAB | Call by reference | Type reference (TYPE) | RCOOPC_TREEITEMS_TAB | Tree Control: Itemtabelle | 20000914 | |||
| 2 | NODE_TAB | Call by reference | Type reference (TYPE) | TREEV_NTAB | Tree Control: Knotentabelle | 20000914 | |||
| 3 | PARENT_NODE | Call by reference | Type reference (TYPE) | TV_NODEKEY | Schlüssel eines Eltern-Knotens | 20000914 |
Method GET_TREE_NODES on class CL_OPC_NAMESPACE_TREE has no exception.
Method ON_TOOLBAR_BUTTON_PRESSED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | FCODE | Value transfer | Attribute reference (LIKE) | 20000914 |
Method ON_TOOLBAR_BUTTON_PRESSED on class CL_OPC_NAMESPACE_TREE has no exception.
Method ON_TREEITEM_SELECTED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | NODE_KEY | Value transfer | Attribute reference (LIKE) | Schlüssel des Knotens | 20000914 |
Method ON_TREEITEM_SELECTED on class CL_OPC_NAMESPACE_TREE has no exception.
Method ON_TREE_EXPANDED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | NODE_KEY | Value transfer | Attribute reference (LIKE) | Schlüssel des Knotens | 20000914 |
Method ON_TREE_EXPANDED on class CL_OPC_NAMESPACE_TREE has no exception.
Method REFRESH_TREE Signature
Method REFRESH_TREE on class CL_OPC_NAMESPACE_TREE has no parameter.
Method REFRESH_TREE on class CL_OPC_NAMESPACE_TREE has no exception.
Method REFRESH_VALUES Signature
Method REFRESH_VALUES on class CL_OPC_NAMESPACE_TREE has no parameter.
Method REFRESH_VALUES on class CL_OPC_NAMESPACE_TREE has no exception.
Method SET_OPC_SERVER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | SEL_TOKENTYPES | Call by reference | Type reference (TYPE) | CLIKE | SPACE | Im Tree selektierbare Token-Typ(en) | 20011112 | ||
| 2 | SERVER_AE | Call by reference | Type reference (TYPE) | FLAG | SPACE | Alarms&Events-Area browsen | 20011102 | ||
| 3 | SERVER_DA | Call by reference | Type reference (TYPE) | FLAG | 'X' | DataAccess-Namensraum browsen | 20011102 | ||
| 4 | SERVER_DESCR | Call by reference | Type reference (TYPE) | COOPC_SERVERTXT | Kurzbeschreibung des zu browsenden OPC-Servers | 20000915 | |||
| 5 | SERVER_ID | Call by reference | Type reference (TYPE) | COOPC_SERVERID | ID des zu browsenden OPC-Servers | 20000915 | |||
| 6 | SERVER_RFCDEST | Call by reference | Type reference (TYPE) | COOPC_RFCDEST | RFC-Destination des zu browsenden OPC-Servers | 20000915 |
Method SET_OPC_SERVER on class CL_OPC_NAMESPACE_TREE has no exception.
Event Signatures
Event TREEITEM_SELECTED Signature
| # | Parameter | Type | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ITEM_DESCR | Exporting | Value transfer | Type reference (TYPE) | TEXT80 | Beschreibung des Items | 20000915 | ||
| 2 | ITEM_ID | Exporting | Value transfer | Type reference (TYPE) | TEXT255 | Voll qualifizierte ID (Item-/Source-/Area-ID) | 20000915 | ||
| 3 | TOKEN_TYPE | Exporting | Value transfer | Type reference (TYPE) | CHAR1 | Type des Items (siehe tokentype-Konstanten) | 20011102 |
History
| Last changed by/on | SAP | 20050109 |
| SAP Release Created in | 46C |