esrf

Beamline Instrument Software Support
SPEC Macro documentation: [ Macro Index | BCU Home ]

GROUPS.MAC
[ source code | installed at | configured at ]
See other macros in category: Tools
Description:
    Macros for handling motors in groups
Documentation:
    DESCRIPTION
    This package defines some macros for handling motors in groups. Macros for defining the groups, adding and deleting motors from a group, and to display the motors and motor positions for a group are available.

Macros:
    group
    Usage: group <function> <group> <motor> <motor> ...
    The user interface. Group can be called with the following arguments and functions:
    group
    display short explanatory text
    group reset
    deletes all groups except "others" and adds all motors into "others"
    group update [-q]
    to be called after config. Removed "dead" motors and adds new motors to group "others"
    group add [-q] <group> <motor> <motor> ...
    add motors to a group and delete them from their previous group. if <group> does not exist, it will be created. If any empty groups result from the operation, they will be deleted.
    group delete [-q] <group> <motor> <motor> ...
    same as group add others <motor> ... except that if no motor is specified, the complete group will be moved to others Note that group delete others <motor> has no effect!
    group list [-a] <group>
    display list of motors in group. if no group is specified, all groups are listed
    group where [-a] <group>
    display positions of all motors in group. if no group is specified, the motors of all groups are listed
    group hide [-q] <group> <group> ...
    hide groups so that they are not listed by group where and group list commands
    group unhide [-q] <group> <group> ...
    remove hidden status of groups.


    wg
    Usage: wg
    Abbreviation for group where

Internal Macros:
    del_item
    Usage: del_item <substring> <string>
    delete <substring> from <string>

    isgroup
    Usage: isgroup <mne>
    is this mnemonic a current group?

    group_purge
    Usage: group_purge(quiet)
    delete all empty groups

    group_reset
    Usage: group_reset


    group_hide
    Usage: group_hide


    group_update
    Usage: group_update


    group_add
    Usage: group_add


    group_delete
    Usage: group_delete


    group_list
    Usage: group_list


    group_where
    Usage: group_where


    group_show_motor_info
    Usage: group_show_motor_info(f, ns, n, mA)
    Internal macro used to display motor information at 8 motors per line. Listing of motors named "unused" or that are disabled is suppressed. First argument is array of info-types as "name", "mne", "user", "dial", "lim+", "lim-", "ulim+" and "ulim-". Second argument is number of elements in array. Third argument is number of motors. If first argument is a single string as above, that is okay.

    group_index
    Usage: group_index
    Sethe groups indexes in arrays.

    show_grp
    Usage: show_grp [group_name or all]
    Show a group_name or all groups as 8 motors/line.

    show_grpf
    Usage: show_grpf (ind)
    Show a group (defined by its index) as 8 motors/line.

Filename: groups.mac
Author: GROUP.MAC - C.D., AB
$Revision: 1.3 $, $Date: 2008/04/25 08:13:08 $
Last mod.: 25/04/2008 10:13 by rey