Museum

Home

Lab Overview

Retrotechnology Articles

Online Manuals

⇒ pinq_paths_descs(3g) — PHIGS 5.1

Media Vault

Software Library

Restoration Projects

Artifacts Sought

pinq_paths_descs(3g)  —  Subroutines

Name

pinq_paths_descs − Returns all the paths that are referenced by a structure. 

Operating States: PHOP, ∗, ∗, ∗
PHIGS standard function
 

Syntax

void pinq_paths_descs (
  Pint                   stid,       /∗ (I) Structure identifier. ∗/
  Ppath_order            order,      /∗ (I) Path order. ∗/
  Pint                   depth,      /∗ (I) Path depth. ∗/
  Pstore                 store,      /∗ (I) Handle to store the object.
                                            store manages the memory
                                            referenced by ∗paths. ∗/
  Pint                  ∗error_ind,  /∗ (O) Error indicator. ∗/
  Pelem_ref_list_list  ∗∗paths       /∗ (O) Structure path list. ∗/
)

 

Data Structures

typedef enum {
    PORDER_TOP_FIRST,       /∗ top first ∗/
    PORDER_BOTTOM_FIRST     /∗ bottom first ∗/
} Ppath_order;
typedef void ∗Pstore;
typedef struct {
    Pint              num_elem_ref_lists;  /∗ number of element reference
                                              lists ∗/
    Pelem_ref_list   ∗elem_ref_lists;      /∗ list of element reference
                                              lists ∗/
} Pelem_ref_list_list;
    typedef struct {
        Pint          num_elem_refs;  /∗ number of execute references ∗/
        Pelem_ref    ∗elem_refs;      /∗ list of execute references ∗/
    } Pelem_ref_list;
        typedef struct {
            Pint     struct_id;    /∗ structure identifier ∗/
            Pint     elem_pos;     /∗ element position∗/
        } Pelem_ref;

Description

pinq_paths_descs queries the structure state list and returns all the paths that are referenced by the specified structure.  Each path includes an execute reference of the form (structure identifier,0), which represents the bottommost element of the path.  The path order and path depth determine the section of each path to be returned, as follows:

Path Depth   Path Order   Description
------------------------------------------------------------------------
0            TOP FIRST    All paths to the specified structure are
                          returned in order of traversal.
 
1            TOP FIRST    All structures at the top of each structure
                          network that contains the specified structure
                          are returned.
1            BOTTOM       Can be used to determine all the bottommost
             FIRST        structures of the structure network.
2            TOP FIRST    All children of the specified structure are
                          returned.
------------------------------------------------------------------------

For the paths argument, the first value is the number (n) of execute reference lists returned.  Each of the subsequent n list elements is the address of an execute reference list.  The first value of each execute reference list is the number (m) of execute references in that list.  This count is followed by a list of m execute references.  Each execute reference is composed of a structure identifier and an element offset. 

See Also

pcreate_store
pdel_store
pexec_struct
pinq_paths_ances

Typewritten Software • bear@typewritten.org • Edmonds, WA 98026