home *** CD-ROM | disk | FTP | other *** search
/ Global Amiga Experience / globalamigaexperience.iso / graphic / cad / xcad3000 / xcdoc / listcomp < prev    next >
Encoding:
Text File  |  1995-07-10  |  6.0 KB  |  154 lines
  1.  
  2.    ? LIST COMPONENT
  3.  
  4.  
  5. LIST COMPONENT is used to extract a Component listing generated as a list of
  6. fixed-format records. The layout and  contents  of  the  output  listing  is
  7. driven  by  a  parameter  file  specified with the PFILE modifier.  For each
  8. valid Symbol identified in a drawing, a record is written to the text window
  9. or output file.  
  10.  
  11. The PFILE contains a set of instructions that must obey the format described
  12. below. Comment lines in the PFILE are indicated by an asterisk in the  first
  13. column.  Each  line  in the PFILE starts with one of 5 keywords that must be
  14. entered in upper-case text. These are:  
  15.  
  16.    ITEM        Describes a data-field in the output record.
  17.  
  18.    INCLUDE     Lists attribute that must be present on a Symbol for it
  19.                to be included in the report.
  20.  
  21.    EXCLUDE     Lists attributes that must not be present on a Symbol for
  22.                it to be included in the report.
  23.  
  24.    HEADER      Describes the format of the header to be generated at the
  25.                top of every page in the output report.
  26.  
  27.    PAGE        Indicates that maximum page length in the report.
  28.  
  29. The ITEM instruction is made up of  9  fields  including  the  ITEM  keyword
  30. itself. All text fields in an ITEM line must be entered in upper-case text.  
  31.  
  32.    ITEM key source attribute row col width just prec
  33.  
  34. For example:
  35.  
  36.    ITEM 1 SYM_TNODE_TEXT COMPNAME 1 30 20 L 0
  37.  
  38. "key"  is  entered  as  an integer number whose value must be unique for all
  39. ITEM lines in the PFILE. Note, the output  report  is  sorted  in  ascending
  40. order on the field described by the first ITEM line encountered.  
  41.  
  42. The  "source" field contains one of 7 keywords which describe where the data
  43. for the field is to be found. These keywords are:  
  44.  
  45.    SYM_TNODE_TEXT       The data is obtained as the value of a Text
  46.                         entity related to a Tnode related to the Symbol.
  47.                         The required Tnode is identified by the 
  48.                         "attribute" field.
  49.  
  50.    SYM_TERM_TEXT        The data is obtained as the value of a Text
  51.                         entity related to a Terminal related to the
  52.                         Symbol. The required Terminal is identified by
  53.                         the "attribute" field.
  54.  
  55.    SYM_ATTR_VAL         The data is obtained as the value of a specified
  56.                         attribute found on the Symbol. The required
  57.                         attribute is defined by the "attribute" field.
  58.  
  59.    SYM_NAME             The data is obtained as the name of the Symbol.
  60.  
  61.    SYM_FIRST_TEXT       The data is obtained as the value of a Text
  62.                         entity related to the first Tnode found on the
  63.                         Symbol. For this case an attribute is not
  64.                         specified.
  65.  
  66.    SYM_NET_LABEL        The data is obtained as the name of the network
  67.                         to which the Symbol is related.
  68.  
  69.    TNODE_TEXT           The data is obtained as the value of a Text
  70.                         entity related to any Tnode in the drawing that
  71.                         has the attribute specified in the "attribute"
  72.                         field.
  73.  
  74. The "attribute" field is used to enter an attribute name for "source" fields
  75. that  require  it. If an attribute name is not valid, the keyword NOVAL must
  76. be entered.  
  77.  
  78. "row" specifies the row number in the output record at which this data  item
  79. is placed.  
  80.  
  81. "col"  specifies  the column in the output record at which this data item is
  82. placed.  
  83.  
  84. "width" specifies the maximum width of the data item field.  
  85.  
  86. "just" is used to specify the justification of  the  data  item  within  its
  87. field. This can be one of 3 values:  
  88.  
  89.    L     For left justification.
  90.  
  91.    C     For centre justification.
  92.  
  93.    R     For right justification.
  94.  
  95. "prec"  specifies  the  number  of  places  of precision for data field that
  96. contain real numbers. Enter a zero if this field is not applicable.  
  97.  
  98. The INCLUDE instruction can be entered one or more times  to  specify  which
  99. Symbols  are to be included in the report by specifying a list of attributes
  100. that must be present on the symbol. The format for the INCLUDE line is:  
  101.  
  102.    INCLUDE attribute1 attribute2 ... attributeN
  103.  
  104. INCLUDE instructions are processed in the order they are found in the PFILE.
  105. If  any INCLUDE instructions are found in the PFILE, then the starting point
  106. is to exclude all Symbols. As each INCLUDE line is found,  any  Symbol  that
  107. meets  the  specified  criteria is included. Thus each separate INCLUDE line
  108. acts as an  "or"  instruction  in  that  so  long  as  a  Symbol  meets  the
  109. specification  of  any  of  the  INCLUDE  lines,  it will be included in the
  110. report.  
  111.  
  112. If an INCLUDE instruction contains more that one attribute name, then for  a
  113. Symbol to be included, it must have all of the attributes listed.  Thus this
  114. acts as an "and" instruction.  
  115.  
  116. EXCLUDE instructions act in the same was as INCLUDE  instructions  with  the
  117. exception  that  they  are used to exclude symbols from the report.  EXCLUDE
  118. instructions are  always  processed  after  INCLUDE  instructions  and  only
  119. operate on included Symbols.  
  120.  
  121. The  HEADER  instruction is used to indicate that the following set of lines
  122. delimited by the ENDHEAD keyword forms a header to be included at the top of
  123. each page. For example:  
  124.  
  125.    HEADER
  126.  
  127.    Name     Type     Description    Drawing
  128.    ----     ----     -----------    -------
  129.  
  130.    ENDHEAD
  131.  
  132. The 4 lines between the HEADER and ENDHEAD line form the page header.
  133.  
  134. The  PAGE  instruction is followed by a single integer specifying the number
  135. of lines that make a single page.  
  136.  
  137.  
  138.    COMMAND FORMAT
  139.  
  140.       #LIST COMPONENT modifiers :Symbol d1 ... dn
  141.  
  142. One or more Symbol entities are identified via IDENTS.
  143.  
  144.  
  145.    MODIFIERS
  146.  
  147. TO             Specifies the name of the output file to which the network
  148.                and component schedule is written. If this modifier is
  149.                not used, the schedule is printed to the text window.
  150.  
  151. PFILE          Specifies the name of the parameter file containing a
  152.                description of the output record, exclusion parameters and
  153.                pagination etc.
  154.