Main Page   Namespace List   Class Hierarchy   Compound List   File List   Compound Members   File Members   Related Pages  

DistanceConstraint.h

Go to the documentation of this file.
00001 /*                               -*- Mode: C++ -*- 
00002  * DistanceConstraint.h
00003  * Copyright © 2003 Laboratoire de Biologie Informatique et Théorique
00004  *                  Université de Montréal.
00005  * Author           : Patrick Charbonneau
00006  * Created On       : Wed Sep 12 16:48:15 2003
00007  * $Revision: 1.2 $
00008  * $Id: DistanceConstraint.h,v 1.2 2003/10/18 00:21:39 larosem Exp $
00009  *
00010  * This file is part of xmlcpg.
00011  *
00012  * xmlcpg is free software; you can redistribute it and/or modify it under
00013  * the terms of the GNU Lesser General Public License as published by the Free
00014  * Software Foundation; either version 2 of the License, or (at your option)
00015  * any later version.
00016  *
00017  * xmlcpg is distributed in the hope that it will be useful, but WITHOUT ANY
00018  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00019  * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for
00020  * more details.
00021  *
00022  * You should have received a copy of the GNU Lesser General Public License
00023  * along with xmlcpg; if not, write to the Free Software Foundation, Inc.,
00024  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
00025  */
00026 
00027 
00028 
00029 #ifndef _rnaml_DistanceConstraint_h_
00030 #define _rnaml_DistanceConstraint_h_
00031 
00032 extern "C" {
00033 #include "distanceconstraint.h"
00034 #include "object.h"
00035 }
00036 
00037 #include "Object.h"
00038 
00039 
00040 
00041 namespace rnaml
00042 {
00043   class BaseId;
00044 
00045 
00046 
00047   class DistanceConstraint : public Object
00048   {
00049     
00050   public:
00051 
00052     // LIFECYCLE ------------------------------------------------------------
00053 
00057     DistanceConstraint () : Object ((rnamlObject*) rnamlnewDistanceConstraint ()) { }
00058 
00063     DistanceConstraint (const DistanceConstraint &right) : Object (right) { }
00064 
00069     DistanceConstraint* clone () const { return new DistanceConstraint (*this); }
00070 
00074     virtual ~DistanceConstraint () { }
00075 
00076     // OPERATORS ------------------------------------------------------------
00077 
00083     DistanceConstraint& operator= (const DistanceConstraint &right);
00084 
00085     // ACCESS ---------------------------------------------------------------
00086 
00091     BaseId* getBaseId1 () const;
00092 
00097     void setBaseId1 (BaseId *baseId1);
00098 
00103     const char* getAtomType1 () const { return rnamlgetDistanceConstraintAtomType1 ((const rnamlDistanceConstraint*) getCStructure ()); }
00104 
00109     void setAtomType1 (const char *atomType1) { rnamlsetDistanceConstraintAtomType1 ((rnamlDistanceConstraint*) getCStructure (), atomType1); }
00110 
00115     BaseId* getBaseId2 () const;
00116 
00121     void setBaseId2 (BaseId *baseId2);
00122 
00127     const char* getAtomType2 () const { return rnamlgetDistanceConstraintAtomType2 ((const rnamlDistanceConstraint*) getCStructure ()); }
00128 
00133     void setAtomType2 (const char *atomType2) { rnamlsetDistanceConstraintAtomType2 ((rnamlDistanceConstraint*) getCStructure (), atomType2); }
00134 
00139     float getMean () const { return rnamlgetDistanceConstraintMean ((const rnamlDistanceConstraint*) getCStructure ()); }
00140 
00145     void setMean (float mean) { rnamlsetDistanceConstraintMean ((rnamlDistanceConstraint*) getCStructure (), mean); }
00146 
00151     float getRange () const { return rnamlgetDistanceConstraintRange ((const rnamlDistanceConstraint*) getCStructure ()); }
00152 
00157     void setRange (float range) { rnamlsetDistanceConstraintRange ((rnamlDistanceConstraint*) getCStructure (), range); }
00158 
00163     float getWeight () const { return rnamlgetDistanceConstraintWeight ((const rnamlDistanceConstraint*) getCStructure ()); }
00164 
00169     void setWeight (float weight) { rnamlsetDistanceConstraintWeight ((rnamlDistanceConstraint*) getCStructure (), weight); }
00170 
00171     // METHODS --------------------------------------------------------------
00172 
00173     // I/O  -----------------------------------------------------------------
00174 
00175   };
00176 }
00177 
00178 #endif

Generated on Tue Nov 11 14:59:39 2003 for xmlcpg by doxygen1.2.18