Yorick Standard Library

Back to library index.

Package basfix (in basfix.i) - support for Basis-generated pdb files

Index of documented functions or symbols:

B

baget

baset

basfix

O

obasis

baget

DOCUMENT baget(file, varname)
  read and return the (first) variable named VARNAME in FILE.

  The obasis function opens files read-only.  If you want to update
  a PFB Basis-generated PDB file without altering its "@decorated"
  variable names, open the file with updateb, then use baset to
  modify variables.  Since you can only change the entire variable
  with baset, you may want to read it first with baget.

baset

DOCUMENT baset, file, varname, value
  set the (first) variable named VARNAME in FILE to VALUE.

  The obasis function opens files read-only.  If you want to update
  a PFB Basis-generated PDB file without altering its "@decorated"
  variable names, open the file with updateb, then use baset to
  modify variables.  Since you can only change the entire variable
  with baset, you may want to read it first with baget.

basfix

DOCUMENT #include "basfix.i"

  Provides functions obasis, baset, and baget to try to cope with
  Basis PDB file conventions.

  By default, the openb function is overloaded by the obasis
  function.  The original openb is called basfix_openb.  It is
  unclear what side effects this might have, but they are probably
  minor.  If you want to preserve the original openb function, set

       basfix= 1;

  BEFORE you include basfix.i.

obasis

DOCUMENT file= obasis(filename)
      or file= openb(filename)
      or file= openb(filename, clogfile)

  (If you typed help,openb and are reading this, then consider the
   latter two forms.  If you typed help,obasis, consider the first.
   In either case, the original openb function is called basfix_openb.)

  open the existing file FILENAME for read-only binary I/O.
  (Use updateb or createb, respectively, to open an existing file
   with read-write access or to create a new file.)
  If the CLOGFILE argument is supplied, it represents the structure
  of FILENAME in the Clog binary data description language.
  After an openb, the file variable may be used to extract variables
  from the file as if it were a structure instance.  That is, the
  expression "file.var" refers to the variable "var" in file "file".
  A complete list of the variable names present in the file may
  be obtained using the get_vars function.  If the file contains
  history records, the jt and jc functions may be used to set the
  current record -- initially, the first record is current.
  The restore function may be used to make memory copies of data
  in the file; this will be faster than a large number of
  references to "file.var".