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

volume.h File Reference

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

Go to the source code of this file.

Typedefs

typedef rnamlVOLUME rnamlVolume
 Rnaml structure containing the volume informations.


Functions

rnamlVolumernamlnewVolume ()
 Creates a new rnamlVolume structure.

rnamlVolumernamlcloneVolume (const rnamlVolume *volume)
 Clones a rnamlVolume struture.

void rnamldeleteVolume (rnamlVolume *volume)
 Frees the rnamlVolume structure.

int rnamlisVolume (const rnamlObject *obj)
 Tells wheter the object is a rnamlVolume.

int rnamlequalsVolume (const rnamlVolume *left, const rnamlVolume *right)
 Tells if left and right are equals.

int rnamlgetVolumeValue (const rnamlVolume *volume)
 Gets the volume value.

void rnamlsetVolumeValue (rnamlVolume *volume, int value)
 Sets the volume value.

xmlcpgObjectrnamltoXMLVolume (const rnamlVolume *volume)
 Translates the rnamlVolume structure into a xmlcpgElement conforming to the RNAML standard.


Typedef Documentation

typedef struct rnamlVOLUME rnamlVolume
 

Rnaml structure containing the volume informations.


Function Documentation

rnamlVolume* rnamlcloneVolume const rnamlVolume   volume
 

Clones a rnamlVolume struture.

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

void rnamldeleteVolume rnamlVolume   volume
 

Frees the rnamlVolume structure.

Parameters:
volume  the rnamlVolume structure to free.

int rnamlequalsVolume const rnamlVolume   left,
const rnamlVolume   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.

int rnamlgetVolumeValue const rnamlVolume   volume
 

Gets the volume value.

Parameters:
volume  the rnamlVolume structure.
Returns:
the volume value or -1 if volume is NULL or not an rnamlVolume.

int rnamlisVolume const rnamlObject   obj
 

Tells wheter the object is a rnamlVolume.

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

rnamlVolume* rnamlnewVolume  
 

Creates a new rnamlVolume structure.

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

void rnamlsetVolumeValue rnamlVolume   volume,
int    value
 

Sets the volume value.

Parameters:
volume  the rnamlVolume structure.
value  the volume value.

xmlcpgObject* rnamltoXMLVolume const rnamlVolume   volume
 

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

Parameters:
molecule  the rnamlVolume 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