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

freeenergy.h File Reference

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

Go to the source code of this file.

Typedefs

typedef rnamlFREEENERGY rnamlFreeEnergy
 Rnaml structure containing the freeenergy informations.


Functions

rnamlFreeEnergyrnamlnewFreeEnergy ()
 Creates a new rnamlFreeEnergy structure.

rnamlFreeEnergyrnamlcloneFreeEnergy (const rnamlFreeEnergy *freeenergy)
 Clones a rnamlFreeEnergy struture.

void rnamldeleteFreeEnergy (rnamlFreeEnergy *freeenergy)
 Frees the rnamlFreeEnergy structure.

int rnamlisFreeEnergy (const rnamlObject *obj)
 Tells wheter the object is a rnamlFreeEnergy.

int rnamlequalsFreeEnergy (const rnamlFreeEnergy *left, const rnamlFreeEnergy *right)
 Tells if left and right are equals.

float rnamlgetFreeEnergyValue (const rnamlFreeEnergy *freeEnergy)
 Gets the freeEnergy value.

void rnamlsetFreeEnergyValue (rnamlFreeEnergy *freeEnergy, float value)
 Sets the freeEnergy value.

xmlcpgObjectrnamltoXMLFreeEnergy (const rnamlFreeEnergy *freeEnergy)
 Translates the rnamlFreeEnergy structure into a xmlcpgElement conforming to the RNAML standard.


Typedef Documentation

typedef struct rnamlFREEENERGY rnamlFreeEnergy
 

Rnaml structure containing the freeenergy informations.


Function Documentation

rnamlFreeEnergy* rnamlcloneFreeEnergy const rnamlFreeEnergy   freeenergy
 

Clones a rnamlFreeEnergy struture.

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

void rnamldeleteFreeEnergy rnamlFreeEnergy   freeenergy
 

Frees the rnamlFreeEnergy structure.

Parameters:
freeenergy  the rnamlFreeEnergy structure to free.

int rnamlequalsFreeEnergy const rnamlFreeEnergy   left,
const rnamlFreeEnergy   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.

float rnamlgetFreeEnergyValue const rnamlFreeEnergy   freeEnergy
 

Gets the freeEnergy value.

Parameters:
freeEnergy  the rnamlFreeEnergy structure.
Returns:
the freeEnergy value or FLT_MAX if freeEnergy is NULL or not an rnamlFreeEnergy.

int rnamlisFreeEnergy const rnamlObject   obj
 

Tells wheter the object is a rnamlFreeEnergy.

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

rnamlFreeEnergy* rnamlnewFreeEnergy  
 

Creates a new rnamlFreeEnergy structure.

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

void rnamlsetFreeEnergyValue rnamlFreeEnergy   freeEnergy,
float    value
 

Sets the freeEnergy value.

Parameters:
freeEnergy  the rnamlFreeEnergy structure.
value  the freeEnergy value.

xmlcpgObject* rnamltoXMLFreeEnergy const rnamlFreeEnergy   freeEnergy
 

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

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


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