/* snpMap.h was originally generated by the autoSql program, which also 
 * generated snpMap.c and snpMap.sql.  This header links the database and
 * the RAM representation of objects. */

/* Copyright (C) 2013 The Regents of the University of California 
 * See kent/LICENSE or http://genome.ucsc.edu/license/ for licensing information. */

#ifndef SNPMAP_H
#define SNPMAP_H

#ifndef JKSQL_H
#include "jksql.h"
#endif

#define SNPMAP_NUM_COLS 6

struct snpMap
/* SNP positions from various sources */
    {
    struct snpMap *next;  /* Next in singly linked list. */
    char *chrom;	/* Chromosome or 'unknown' */
    unsigned chromStart;	/* Start position in chrom */
    unsigned chromEnd;	/* End position in chrom */
    char *name;	/* Name of SNP - rsId or Affy name */
    char *source;	/* BAC_OVERLAP | MIXED | RANDOM | OTHER | Affy10K | Affy120K */
    char *type;	/* SNP | INDEL | SEGMENTAL */
    };

void snpMapStaticLoad(char **row, struct snpMap *ret);
/* Load a row from snpMap table into ret.  The contents of ret will
 * be replaced at the next call to this function. */

struct snpMap *snpMapLoad(char **row);
/* Load a snpMap from row fetched with select * from snpMap
 * from database.  Dispose of this with snpMapFree(). */

struct snpMap *snpMapLoadAll(char *fileName);
/* Load all snpMap from whitespace-separated file.
 * Dispose of this with snpMapFreeList(). */

struct snpMap *snpMapLoadAllByChar(char *fileName, char chopper);
/* Load all snpMap from chopper separated file.
 * Dispose of this with snpMapFreeList(). */

#define snpMapLoadAllByTab(a) snpMapLoadAllByChar(a, '\t');
/* Load all snpMap from tab separated file.
 * Dispose of this with snpMapFreeList(). */

struct snpMap *snpMapLoadByQuery(struct sqlConnection *conn, char *query);
/* Load all snpMap from table that satisfy the query given.  
 * Where query is of the form 'select * from example where something=something'
 * or 'select example.* from example, anotherTable where example.something = 
 * anotherTable.something'.
 * Dispose of this with snpMapFreeList(). */

void snpMapSaveToDb(struct sqlConnection *conn, struct snpMap *el, char *tableName, int updateSize);
/* Save snpMap as a row to the table specified by tableName. 
 * As blob fields may be arbitrary size updateSize specifies the approx size
 * of a string that would contain the entire query. Arrays of native types are
 * converted to comma separated strings and loaded as such, User defined types are
 * inserted as NULL. Strings are automatically escaped to allow insertion into the database. */

struct snpMap *snpMapCommaIn(char **pS, struct snpMap *ret);
/* Create a snpMap out of a comma separated string. 
 * This will fill in ret if non-null, otherwise will
 * return a new snpMap */

void snpMapFree(struct snpMap **pEl);
/* Free a single dynamically allocated snpMap such as created
 * with snpMapLoad(). */

void snpMapFreeList(struct snpMap **pList);
/* Free a list of dynamically allocated snpMap's */

void snpMapOutput(struct snpMap *el, FILE *f, char sep, char lastSep);
/* Print out snpMap.  Separate fields with sep. Follow last field with lastSep. */

#define snpMapTabOut(el,f) snpMapOutput(el,f,'\t','\n');
/* Print out snpMap as a line in a tab-separated file. */

#define snpMapCommaOut(el,f) snpMapOutput(el,f,',',',');
/* Print out snpMap as a comma separated list including final comma. */

/* -------------------------------- End autoSql Generated Code -------------------------------- */

#endif /* SNPMAP_H */