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

distanceconstraint.h File Reference

#include "baseid.h"
#include "object.h"
#include "xmlcpg.h"

Go to the source code of this file.

Typedefs

typedef rnamlDISTANCECONSTRAINT rnamlDistanceConstraint
 Rnaml structure containing the distanceconstraint informations.


Functions

rnamlDistanceConstraintrnamlnewDistanceConstraint ()
 Creates a new rnamlDistanceConstraint structure.

rnamlDistanceConstraintrnamlcloneDistanceConstraint (const rnamlDistanceConstraint *distanceconstraint)
 Clones a rnamlDistanceConstraint struture.

void rnamldeleteDistanceConstraint (rnamlDistanceConstraint *distanceconstraint)
 Frees the rnamlDistanceConstraint structure.

int rnamlisDistanceConstraint (const rnamlObject *obj)
 Tells wheter the object is a rnamlDistanceConstraint.

int rnamlequalsDistanceConstraint (const rnamlDistanceConstraint *left, const rnamlDistanceConstraint *right)
 Tells if left and right are equals.

rnamlBaseIdrnamlgetDistanceConstraintBaseId1 (rnamlDistanceConstraint *distanceConstraint)
 Gets the baseId1 from the distanceConstraint.

void rnamlsetDistanceConstraintBaseId1 (rnamlDistanceConstraint *distanceConstraint, rnamlBaseId *baseId1)
 Sets the distanceConstraint baseId1.

const char * rnamlgetDistanceConstraintAtomType1 (const rnamlDistanceConstraint *distanceConstraint)
 Gets the atomType1 from the distanceConstraint.

void rnamlsetDistanceConstraintAtomType1 (rnamlDistanceConstraint *distanceConstraint, const char *atomType1)
 Sets the distanceConstraint atomType1.

rnamlBaseIdrnamlgetDistanceConstraintBaseId2 (rnamlDistanceConstraint *distanceConstraint)
 Gets the baseId2 from the distanceConstraint.

void rnamlsetDistanceConstraintBaseId2 (rnamlDistanceConstraint *distanceConstraint, rnamlBaseId *baseId2)
 Sets the distanceConstraint baseId2.

const char * rnamlgetDistanceConstraintAtomType2 (const rnamlDistanceConstraint *distanceConstraint)
 Gets the atomType2 from the distanceConstraint.

void rnamlsetDistanceConstraintAtomType2 (rnamlDistanceConstraint *distanceConstraint, const char *atomType2)
 Sets the distanceConstraint atomType2.

float rnamlgetDistanceConstraintMean (const rnamlDistanceConstraint *distanceConstraint)
 Gets the mean from the distanceConstraint.

void rnamlsetDistanceConstraintMean (rnamlDistanceConstraint *distanceConstraint, float mean)
 Sets the distanceConstraint mean.

float rnamlgetDistanceConstraintRange (const rnamlDistanceConstraint *distanceConstraint)
 Gets the range from the distanceConstraint.

void rnamlsetDistanceConstraintRange (rnamlDistanceConstraint *distanceConstraint, float range)
 Sets the distanceConstraint range.

float rnamlgetDistanceConstraintWeight (const rnamlDistanceConstraint *distanceConstraint)
 Gets the weight from the distanceConstraint.

void rnamlsetDistanceConstraintWeight (rnamlDistanceConstraint *distanceConstraint, float weight)
 Sets the distanceConstraint weight.

xmlcpgObjectrnamltoXMLDistanceConstraint (const rnamlDistanceConstraint *distanceConstraint)
 Translates the rnamlDistanceConstraint structure into a xmlcpgElement conforming to the RNAML standard.


Typedef Documentation

typedef struct rnamlDISTANCECONSTRAINT rnamlDistanceConstraint
 

Rnaml structure containing the distanceconstraint informations.


Function Documentation

rnamlDistanceConstraint* rnamlcloneDistanceConstraint const rnamlDistanceConstraint   distanceconstraint
 

Clones a rnamlDistanceConstraint struture.

Parameters:
distanceconstraint  the structure to clone.
Returns:
the new allocated structure or NULL if something goes wrong.

void rnamldeleteDistanceConstraint rnamlDistanceConstraint   distanceconstraint
 

Frees the rnamlDistanceConstraint structure.

Parameters:
distanceconstraint  the rnamlDistanceConstraint structure to free.

int rnamlequalsDistanceConstraint const rnamlDistanceConstraint   left,
const rnamlDistanceConstraint   right
 

Tells if left and right are equals.

Parameters:
left  the left object to compare.
right  the right object to compare.
Returns:
1 if the objects are equals or 0 otherwise.

const char* rnamlgetDistanceConstraintAtomType1 const rnamlDistanceConstraint   distanceConstraint
 

Gets the atomType1 from the distanceConstraint.

Parameters:
distanceConstraint  the rnamlDistanceConstraint structure.
Returns:
the distanceConstraint atomType1 string or NULL if distanceConstraint is NULL or not an rnamlDistanceConstraint.

const char* rnamlgetDistanceConstraintAtomType2 const rnamlDistanceConstraint   distanceConstraint
 

Gets the atomType2 from the distanceConstraint.

Parameters:
distanceConstraint  the rnamlDistanceConstraint structure.
Returns:
the distanceConstraint atomType2 string or NULL if distanceConstraint is NULL or not an rnamlDistanceConstraint.

rnamlBaseId* rnamlgetDistanceConstraintBaseId1 rnamlDistanceConstraint   distanceConstraint
 

Gets the baseId1 from the distanceConstraint.

Parameters:
distanceConstraint  the rnamlDistanceConstraint structure.
Returns:
the distanceConstraint baseId is NULL or if distanceConstraint is NULL or not an rnamlDistanceConstraint.

rnamlBaseId* rnamlgetDistanceConstraintBaseId2 rnamlDistanceConstraint   distanceConstraint
 

Gets the baseId2 from the distanceConstraint.

Parameters:
distanceConstraint  the rnamlDistanceConstraint structure.
Returns:
the distanceConstraint baseId2 is NULL or if distanceConstraint is NULL or not an rnamlDistanceConstraint.

float rnamlgetDistanceConstraintMean const rnamlDistanceConstraint   distanceConstraint
 

Gets the mean from the distanceConstraint.

Parameters:
distanceConstraint  the rnamlDistanceConstraint structure.
Returns:
the mean or 0 if distanceConstraint is NULL or not an rnamlDistanceConstraint.

float rnamlgetDistanceConstraintRange const rnamlDistanceConstraint   distanceConstraint
 

Gets the range from the distanceConstraint.

Parameters:
distanceConstraint  the rnamlDistanceConstraint structure.
Returns:
the range or 0 if distanceConstraint is NULL or not an rnamlDistanceConstraint.

float rnamlgetDistanceConstraintWeight const rnamlDistanceConstraint   distanceConstraint
 

Gets the weight from the distanceConstraint.

Parameters:
distanceConstraint  the rnamlDistanceConstraint structure.
Returns:
the weight or 0 if distanceConstraint is NULL or not an rnamlDistanceConstraint.

int rnamlisDistanceConstraint const rnamlObject   obj
 

Tells wheter the object is a rnamlDistanceConstraint.

Parameters:
obj  the rnamlObject to test.
Returns:
1 if the object is a rnamlDistanceConstraint, 0 otherwise.

rnamlDistanceConstraint* rnamlnewDistanceConstraint  
 

Creates a new rnamlDistanceConstraint structure.

Returns:
the new allocated structure or NULL if something goes wrong.

void rnamlsetDistanceConstraintAtomType1 rnamlDistanceConstraint   distanceConstraint,
const char *    atomType1
 

Sets the distanceConstraint atomType1.

The previous distanceConstraint atomType is freed and a copy of atomType1 is generated.

Parameters:
distanceConstraint  the rnamlDistanceConstraint structure.
atomType1  the distanceConstraint atomType1.

void rnamlsetDistanceConstraintAtomType2 rnamlDistanceConstraint   distanceConstraint,
const char *    atomType2
 

Sets the distanceConstraint atomType2.

The previous distanceConstraint atomType is freed and a copy of atomType2 is generated.

Parameters:
distanceConstraint  the rnamlDistanceConstraint structure.
atomType2  the distanceConstraint atomType2.

void rnamlsetDistanceConstraintBaseId1 rnamlDistanceConstraint   distanceConstraint,
rnamlBaseId   baseId1
 

Sets the distanceConstraint baseId1.

The previous baseId info is freed

Parameters:
distanceConstraint  the rnamlDistanceConstraint structure.
distanceConstraint  the distanceConstraint baseId1.

void rnamlsetDistanceConstraintBaseId2 rnamlDistanceConstraint   distanceConstraint,
rnamlBaseId   baseId2
 

Sets the distanceConstraint baseId2.

The previous baseId info is freed

Parameters:
distanceConstraint  the rnamlDistanceConstraint structure.
distanceConstraint  the distanceConstraint baseId2.

void rnamlsetDistanceConstraintMean rnamlDistanceConstraint   distanceConstraint,
float    mean
 

Sets the distanceConstraint mean.

The previous distanceConstraint mean is freed and a copy of mean is generated.

Parameters:
distanceConstraint  the rnamlDistanceConstraint structure.
mean  the distanceConstraint mean.

void rnamlsetDistanceConstraintRange rnamlDistanceConstraint   distanceConstraint,
float    range
 

Sets the distanceConstraint range.

The previous distanceConstraint range is freed and a copy of range is generated.

Parameters:
distanceConstraint  the rnamlDistanceConstraint structure.
range  the distanceConstraint range.

void rnamlsetDistanceConstraintWeight rnamlDistanceConstraint   distanceConstraint,
float    weight
 

Sets the distanceConstraint weight.

The previous distanceConstraint weight is freed and a copy of weight is generated.

Parameters:
distanceConstraint  the rnamlDistanceConstraint structure.
weight  the distanceConstraint weight.

xmlcpgObject* rnamltoXMLDistanceConstraint const rnamlDistanceConstraint   distanceConstraint
 

Translates the rnamlDistanceConstraint structure into a xmlcpgElement conforming to the RNAML standard.

Parameters:
molecule  the rnamlDistanceConstraint structure to translate.
Returns:
the xmlcpgObject or NULL if something goes wrong.


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