first previous next last contents

get_read_info, get_vector_info, get_clone_info and get_subclone_info

#include <IO.h>

int get_read_info(
        GapIO  *io,
        int     N,
        char   *clone,
        int     l_clone,
        char   *cvector,
        int     l_cvector,
        char   *subclone,
        int     l_subclone,
        char   *scvector,
        int     l_scvector,
        int    *length,
        int    *insert_min,
        int    *insert_max,
        int    *direction,
        int    *strands,
        int    *primer,
        int    *clone_id,
        int    *subclone_id,
        int    *cvector_id,
        int    *scvector_id);

int get_vector_info(
        GapIO  *io,
        int     vector_id,
        char   *vector,
        int l_vector);

int get_clone_info(
        GapIO  *io,
        int     clone_id,
        char   *clone,
        int     l_clone,
        char   *cvector,
        int     l_cvector,
        int    *cvector_id);

int get_subclone_info(
        GapIO  *io,
        int     subclone_id,
        char   *clone,
        int     l_clone,
        char   *cvector,
        int     l_cvector,
        char   *subclone,
        int     l_subclone,
        char   *scvector,
        int     l_scvector,
        int    *insert_min,
        int    *insert_max,
        int    *strands,
        int    *clone_id,
        int    *cvector_id,
        int    *scvector_id);

These functions return clone, template and vector information.

get_vector_info returns the name of a vector. This is stored in the buffer at vector.

get_clone_info function returns the name of the clone and the vector number (stored at clone and cvector_id and results of get_vector_info for this vector.

get_subclone_info returns the template information (insert size, number of strands, vector and clone numbers stored at insert_min, insert_max, strands, scvector_id and clone_id) along with the results from get_vector_info and get_clone_info on the appropriate vector and clone numbers.

get_read_info returns the reading information including direction, primer, template (subclone) number (stored at direction, strands, primer, and clone_id), and the results of the get_subclone_info on this template number.

For all four functions, the arguments used to store text fields, such as the clone name (clone), all have corresponding buffer lengths sent as the same argument name preceeded by l_ (eg l_clone). These buffers need to be allocated by the caller of the function.

Any buffer or integer pointer arguments may be passed as NULL to avoid filling in this field. For buffers the same is also true when specifying the buffer length as zero.

The clone, vector and subclone buffers are used to store the names of the clone, vector or template. If appropriate, the clone or template number will also be stored at the clone_id and subclone_id addresses.

For functions returning information more than one vector, these are split into two levels. The sequencing vector is the vector used to sequence this template. It has arguments named scvector (name), l_scvector (name length) and scvector_id (vector number). The clone vector is the vector used in the sequecing of the fragment which is later broken down and resequenced as templates. This may not be appropriate in many projects. It has arguments named cvector (name), l_cvector (name length) and cvector_id (vector number).

All functions return 0 for success and an error code for failure.


first previous next last contents
This page is maintained by staden-package. Last generated on 1 March 2001.
URL: http://www.mrc-lmb.cam.ac.uk/pubseq/manual/scripting_125.html