esrf

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

ICE_VDATA.MAC
See other macros in category: All
Description:
    Macros to handle IcePAP data vectors, used for instance for defining embedded trajectories.
Documentation:
    DESCRIPTION
    These macros allow to create a data vector from one to several data arrays of parameter, position or slope values.

    EXAMPLE
    short array myparam[4] short array mypos[4] array_op("fill", myparam) array_op("fill", mypos, 10) icepap_vdata_build vdata1 POSITION mypos 6 icepap_vdata_build vdata1 PARAMETER myparam 6 icepap_vdata_info vdata1

Macros:
    icepap_vdata_build
    Usage: icepap_vdata_build vector type array addr
    Update an IcePAP data vector with the content of the given data array. If the vector does not exist, it will be created, otherwise it will be enlarged with the new data. The type describe the kind of vector data which could be "PARAMETER", "POSITION", "SLOPE" The address given is the destination DRIVER address. Example: icepap_vdata_build vdata1 POSITION mypos 6

    icepap_vdata_info
    Usage: icepap_vdata_info vector_name
    Print information on given data vector

Internal Macros:
    _icepap_vdata_build
    Usage: _icepap_vdata_build (vector_name, type, array, addr, silent)
    Update an IcePAP data vector, given by its name. Returns non null if an error occured. TODO: -check if the given vector type is not already present in the vector Example: short array myparam[4] short array mypos[4] array_op("fill", myparam) array_op("fill", mypos, 10) _icepap_vdata_build("vdata1", "PARAMETER", myparam, 7) _icepap_vdata_build("vdata1", "POSITION", mypos, 7) _icepap_send_array("eutmp1", 7, "*PARDAT", vdata1) p _icepap_query("eutmp1","7","?pardat 0")

    _icepap_vdata_dump
    Usage: _icepap_vdata_dump (vector_data)
    Print given data vector as a byte array. For debug purpose only

    _icepap_vdata_info
    Usage: _icepap_vdata_info (vector_name, silent)
    Update stored information on given data vector. Returns non null if an error occured.

    _icepap_vdata_cleanup
    Usage: _icepap_vdata_cleanup (vector_name)
    Remove any stored information on given data vector

Filename: ice_vdata.mac
Author: MP BLISS (Original 02/2015).
$Revision: 1.1 $ / $Date: 2017/02/24 11:58:32 $
Last mod.: 24/02/2017 12:58 by perez