File: mmdb_title.h

package info (click to toggle)
mmdb 2.0.5-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster
  • size: 3,736 kB
  • sloc: cpp: 45,698; sh: 11,463; makefile: 35
file content (696 lines) | stat: -rw-r--r-- 18,487 bytes parent folder | download
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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
//  $Id: mmdb_title.h $
//  =================================================================
//
//   CCP4 Coordinate Library: support of coordinate-related
//   functionality in protein crystallography applications.
//
//   Copyright (C) Eugene Krissinel 2000-2013.
//
//    This library is free software: you can redistribute it and/or
//    modify it under the terms of the GNU Lesser General Public
//    License version 3, modified in accordance with the provisions
//    of the license to address the requirements of UK law.
//
//    You should have received a copy of the modified GNU Lesser
//    General Public License along with this library. If not, copies
//    may be downloaded from http://www.ccp4.ac.uk/ccp4license.php
//
//    This program 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.
//
//  =================================================================
//
//    12.09.13   <--  Date of Last Modification.
//                   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//  -----------------------------------------------------------------
//
//  **** Module  :  MMDB_Title <interface>
//       ~~~~~~~~~
//  **** Project :  MacroMolecular Data Base (MMDB)
//       ~~~~~~~~~
//  **** Classes :  mmdb::TitleContainer  (container of title classes)
//       ~~~~~~~~~  mmdb::ObsLine
//                  mmdb::TitleLine
//                  mmdb::Caveat
//                  mmdb::Compound
//                  mmdb::Source
//                  mmdb::KeyWords
//                  mmdb::ExpData
//                  mmdb::MdlType
//                  mmdb::Author
//                  mmdb::RevData
//                  mmdb::Supersede
//                  mmdb::Journal
//                  mmdb::Remark
//                  mmdb::Biomolecule
//                  mmdb::Title       ( MMDB title section )
//
//   (C) E. Krissinel 2000-2013
//
//  =================================================================
//

#ifndef __MMDB_Title__
#define __MMDB_Title__

#include "mmdb_io_stream.h"
#include "mmdb_defs.h"
#include "mmdb_utils.h"
#include "mmdb_mmcif_.h"

namespace mmdb  {

  //  ======================  TitleContainer  =======================

  DefineClass(TitleContainer);
  DefineStreamFunctions(TitleContainer);

  class TitleContainer : public ClassContainer  {

    public :

      TitleContainer () : ClassContainer() {}
      TitleContainer ( io::RPStream Object )
                        : ClassContainer ( Object ) {}
      ~TitleContainer() {}

      PContainerClass MakeContainerClass ( int ClassID );

  };


  //  ==================  ObsLine  ========================

  DefineClass(ObsLine);
  DefineStreamFunctions(ObsLine);

  class ObsLine : public ContainerClass  {

    public :

      Date   repDate;    //  date of replacement
      IDCode idCode;     //  ID code of replaced entry
      IDCode rIdCode[8]; //  ID codes of entries that replaced this one

      ObsLine ();
      ObsLine ( cpstr S );
      ObsLine ( io::RPStream Object );
      ~ObsLine();

      void       PDBASCIIDump    ( pstr S, int N   );
      void       MakeCIF         ( mmcif::PData CIF, int N );
      ERROR_CODE ConvertPDBASCII ( cpstr S );
      ERROR_CODE GetCIF          ( mmcif::PData CIF, int & n );
      CLASS_ID   GetClassID      () { return ClassID_ObsLine; }

      void  Copy  ( PContainerClass ObsLine );

      void  write ( io::RFile f );
      void  read  ( io::RFile f );

    protected :

      void InitObsLine();

  };


  //  ====================  TitleLine  =====================

  DefineClass(TitleLine);
  DefineStreamFunctions(TitleLine);

  class TitleLine : public ContString  {

    public :

      TitleLine ();
      TitleLine ( cpstr S );
      TitleLine ( io::RPStream Object );
      ~TitleLine();

      ERROR_CODE ConvertPDBASCII ( cpstr S );
      void       PDBASCIIDump    ( pstr S, int N );
      bool       PDBASCIIDump1   ( io::RFile ) { return false; }
      CLASS_ID   GetClassID      () { return ClassID_TitleLine; }

      void  write ( io::RFile f );
      void  read  ( io::RFile f );

    protected :

      void InitTitleLine();

  };


  //  ====================  Caveat  =====================

  DefineClass(Caveat);
  DefineStreamFunctions(Caveat);

  class Caveat : public ContString  {

    public :

      IDCode idCode;   //  ID code of the entry

      Caveat ();
      Caveat ( cpstr S );
      Caveat ( io::RPStream Object );
      ~Caveat();

      void       PDBASCIIDump    ( pstr S, int N );
      bool       PDBASCIIDump1   ( io::RFile ) { return false; }
      void       MakeCIF         ( mmcif::PData CIF, int N );
      ERROR_CODE ConvertPDBASCII ( cpstr S );

//      virtual void  GetCIF1      ( mmcif::PData CIF, ERROR_CODE & Signal,
//                                   int & pos );

      CLASS_ID   GetClassID      () { return ClassID_CAVEAT; }

      void  Copy  ( PContainerClass Caveat );

      void  write ( io::RFile f );
      void  read  ( io::RFile f );

    protected :

      void InitCaveat();

  };


  //  ====================  Compound  =====================

  DefineClass(Compound);
  DefineStreamFunctions(Compound);

  class Compound : public ContString  {

    public :

      Compound ();
      Compound ( cpstr S );
      Compound ( io::RPStream Object );
      ~Compound();

      void       PDBASCIIDump    ( pstr S, int N );
      bool       PDBASCIIDump1   ( io::RFile  ) { return false; }
      ERROR_CODE ConvertPDBASCII ( cpstr S );
      CLASS_ID   GetClassID      () { return ClassID_Compound; }

      void  write ( io::RFile f );
      void  read  ( io::RFile f );

    protected :

      void InitCompound();

  };


  //  ====================  Source  =====================

  DefineClass(Source);
  DefineStreamFunctions(Source);

  class Source : public ContString  {

    public :

      Source ();
      Source ( cpstr S );
      Source ( io::RPStream Object );
      ~Source();

      void       PDBASCIIDump    ( pstr S, int N );
      bool       PDBASCIIDump1   ( io::RFile  ) { return false; }
      ERROR_CODE ConvertPDBASCII ( cpstr S );
      CLASS_ID   GetClassID      () { return ClassID_Source; }

      void  write ( io::RFile f );
      void  read  ( io::RFile f );

    protected :

      void InitSource();

  };


  //  ====================  KeyWords  =====================

  DefineClass(KeyWords);
  DefineStreamFunctions(KeyWords);

  class KeyWords : public io::Stream  {

    public :
      int      nKeyWords;     // number of key words
      psvector KeyWord;       // key word array

      KeyWords ();
      KeyWords ( cpstr S );
      KeyWords ( io::RPStream Object );
      ~KeyWords();

      void  Delete          ();

      void  PDBASCIIDump    ( io::RFile f );
      void  MakeCIF         ( mmcif::PData CIF );

      int   ConvertPDBASCII ( cpstr S );
      void  GetCIF          ( mmcif::PData CIF );

      void  Copy  ( PKeyWords KeyWords );

      void  write ( io::RFile f );
      void  read  ( io::RFile f );

    protected :
      bool Cont;

      void  Init();

  };


  //  ====================  ExpData  =====================

  DefineClass(ExpData);
  DefineStreamFunctions(ExpData);

  class ExpData : public ContString  {

    public :

      ExpData ();
      ExpData ( cpstr S );
      ExpData ( io::RPStream Object );
      ~ExpData();

      void       PDBASCIIDump  ( pstr S, int N );
      bool       PDBASCIIDump1 ( io::RFile ) { return false; }
      ERROR_CODE ConvertPDBASCII ( cpstr S );
      CLASS_ID   GetClassID      () { return ClassID_ExpData; }

      void  write ( io::RFile f );
      void  read  ( io::RFile f );

    protected :

      void InitExpData();

  };


  //  ====================  MdlType  =====================

  DefineClass(MdlType);
  DefineStreamFunctions(MdlType);

  class MdlType : public ContString  {

    public :

      MdlType ();
      MdlType ( cpstr S );
      MdlType ( io::RPStream Object );
      ~MdlType();

      void       PDBASCIIDump  ( pstr S, int N );
      bool       PDBASCIIDump1 ( io::RFile ) { return false; }
      ERROR_CODE ConvertPDBASCII ( cpstr S );
      CLASS_ID   GetClassID      () { return ClassID_MdlType; }

      void  write ( io::RFile f );
      void  read  ( io::RFile f );

    protected :

      void InitMdlType();

  };


  //  ====================  Author  =====================

  DefineClass(Author);
  DefineStreamFunctions(Author);

  class Author : public ContString  {

    public :

      Author ();
      Author ( cpstr S );
      Author ( io::RPStream Object );
      ~Author();

      void       PDBASCIIDump  ( pstr S, int N   );
      bool       PDBASCIIDump1 ( io::RFile ) { return false; }
      ERROR_CODE ConvertPDBASCII ( cpstr S );
      CLASS_ID   GetClassID      () { return ClassID_Author; }

      void  write ( io::RFile f );
      void  read  ( io::RFile f );

    protected :

      void InitAuthor();

  };


  //  ====================  RevData  =====================

  DefineClass(RevData);
  DefineStreamFunctions(RevData);

  enum REVDAT_WARNING  {
    REVDAT_WARN_MODNUM  = 0x00000001,
    REVDAT_WARN_MODTYPE = 0x00000002
  };

  class RevData : public ContainerClass  {

    public :
      int     modNum;
      Date    modDate;
      char    modId[13];
      int     modType;
      RecName record[4];
      word    Warning;

      RevData ();
      RevData ( cpstr S );
      RevData ( io::RPStream Object );
      ~RevData();

      void       PDBASCIIDump    ( pstr S, int N );
      void       MakeCIF         ( mmcif::PData CIF, int N );
      ERROR_CODE ConvertPDBASCII ( cpstr S );
      ERROR_CODE GetCIF          ( mmcif::PData CIF, int & n );
      CLASS_ID   GetClassID      () { return ClassID_RevData; }

      void  Copy  ( PContainerClass RevData );

      void  write ( io::RFile f );
      void  read  ( io::RFile f );

    protected :

      void InitRevData();

  };


  //  ==================  Supersede  ========================

  DefineClass(Supersede);
  DefineStreamFunctions(Supersede);

  class Supersede : public ContainerClass  {

    public :
      Date   sprsdeDate;  //  date of supersede
      IDCode idCode;      //  ID code of the entry
      IDCode sIdCode[8];  //  ID codes of superseded entries

      Supersede ();
      Supersede ( cpstr S );
      Supersede ( io::RPStream Object );
      ~Supersede();

      void       PDBASCIIDump    ( pstr S, int N );
      void       MakeCIF         ( mmcif::PData CIF, int N );
      ERROR_CODE ConvertPDBASCII ( cpstr S );
      ERROR_CODE GetCIF          ( mmcif::PData CIF, int & n );
      CLASS_ID   GetClassID      () { return ClassID_Supersede; }

      void  Copy  ( PContainerClass Supersede );

      void  write ( io::RFile f );
      void  read  ( io::RFile f );

    protected :

      void InitSupersede();

  };


  //  ====================  Journal  =====================

  DefineClass(Journal);
  DefineStreamFunctions(Journal);

  class Journal : public ContString  {

    public :

      Journal ();
      Journal ( cpstr S );
      Journal ( io::RPStream Object );
      ~Journal();

      void       PDBASCIIDump    ( pstr S, int N );
      bool       PDBASCIIDump1   ( io::RFile ) { return false; }
      ERROR_CODE ConvertPDBASCII ( cpstr S );
      CLASS_ID   GetClassID      () { return ClassID_Journal; }

      void  write ( io::RFile f );
      void  read  ( io::RFile f );

    protected :

      void InitJournal();

  };


  //  ====================  Remark  =====================

  DefineClass(Remark);
  DefineStreamFunctions(Remark);

  class Remark : public ContainerClass  {

    public :

      int  remarkNum;  // remark id
      pstr remark;     // remark line

      Remark ();
      Remark ( cpstr S );
      Remark ( io::RPStream Object );
      ~Remark();

      void       PDBASCIIDump    ( pstr S, int N );
      void       MakeCIF         ( mmcif::PData CIF, int N );
      ERROR_CODE ConvertPDBASCII ( cpstr S );
      ERROR_CODE GetCIF          ( mmcif::PData CIF, int & n );
      CLASS_ID   GetClassID      () { return ClassID_Remark; }

      void  Copy  ( PContainerClass RemarkClass );

      void  write ( io::RFile f );
      void  read  ( io::RFile f );

    protected :

      void InitRemark();

  };

  //  =================  Biomolecule  =====================

  DefineClass(BMApply);
  DefineStreamFunctions(BMApply);

  class BMApply : public io::Stream  {

    public :
      PChainID  chain;
      int       nChains;
      pmat44    tm;
      int       nMatrices;

      BMApply ();
      BMApply ( io::RPStream Object );
      ~BMApply();

      void  FreeMemory();

      int   addChains ( int & i, RPRemark rem, RTitleContainer Remark );
      int addMatrices ( int & i, RPRemark rem, RTitleContainer Remark );

      void  Copy  ( PBMApply BMA );  // if BMA is NULL, then empties
                                      // the class
      void  write ( io::RFile f );
      void  read  ( io::RFile f );

    protected :
      void  InitBMApply();

  };


  DefineClass(Biomolecule);
  DefineStreamFunctions(Biomolecule);

  class Biomolecule : public io::Stream  {

    public :
      PPBMApply bmApply;
      int       nBMAs;

      Biomolecule ();
      Biomolecule ( io::RPStream Object );
      ~Biomolecule();

      void  FreeMemory();

      PBMApply addBMApply();

      int   Size();
      bool  checkComposition ( PChainID chID, ivector occ,
                               ivector  wocc, int n );

      void  Copy  ( PBiomolecule B );  // if B is NULL, then empties
                                        // the class
      void  write ( io::RFile f );
      void  read  ( io::RFile f );

    protected :
      void  InitBiomolecule();

  };

  //  =================  Title  =======================

  DefineClass(Title);
  DefineStreamFunctions(Title);

  class Title : public io::Stream  {

    friend class Model;
    friend class Chain;
    friend class Root;

    public :

      Title ();
      Title ( io::RPStream Object );
      ~Title();

      void  FreeMemory ( bool keepBiomolecules );

      // Fills the PDB file header
      void  SetHeader ( cpstr Classification, // any length is Ok
                        cpstr DepDate,    // DD-MMM-YYYY
                        cpstr ID_Code );  // not more than 11 chars

      // Interprets the ASCII PDB line belonging to the title section
      // and fills the corresponding fields.
      //   Returns zero if the line was converted, otherwise returns a
      // non-negative value of Error_XXXX.
      //   PDBString must be not shorter than 81 characters.
      ERROR_CODE ConvertPDBString ( pstr PDBString );

      // MakePDBString() makes the ASCII PDB HEADER line from the
      // class data. PDBString must be not shorter than 81 characters.
      void  MakePDBHeaderString ( pstr PDBString );

      // GetStructureTitle() returns the contents of TITLE record
      // unfolded into single line. If Title is missing, returns
      // contents of COMPND(:MOLECULE). If COMPND is missing, returns
      // HEADER. If Header is missing, returns PDB code. If no PDB
      // code is there, returns "Not available".
      pstr  GetStructureTitle ( pstr & S );

      PTitleContainer GetObsData () { return &obsData;  }
      PTitleContainer GetCaveat  () { return &caveat;   }
      PTitleContainer GetCompound() { return &compound; }
      PTitleContainer GetSource  () { return &source;   }
      PKeyWords       GetKeyWords() { return &keyWords; }
      PTitleContainer GetExpData () { return &expData;  }
      PTitleContainer GetMdlType () { return &mdlType;  }
      PTitleContainer GetRemarks () { return &remark;   }
      PTitleContainer GetJournal () { return &journal;  }

      realtype GetResolution(); // -1.0 mean no resolution record in file

      int   ParseBiomolecules(); // returns the number of biomolecules,
                                 // -2 for general format error
                                 // -3 for errors in BIOMT records

      int   GetNofBiomolecules();
      void  GetBiomolecules   ( PPBiomolecule & BM, int & nBMs );
      PBiomolecule GetBiomolecule ( int bmNo ); // bmno=0,1,..
                                 // returns NULL if bmNo is incorrect

      void  PDBASCIIDump ( io::RFile      f   );
      void  MakeCIF      ( mmcif::PData CIF );

      //   GetCIF(..) returns the same code as ConvertPDBString(..)
      // save for Error_WrongSection
      ERROR_CODE  GetCIF ( mmcif::PData CIF );

      inline pstr  GetIDCode() { return idCode; }
      inline bool  GetCol73 () { return col73;  }
      void  TrimInput ( pstr PDBString );

      void  Copy  ( PTitle TS );  // if TS is NULL, then empties
                                       // the class

      void  write ( io::RFile f );    // writes header to PDB binary file
      void  read  ( io::RFile f );    // reads header from PDB binary file

    protected :

      //   Header data
      pstr     classification;  // classification of the molecule
      Date     depDate;         // deposition date DD-MMM-YYYY
      IDCode   idCode;          // unique PDB identifier
      realtype resolution;      // resolution
      bool     col73;           // True if columns 73-80 contain PDB ID

      TitleContainer obsData;     // obsoletion data
      TitleContainer title;       // title data
      TitleContainer caveat;      // error data
      TitleContainer compound;    // compound data
      TitleContainer source;      // source
      KeyWords       keyWords;    // key words
      TitleContainer expData;     // experimental data
      TitleContainer mdlType;     // model descriptions
      TitleContainer author;      // author data
      TitleContainer revData;     // revision data
      TitleContainer supersede;   // supersede records
      TitleContainer journal;     // journal records
      TitleContainer remark;      // remark records

      PPBiomolecule  biomolecule;
      int            nBiomolecules;

      void  Init();
      void  FreeBiomolecules();

      PBiomolecule addBiomolecule();

  };

  extern void  TestHeader();
  extern void  TestTitle (); // reads PDB title from file 'in.title'
                             // and rewrites it into 'out.title' and
                             // 'abin.title'

}  // namespace mmdb


#endif