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

surfaceconstraint.h File Reference

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

Go to the source code of this file.

Typedefs

typedef rnamlSURFACECONSTRAINT rnamlSurfaceConstraint
 Rnaml structure containing the surfaceconstraint informations.


Functions

rnamlSurfaceConstraintrnamlnewSurfaceConstraint ()
 Creates a new rnamlSurfaceConstraint structure.

rnamlSurfaceConstraintrnamlcloneSurfaceConstraint (const rnamlSurfaceConstraint *surfaceconstraint)
 Clones a rnamlSurfaceConstraint struture.

void rnamldeleteSurfaceConstraint (rnamlSurfaceConstraint *surfaceconstraint)
 Frees the rnamlSurfaceConstraint structure.

int rnamlisSurfaceConstraint (const rnamlObject *obj)
 Tells wheter the object is a rnamlSurfaceConstraint.

int rnamlequalsSurfaceConstraint (const rnamlSurfaceConstraint *left, const rnamlSurfaceConstraint *right)
 Tells if left and right are equals.

rnamlBaseIdrnamlgetSurfaceConstraintBaseId (rnamlSurfaceConstraint *surfaceConstraint)
 Gets the baseId from the surfaceConstraint.

void rnamlsetSurfaceConstraintBaseId (rnamlSurfaceConstraint *surfaceConstraint, rnamlBaseId *baseId)
 Sets the surfaceConstraint baseId.

const char * rnamlgetSurfaceConstraintAtomType (const rnamlSurfaceConstraint *surfaceConstraint)
 Gets the atomType from the surfaceConstraint.

void rnamlsetSurfaceConstraintAtomType (rnamlSurfaceConstraint *surfaceConstraint, const char *atomType)
 Sets the surfaceConstraint atomType.

float rnamlgetSurfaceConstraintSurfaceValue (const rnamlSurfaceConstraint *surfaceConstraint)
 Gets the surfaceValue from the surfaceConstraint.

void rnamlsetSurfaceConstraintSurfaceValue (rnamlSurfaceConstraint *surfaceConstraint, float surfaceValue)
 Sets the surfaceConstraint surfaceValue.

xmlcpgObjectrnamltoXMLSurfaceConstraint (const rnamlSurfaceConstraint *surfaceConstraint)
 Translates the rnamlSurfaceConstraint structure into a xmlcpgElement conforming to the RNAML standard.


Typedef Documentation

typedef struct rnamlSURFACECONSTRAINT rnamlSurfaceConstraint
 

Rnaml structure containing the surfaceconstraint informations.


Function Documentation

rnamlSurfaceConstraint* rnamlcloneSurfaceConstraint const rnamlSurfaceConstraint   surfaceconstraint
 

Clones a rnamlSurfaceConstraint struture.

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

void rnamldeleteSurfaceConstraint rnamlSurfaceConstraint   surfaceconstraint
 

Frees the rnamlSurfaceConstraint structure.

Parameters:
surfaceconstraint  the rnamlSurfaceConstraint structure to free.

int rnamlequalsSurfaceConstraint const rnamlSurfaceConstraint   left,
const rnamlSurfaceConstraint   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* rnamlgetSurfaceConstraintAtomType const rnamlSurfaceConstraint   surfaceConstraint
 

Gets the atomType from the surfaceConstraint.

Parameters:
surfaceConstraint  the rnamlSurfaceConstraint structure.
Returns:
the surfaceConstraint atomType string or NULL if surfaceConstraint is NULL or not an rnamlSurfaceConstraint.

rnamlBaseId* rnamlgetSurfaceConstraintBaseId rnamlSurfaceConstraint   surfaceConstraint
 

Gets the baseId from the surfaceConstraint.

Parameters:
surfaceConstraint  the rnamlSurfaceConstraint structure.
Returns:
the surfaceConstraint baseId is NULL or if surfaceConstraint is NULL or not an rnamlSurfaceConstraint.

float rnamlgetSurfaceConstraintSurfaceValue const rnamlSurfaceConstraint   surfaceConstraint
 

Gets the surfaceValue from the surfaceConstraint.

Parameters:
surfaceConstraint  the rnamlSurfaceConstraint structure.
Returns:
the surfaceValue or 0 if surfaceConstraint is NULL or not an rnamlSurfaceConstraint.

int rnamlisSurfaceConstraint const rnamlObject   obj
 

Tells wheter the object is a rnamlSurfaceConstraint.

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

rnamlSurfaceConstraint* rnamlnewSurfaceConstraint  
 

Creates a new rnamlSurfaceConstraint structure.

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

void rnamlsetSurfaceConstraintAtomType rnamlSurfaceConstraint   surfaceConstraint,
const char *    atomType
 

Sets the surfaceConstraint atomType.

The previous surfaceConstraint atomType is freed and a copy of atomType is generated.

Parameters:
surfaceConstraint  the rnamlSurfaceConstraint structure.
atomType  the surfaceConstraint atomType.

void rnamlsetSurfaceConstraintBaseId rnamlSurfaceConstraint   surfaceConstraint,
rnamlBaseId   baseId
 

Sets the surfaceConstraint baseId.

The previous baseId info is freed

Parameters:
surfaceConstraint  the rnamlSurfaceConstraint structure.
surfaceConstraint  the surfaceConstraint baseId.

void rnamlsetSurfaceConstraintSurfaceValue rnamlSurfaceConstraint   surfaceConstraint,
float    surfaceValue
 

Sets the surfaceConstraint surfaceValue.

The previous surfaceConstraint surfaceValue is freed and a copy of surfaceValue is generated.

Parameters:
surfaceConstraint  the rnamlSurfaceConstraint structure.
surfaceValue  the surfaceConstraint surfaceValue.

xmlcpgObject* rnamltoXMLSurfaceConstraint const rnamlSurfaceConstraint   surfaceConstraint
 

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

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


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