ZBROW CLASS: Display class name information

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

Last updated

Changed for PUT00.

Requirements and restrictions

You must initialize z/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:

When you specify the DISPLAY parameter, the ALL parameter displays all class names and their locations.
When you specify the DOCUMENT parameter, the ALL parameter dumps either of the following to the printer:
- All the documentation for all methods for a class
- All the documentation for all the classes and all methods in z/TPF collection support.

SORT

sorts the class or method names displayed. When SORT is used with DISPLAY, the class is displayed by location (address, ID1 field, ID2 field, or name. When SORT is used with METHOD, the sorting is performed by address, name, or type. If you do not specify the SORT parameter, names are displayed in no particular order. When used with the DISPLAY parameter, the SORT parameter is useful only when ALL is specified.

ADDR

The address of the class or method.

ID1

The class or method primary identifier.

ID2

The class or method secondary identifier.

NAME

The name of the class or method.

TYPE

The type of method, which can be one of the following:

C - for class
I - for instance
P - for private

DOCument

dumps information to a file for 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:

If you specify the NAME parameter, class information is dumped to a file.
If you specify the ALL parameter, all method information for a class is dumped to a file.
If you specify the METHOD parameter method information for a specified method and class is dumped to a file.
If you specify the ALL parameter without the NAME parameter information for all methods for all classes is dumped to a file.

Method-methodname

specifies the name of the method, where methodname is a 1- to 64-character method name.

When you specify this parameter with the DOCUMENT parameter, method information for the specified class and method is dumped to the printer.
When you specify this parameter with the LOCATE parameter, the locations of all methods that start with the specified character string for the specified class are displayed.

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 following example displays the class attributes for a z/TPFCS class. 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 z/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 following example show the location of a class dictionary.

User:   ZBROW CLASS DISP NAME-DICTIONARY

System: BROW0201I 13.34.04 LOCATION - 01DF30A8  NAME - DICTIONARY
        BROW0210I 13.34.04 BROWSE OF CLASS COMPLETED

The following example shows all class names.

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

The following example shows all the class names and locations (in ascending address sequence).

User:   ZBROW CLASS DISP ALL SORT-ADDR

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 following example shows that the class documentation for the class DICTIONARY is dumped to file //tmp/to2classdoc.log .

User:   ZBROW CLASS DOC NAME-DICTIONARY

System: BROW0101I 08.28.07 OUTPUTTING CLASS TO /tmp/to2classdoc.log
        BROW0210I 08.28.07 BROWSE OF CLASS COMPLETED

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

User:   ZBROW CLASS DOC NAME-DICTIONARY METHOD-NEW

System: BROW0101I 08.28.07 OUTPUTTING CLASS TO /tmp/to2classdoc.log
        BROW0210I 08.28.07 BROWSE OF CLASS COMPLETED

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

User:   ZBROW CLASS DOC NAME-DICTIONARY METHOD-ALL

System: BROW0101I 08.28.07 OUTPUTTING CLASS TO /tmp/to2classdoc.log
        BROW0210I 08.28.07 BROWSE OF CLASS COMPLETED

The following example shows that the information for all z/TPFCS collections is dumped.

User:   ZBROW CLASS DOC ALL

System: BROW0101I 08.28.07 OUTPUTTING CLASS DOCUMENTATION TO /tmp/to2classdoc.log
        BROW0210I 08.28.07 BROWSE OF CLASS COMPLETED

The following example show a sample of printer output for ZBROW CLASS DOCUMENT METHOD NAME.

********************************************************************************
 ** 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

The following example shows a sample of printer output for ZBROW CLASS DOCUMENT NAME ALL.

********************************************************************************
********************************************************************************
 ** 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 following example shows the class information for the OIDentry class.

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 following example shows the location of all methods that start with at for class DICTIONARY.

User:   ZBROW CLASS LOCATE NAME-DICTIONARY METHOD-at

System: CSMP0097I 09.10.48 CPU-B SS-BSS  SSU-HPN  IS-01
        BROW0202I 09.02.43 CLASS LOCATION DISPLAY
        ADDRESS     TYPE    NAME
        101A4450    I       atKey
        101A5164    I       atKeyWithBuffer
        101A4768    I       atKeyPut
        101A4D80    I       atNewKeyPut
        101A5130    I       at
        101A5130    I       atPut
        END OF DISPLAY
        BROW0210I 09.02.43 BROWSE OF CLASS COMPLETED

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

User:   ZBROW CLASS MAP

System: BROW0101I 13.34.12 OUTPUTTING CLASS MAP TO /tmp/to2classmap.log
        BROW0210I 13.34.12 BROWSE OF CLASS COMPLTED

The following example shows a sample of printer output from ZBROW CLASS MAP.

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 following example shows the location and type (Class, Internal, or Private) of all methods for class DICTIONARY.

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

The following example shows all the class methods and locations (in ascending address sequence) for class DICTIONARY.

User:   
ZBROW CLASS METHOD NAME-DICTIONARY SORT-ADDR

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 following example shows the class inheritance tree for class DICTIONARY.

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 for more information about z/TPFCS:

z/TPF Application Programming
z/TPF Concepts and Structures
z/TPF Database User's Guide.