gtpo1m1qOperations

ZBROW CLASS-Display Class Name Information

Use this command to display information about a class for TPF collection support (TPFCS).

Requirements and Restrictions

You must initialize TPFCS and define the target data store (DS) before you enter this command.

Format




ATTributes
displays the names and values of all the class attributes of the class.

Name-classname
specifies the name of the class, where classname is a 1- to 64-character class name.

DISplay
displays the location of the specified class name or displays all the class names and their locations.

ALL
specifies one of the following:

SORTA
sorts the class or method names displayed by location (address). If you do not specify the SORTA parameter, names are displayed in no particular order. When used with the DISPLAY parameter, the SORTA parameter is only useful when ALL is specified.

DOCument
dumps documentation contained in the prologs of the specified class or all classes and its methods to the printer. The information that is dumped is based on the other parameters you specify, as follows:

Method-methodname
specifies the name of the method, where methodname is a 1- to 64-character method name.
Note:
If no methods start with the specified character string for the specified class, the method location display table will be empty.

INFO
displays information about a specific class.

LOCate
displays the location of the specified method or methods for the specified class name.

MAP
dumps the location of all class names and their methods sorted by address to the printer.

METhod
displays the location, type, and name of all the methods for the specified class name. Type can be one of the following:

C
Class

I
Instance

P
Private

TREE
displays the names of all classes from which the specified class inherits.
Note:
The class inheritance for class dictionary is displayed in reverse order; that is, the class most directly inherited from is displayed first.

Additional Information

None.

Examples

The class attributes for a TPFCS class are displayed in the following example. This example shows that the method trace table is active (01) and dump creation on a TO2_getErrorText function call is not active (00). See ZOODB SET-Set TPF Collection Support for more information about setting the class attributes.

+--------------------------------------------------------------------------------+
|User:   ZBROW CLASS ATTR NAME-TO2                                               |
|                                                                                |
|System: BROW0206I 17.31.04 CLASS ATTRIBUTES DISPLAY                             |
|        ATTRIBUTE                           VALUE                               |
|        TO2_C_ASSEM_DATE                    08/28/96                            |
|        TO2_C_ASSEM_TIME                    08.22                               |
|        TO2_C_USER_TRACE_COUNT              00000020                            |
|        TO2_C_METHOD_COUNT                  00000200                            |
|        TO2_C_INITIALIZED                   01                                  |
|        TO2_C_METHOD_TRACE                  01                                  |
|        TO2_C_DUMP_GET_TEXT                 00                                  |
|        END OF DISPLAY                                                          |
|        BROW0210I 17.31.04 BROWSE OF CLASS COMPLETED                            |
+--------------------------------------------------------------------------------+

The location of a class dictionary is shown in the following example.

+--------------------------------------------------------------------------------+
|User:   ZBROW CLASS DISP NAME-DICTIONARY                                        |
|                                                                                |
|System: BROW0201I 13.34.04 LOCATION - 01DF30A8  NAME - DICTIONARY               |
|        BROW0210I 13.34.04 BROWSE OF CLASS COMPLETED                            |
+--------------------------------------------------------------------------------+

All class names are displayed in the following example.

+--------------------------------------------------------------------------------+
|User:   ZBROW CLASS DISP ALL                                                    |
|                                                                                |
|System: BROW0202I 13.24.10 CLASS LOCATION DISPLAY                               |
|        LOCATION    ID1     ID2     NAME                                        |
|        013A14A0       1    0004    COLLECTION                                  |
|        013D73C0       2    0008    Collect                                     |
|        013DBA78       3    000C    ARRAY                                       |
|        013E3FA0       4    0010    Set                                         |
|        013E55B8       5    0014    Ordered                                     |
|        013DE1D0       6    0018    Log                                         |
|        013E8500       7    001C    Dictionary                                  |
|        014513C8       8    0020    TPF_Dictionary                              |
|        013B3220       9    0024    ENV                                         |
|        0144B020      10    0028    DB_OBJ                                      |
|        0145E5E0      11    002C    xternalObject                               |
|        013C0E40      12    0030    USER_OBJ                                    |
|        013BB7E8      13    0034    PIDentry                                    |
|        013DEE10      14    0038    KeyedLog                                    |
|        013E11A0      15    003C    Bag                                         |
|        013E2760      16    0040    ByteArray                                   |
|        0139D7A0      17    0044    TPFservice                                  |
|        MORE DATA AVAILABLE, ENTER ZPAGE TO CONTINUE                            |
+--------------------------------------------------------------------------------+

All the class names and locations (in ascending address sequence) are displayed in the following example.

+--------------------------------------------------------------------------------+
|User:   ZBROW CLASS DISP ALL SORTA                                              |
|                                                                                |
|System: BROW0202I 13.25.29 CLASS LOCATION DISPLAY                               |
|        LOCATION    ID1     ID2     NAME                                        |
|        0139D7A0      17    0044    TPFservice                                  |
|        013A0650     120    01E0    TO2_HEAP                                    |
|        013A14A0       1    0004    COLLECTION                                  |
|        013A5288     188    02F0    ObjectPart                                  |
|        013A69A0     119    01DC    TO2                                         |
|        013AEE18     196    0310    TO2_CLASS_ENTRY                             |
|        013AF360     172    02B0    TaskServices                                |
|        013AFCE8     173    02B4    TaskServiceClass                            |
|        013B0510     174    02B8    TaskServiceObject                           |
|        013B0FA8      26    0068    ObjectTable                                 |
|        013B3220       9    0024    ENV                                         |
|        013B3DC0      25    0064    PIDnumber                                   |
|        013B5BA8      49    00C4    PIDnumberPersistent                         |
|        013B7A78     168    02A0    PIDnumberPersistentFormat0                  |
|        013B8478     169    02A4    PIDnumberPersistentFormat1                  |
|        013B8C30     170    02A8    PIDnumberPersistentFormat2                  |
|        013B9B58      50    00C8    PIDnumberTemporary                          |
|        MORE DATA AVAILABLE, ENTER ZPAGE TO CONTINUE                            |
+--------------------------------------------------------------------------------+

The class documentation for the class DICTIONARY is dumped to the printer in the following example.

+--------------------------------------------------------------------------------+
|User:   ZBROW CLASS DOC NAME-DICTIONARY                                         |
|                                                                                |
|System: BROW0210I 08.28.07 BROWSE OF CLASS COMPLETED                            |
+--------------------------------------------------------------------------------+

The class documentation for the NEW method of class DICTIONARY is dumped in the following example.

+--------------------------------------------------------------------------------+
|User:   ZBROW CLASS DOC NAME-DICTIONARY METHOD-NEW                              |
|                                                                                |
|System: BROW0210I 08.28.07 BROWSE OF CLASS COMPLETED                            |
+--------------------------------------------------------------------------------+

The class documentation for all of the methods of class DICTIONARY are dumped in the following example.

+--------------------------------------------------------------------------------+
|User:   ZBROW CLASS DOC NAME-DICTIONARY ALL                                     |
|                                                                                |
|System: BROW0210I 08.28.07 BROWSE OF CLASS COMPLETED                            |
+--------------------------------------------------------------------------------+

The documentation for all TPFCS collections is dumped in the following example.

+--------------------------------------------------------------------------------+
|User:   ZBROW CLASS DOC ALL                                                     |
|                                                                                |
|System: BROW0210I 08.28.07 BROWSE OF CLASS COMPLETED                            |
+--------------------------------------------------------------------------------+

A sample of printer output is shown for ZBROW CLASS DOCUMENT METHOD NAME in the following example.

+--------------------------------------------------------------------------------+
|********************************************************************************|
| ** Method Name - ADDALLFROM                                                    |
|                                                                                |
|      This method is invoked to add all the elements of a source                |
|    collection to the specified object collection. No validation                |
|    is done on the source collection to determine if it can be                  |
|    added to the target collection.                                             |
|                                                                                |
|    Input  R1  ->  collection to add to target collection                       |
|    Output R15 ->  target collection                                            |
|                   TO2_ERROR_EMPTY  source collection empty                     |
+--------------------------------------------------------------------------------+

A sample of printer output is shown for ZBROW CLASS DOCUMENT NAME ALL in the following example.

+--------------------------------------------------------------------------------+
|********************************************************************************|
|********************************************************************************|
| ** Method Name - deleteCollection                                              |
|                                                                                |
|                                                                                |
|    Input  R2   ->   address of structure object to delete                      |
|    Output R15  ->   none                                                       |
|                                                                                |
|                                                                                |
|********************************************************************************|
| ** Method Name - chainAllocatedFA                                              |
|                                                                                |
|                                                                                |
|    Input  R1   -> word1 ->  core block for new record                          |
|                   word2 ->  directory entry (new record)                       |
|                   word3 ->  RecID and RCC values                               |
|           R2   ->   address of structure object                                |
|    Output R15  ->   core block address if successful                           |
|                     logic error code if directory contains 0 FA.               |
|                                                                                |
+--------------------------------------------------------------------------------+

The class information for the OIDentry class is displayed in the following example.

+--------------------------------------------------------------------------------+
|User:   ZBROW CLASS INFO NAME-OIDENTRY                                          |
|                                                                                |
|System: BROW0205I 18.42.48 CLASS INFORMATION DISPLAY                            |
|        NAME - OIDentry                                                         |
|        ID - x0000000D , x00000034                                              |
|        ADDR - x01CA6EA8 LGH - x00004B8A                                        |
|        CLASS METHOD COUNT - x00000001 INSTANCE METHOD COUNT - x00000029        |
|        HASH VALUE - x00FB SYNONYM COUNT - x0012                                |
|        END OF DISPLAY                                                          |
|        BROW0210I 18.42.48 BROWSE OF CLASS COMPLETED                            |
+--------------------------------------------------------------------------------+

The location of all methods that start with at for class DICTIONARY are displayed in the following example.

+--------------------------------------------------------------------------------+
|User:   ZBROW CLASS LOCATE NAME-DICTIONARY METHOD-at                            |
|                                                                                |
|System: BROW0203I 13.34.12 METHOD LOCATION DISPLAY                              |
|        ADDRESS     TYPE    NAME                                                |
|        01DF3CA4    I       atKey                                               |
|        01DF4344    I       atKeyWithBuffer                                     |
|        01DF3E08    I       atKeyPut                                            |
|        01DF408C    I       atNewKeyPut                                         |
|        01DF42B8    I       at                                                  |
|        01DF42B8    I       atPut                                               |
|        END OF DISPLAY                                                          |
|        BROW0210I 13.34.12 BROWSE OF CLASS COMPLETED                            |
+--------------------------------------------------------------------------------+

The information for all classes defined in TPF collection support is dumped to the printer in the following example.

+--------------------------------------------------------------------------------+
|User:   ZBROW CLASS MAP                                                         |
|                                                                                |
|System: BROW0210I 13.34.12 BROWSE OF CLASS COMPLETED                            |
+--------------------------------------------------------------------------------+

A sample of printer output from ZBROW CLASS MAP is shown in the following example.

+--------------------------------------------------------------------------------+
|NAME - TPFservice                                                               |
|ID - x00000011 , x00000044                                                      |
|ADDR - x01C84D70 LGH - x0000357C                                                |
|CLASS METHOD COUNT - x0000002F INSTANCE METHOD COUNT - x00000000                |
|HASH VALUE - x0000 SYNONYM COUNT - x0000                                        |
|ADDR 01C8534C TYPE C NAME inheritFixedMethods                                   |
|ADDR 01C85658 TYPE C NAME getStorage                                            |
|ADDR 01C856F8 TYPE C NAME freeStorage                                           |
|ADDR 01C85798 TYPE C NAME releaseBlock                                          |
|ADDR 01C8584C TYPE C NAME getBlock                                              |
|ADDR 01C858FC TYPE C NAME getSSindex                                            |
|ADDR 01C859B8 TYPE C NAME getFileAddress                                        |
|ADDR 01C85A9C TYPE C NAME readRecord                                            |
|ADDR 01C85BB4 TYPE C NAME readRecordNoWait                                      |
|ADDR 01C85C58 TYPE C NAME lockReadRecord                                        |
|ADDR 01C85D7C TYPE C NAME fileUnlockRecord                                      |
|ADDR 01C85E68 TYPE C NAME fileRecord                                            |
|ADDR 01C85F88 TYPE C NAME fileRecordNoWait                                      |
|ADDR 01C86030 TYPE C NAME fileRecordWithReleaseNoWait                           |
|ADDR 01C860E0 TYPE C NAME fileUnlockRecordWithReleaseNoWait                     |
|ADDR 01C861A0 TYPE C NAME unLockRecord                                          |
+--------------------------------------------------------------------------------+

The location and type (Class, Internal, or Private) of all methods for class DICTIONARY are displayed in the following example.

+--------------------------------------------------------------------------------+
|User:   ZBROW CLASS METHOD NAME-DICTIONARY                                      |
|                                                                                |
|System: BROW0203I 13.34.12 METHOD LOCATION DISPLAY                              |
|        ADDRESS     TYPE    NAME                                                |
|        013E8F9C    C       createUser                                          |
|        013E8D34    C       newX                                                |
|        013E898C    C       new                                                 |
|        013E8B60    C       newFix                                              |
|        013E90E4    I       atKey                                               |
|        013E9784    I       atKeyWithBuffer                                     |
|        013E9248    I       atKeyPut                                            |
|        013E94CC    I       atNewKeyPut                                         |
|        013E960C    I       removeKey                                           |
|        013E99E0    I       newCursorRead                                       |
|        013E9AD8    I       newCursorWrite                                      |
|        013E9BD0    I       newCursorReadWrite                                  |
|        013E96F8    I       at                                                  |
|        013E96F8    I       atPut                                               |
|        013E96F8    I       add                                                 |
|        013E96F8    I       remove                                              |
|        013E988C    I       convertToDASD                                       |
|        MORE DATA AVAILABLE, ENTER ZPAGE TO CONTINUE                            |
+--------------------------------------------------------------------------------+

All the class methods and locations (in ascending address sequence) are displayed for class DICTIONARY in the following example.

+--------------------------------------------------------------------------------+
|User:   ZBROW CLASS METHOD NAME-DICTIONARY SORTA                                |
|                                                                                |
|System: BROW0203I 13.41.34 METHOD LOCATION DISPLAY                              |
|        ADDRESS     TYPE    NAME                                                |
|        013E898C    C       new                                                 |
|        013E8B60    C       newFix                                              |
|        013E8D34    C       newX                                                |
|        013E8F9C    C       createUser                                          |
|        013E90E4    I       atKey                                               |
|        013E9248    I       atKeyPut                                            |
|        013E94CC    I       atNewKeyPut                                         |
|        013E960C    I       removeKey                                           |
|        013E96F8    I       at                                                  |
|        013E96F8    I       atPut                                               |
|        013E96F8    I       add                                                 |
|        013E96F8    I       remove                                              |
|        013E9784    I       atKeyWithBuffer                                     |
|        013E988C    I       convertToDASD                                       |
|        013E99E0    I       newCursorRead                                       |
|        013E9AD8    I       newCursorWrite                                      |
|        013E9BD0    I       newCursorReadWrite                                  |
|        MORE DATA AVAILABLE, ENTER ZPAGE TO CONTINUE                            |
+--------------------------------------------------------------------------------+

The class inheritance tree for class DICTIONARY is displayed in the following example.

+--------------------------------------------------------------------------------+
|User:   ZBROW CLASS TREE NAME-DICTIONARY                                        |
|                                                                                |
|System: BROW0204I 13.34.12 CLASS INHERITANCE DISPLAY                            |
|        NAME Dictionary                                                         |
|        NAME CollectKey                                                         |
|        NAME Collect                                                            |
|        NAME ObjectPart                                                         |
|        NAME OBJECT                                                             |
|        END OF DISPLAY                                                          |
|        BROW0210I 13.34.12 BROWSE OF CLASS COMPLETED                            |
+--------------------------------------------------------------------------------+

Related Information

See the following books for more information about TPFCS: