File: enstranslation.h

package info (click to toggle)
emboss 6.6.0%2Bdfsg-7
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 571,544 kB
  • sloc: ansic: 460,579; java: 29,439; perl: 13,573; sh: 12,754; makefile: 3,283; csh: 706; asm: 351; xml: 239; pascal: 237; modula3: 8
file content (273 lines) | stat: -rw-r--r-- 9,544 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
/* @include enstranslation ****************************************************
**
** Ensembl Translation functions
**
** @author Copyright (C) 1999 Ensembl Developers
** @author Copyright (C) 2006 Michael K. Schuster
** @version $Revision: 1.30 $
** @modified 2009 by Alan Bleasby for incorporation into EMBOSS core
** @modified $Date: 2013/02/17 13:10:30 $ by $Author: mks $
** @@
**
** This library is free software; you can redistribute it and/or
** modify it under the terms of the GNU Lesser General Public
** License as published by the Free Software Foundation; either
** version 2.1 of the License, or (at your option) any later version.
**
** This library is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
** Lesser General Public License for more details.
**
** You should have received a copy of the GNU Lesser General Public
** License along with this library; if not, write to the Free Software
** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
** MA  02110-1301,  USA.
**
******************************************************************************/

#ifndef ENSTRANSLATION_H
#define ENSTRANSLATION_H

/* ========================================================================= */
/* ============================= include files ============================= */
/* ========================================================================= */

#include "ensdata.h"
#include "ensprotein.h"

AJ_BEGIN_DECLS




/* ========================================================================= */
/* =============================== constants =============================== */
/* ========================================================================= */




/* ========================================================================= */
/* ============================== public data ============================== */
/* ========================================================================= */




/* ========================================================================= */
/* =========================== public functions ============================ */
/* ========================================================================= */

/*
** Prototype definitions
*/

void ensTranslationInit(void);

void ensTranslationExit(void);

const AjPTrn ensTranslationCacheGet(ajint codontable);

/* Ensembl Translation */

EnsPTranslation ensTranslationNewCpy(const EnsPTranslation translation);

EnsPTranslation ensTranslationNewIni(EnsPTranslationadaptor tla,
                                     ajuint identifier,
                                     EnsPExon startexon,
                                     EnsPExon endexon,
                                     ajuint start,
                                     ajuint end,
                                     AjPStr sequence,
                                     AjPStr stableid,
                                     ajuint version,
                                     AjPStr cdate,
                                     AjPStr mdate);

EnsPTranslation ensTranslationNewRef(EnsPTranslation translation);

void ensTranslationDel(EnsPTranslation *Ptranslation);

EnsPTranslationadaptor ensTranslationGetAdaptor(
    const EnsPTranslation translation);

AjPStr ensTranslationGetDateCreation(const EnsPTranslation translation);

AjPStr ensTranslationGetDateModification(const EnsPTranslation translation);

ajuint ensTranslationGetEnd(const EnsPTranslation translation);

EnsPExon ensTranslationGetEndexon(const EnsPTranslation translation);

ajuint ensTranslationGetIdentifier(const EnsPTranslation translation);

AjPStr ensTranslationGetStableidentifier(const EnsPTranslation translation);

ajuint ensTranslationGetStart(const EnsPTranslation translation);

EnsPExon ensTranslationGetStartexon(const EnsPTranslation translation);

ajuint ensTranslationGetVersion(const EnsPTranslation translation);

const AjPList ensTranslationLoadAttributes(EnsPTranslation translation);

const AjPList ensTranslationLoadDatabaseentries(EnsPTranslation translation);

const AjPList ensTranslationLoadProteinfeatures(EnsPTranslation translation);

AjBool ensTranslationSetAdaptor(EnsPTranslation translation,
                                EnsPTranslationadaptor tla);

AjBool ensTranslationSetIdentifier(EnsPTranslation translation,
                                   ajuint identifier);

AjBool ensTranslationSetStartexon(EnsPTranslation translation,
                                  EnsPExon exon);

AjBool ensTranslationSetEndexon(EnsPTranslation translation,
                                EnsPExon exon);

AjBool ensTranslationSetStart(EnsPTranslation translation,
                              ajuint start);

AjBool ensTranslationSetEnd(EnsPTranslation translation,
                            ajuint end);

AjBool ensTranslationSetStableidentifier(EnsPTranslation translation,
                                         AjPStr stableid);

AjBool ensTranslationSetVersion(EnsPTranslation translation,
                                ajuint version);

AjBool ensTranslationSetDateCreation(EnsPTranslation translation,
                                     AjPStr cdate);

AjBool ensTranslationSetDateModification(EnsPTranslation translation,
                                         AjPStr mdate);

AjBool ensTranslationAddAttribute(EnsPTranslation translation,
                                  EnsPAttribute attribute);

AjBool ensTranslationAddDatabaseentry(EnsPTranslation translation,
                                      EnsPDatabaseentry dbe);

AjBool ensTranslationAddProteinfeature(EnsPTranslation translation,
                                       EnsPProteinfeature pf);

size_t ensTranslationCalculateMemsize(const EnsPTranslation translation);

ajint ensTranslationCalculateSliceEnd(EnsPTranslation translation);

ajint ensTranslationCalculateSliceStart(EnsPTranslation translation);

ajuint ensTranslationCalculateTranscriptEnd(EnsPTranslation translation);

ajuint ensTranslationCalculateTranscriptStart(EnsPTranslation translation);

AjBool ensTranslationFetchAllAttributes(EnsPTranslation translation,
                                        const AjPStr code,
                                        AjPList attributes);

AjBool ensTranslationFetchAllDatabaseentries(EnsPTranslation translation,
                                             const AjPStr name,
                                             EnsEExternaldatabaseType type,
                                             AjPList dbes);

AjBool ensTranslationFetchAllDomains(EnsPTranslation translation,
                                     AjPList pfs);

AjBool ensTranslationFetchAllProteinfeatures(EnsPTranslation translation,
                                             const AjPStr name,
                                             AjPList pfs);

AjBool ensTranslationFetchAllSequenceedits(EnsPTranslation translation,
                                           AjPList ses);

AjBool ensTranslationFetchDisplayidentifier(const EnsPTranslation translation,
                                            AjPStr *Pidentifier);

AjBool ensTranslationTrace(const EnsPTranslation translation, ajuint level);

AjBool ensTranslationFetchSequenceSeq(EnsPTranslation translation,
                                      AjPSeq *Psequence);

AjBool ensTranslationFetchSequenceStr(EnsPTranslation translation,
                                      AjPStr *Psequence);

/* Ensembl Translation Adaptor */

EnsPTranslationadaptor ensRegistryGetTranslationadaptor(
    EnsPDatabaseadaptor dba);

EnsPTranslationadaptor ensTranslationadaptorNew(
    EnsPDatabaseadaptor dba);

void ensTranslationadaptorDel(EnsPTranslationadaptor *Ptla);

EnsPBaseadaptor ensTranslationadaptorGetBaseadaptor(
    EnsPTranslationadaptor tla);

EnsPDatabaseadaptor ensTranslationadaptorGetDatabaseadaptor(
    EnsPTranslationadaptor tla);

AjBool ensTranslationadaptorFetchAllbyExternaldatabasename(
    EnsPTranslationadaptor tla,
    const AjPStr dbname,
    AjPList translations);

AjBool ensTranslationadaptorFetchAllbyExternalname(
    EnsPTranslationadaptor tla,
    const AjPStr name,
    const AjPStr dbname,
    AjBool override,
    AjPList translations);

AjBool ensTranslationadaptorFetchAllbyIdentifiers(
    EnsPTranslationadaptor tla,
    AjPTable translations);

AjBool ensTranslationadaptorFetchAllbyTranscript(
    EnsPTranslationadaptor tla,
    EnsPTranscript transcript);

AjBool ensTranslationadaptorFetchByIdentifier(
    EnsPTranslationadaptor tla,
    ajuint identifier,
    EnsPTranslation *Ptranslation);

AjBool ensTranslationadaptorFetchByStableidentifier(
    EnsPTranslationadaptor tla,
    const AjPStr stableid,
    ajuint version,
    EnsPTranslation *Ptranslation);

AjBool ensTranslationadaptorFetchByTranscript(EnsPTranslationadaptor tla,
                                              EnsPTranscript transcript);

AjBool ensTranslationadaptorFetchAllbyTranscriptsList(
    EnsPTranslationadaptor tla,
    AjPList transcripts);

AjBool ensTranslationadaptorFetchAllbyTranscriptsTable(
    EnsPTranslationadaptor tla,
    AjPTable transcripts);

AjBool ensTranslationadaptorRetrieveAllIdentifiers(
    EnsPTranslationadaptor tla,
    AjPList identifiers);

AjBool ensTranslationadaptorRetrieveAllStableidentifiers(
    EnsPTranslationadaptor tla,
    AjPList stableids);

/*
** End of prototype definitions
*/




AJ_END_DECLS

#endif /* !ENSTRANSLATION_H */