BioPdbHelix.h

Go to the documentation of this file.

/****************************************************************************
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
The BioBhasha : The Biologist's Programming Language
Version 1.0 (19th December 2001)
Prasad, B.V.L.S.
Contact: burrashiva@yahoo.com
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
*****************************************************************************/

#ifndef BIOPDBHELIX_H
#define BIOPDBHELIX_H

#include <string>
#include <vector>
#include <fstream>
#include "BioProteinChain.h"
#include "BioMatrix.h"

class BioPdbHelix
{
        // Caution: Insertion Code is not included ....hence this is not 
        // exactly following the PDB helix format...
        // I will add them in future releases. Bear with me Untill then.

        int helixSerialNumber_;
        string helixId_;
        string initialResidueName_;
        int initialResidueNumber_;

        char initialChainId_;
        char endingChainId_;

        string endingResidueName_;
        int endingResidueNumber_;

        int helixClass_;
        int lengthOfHelix_;

        string comment_;
        string FILE;

           friend bool operator >(const BioPdbHelix& , const BioPdbHelix&);
              friend bool operator <(const BioPdbHelix& , const BioPdbHelix&);
                 friend bool operator ==(const BioPdbHelix& , const BioPdbHelix&);

        
public:
        BioPdbHelix(){}
        BioPdbHelix(const string& ti_);
        BioPdbHelix(int hs,string hid,string irna,  char ic, int irnu,
                     string erna, char ec, int ernu, int hcl, string com, int lh, string f);

        int getHelixSerialNumber() ;
        string getHelixId() ;
        string getInitialResidueName() ;
        int getInitialResidueNumber();

        char getInitialChainId() ;
        char getEndingChainId() ;

        string getEndingResidueName() ;
        int getEndingResidueNumber() ;

        int getHelixClass() ;
        int getHelixLength() ;

        string getComment() ;

        BioProteinChain getHelixCoordinates();
        BioProteinChain getHelixCoordinates(BioProteinChain&  );

        void showHelixCoordinates(ostream&  = cout);
        void showHelixCoordinates(BioProteinChain& ,ostream&  = cout);

        string getHelixSequence();
        string getHelixSequence(BioProteinChain&  );
        
        void showHelixDirectionCosines(ostream& = cout);
        void showHelixDirectionCosines(BioProteinChain&, ostream& = cout);

        BioMatrix getHelixDirectionCosines(BioProteinChain&);
        BioMatrix getHelixDirectionCosines();
};

#endif