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

moleculeid.h File Reference

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

Go to the source code of this file.

Typedefs

typedef rnamlMOLECULEID rnamlMoleculeId
 Rnaml structure containing the moleculeid informations.


Functions

rnamlMoleculeIdrnamlnewMoleculeId ()
 Creates a new rnamlMoleculeId structure.

rnamlMoleculeIdrnamlcloneMoleculeId (const rnamlMoleculeId *moleculeid)
 Clones a rnamlMoleculeId struture.

void rnamldeleteMoleculeId (rnamlMoleculeId *moleculeid)
 Frees the rnamlMoleculeId structure.

int rnamlisMoleculeId (const rnamlObject *obj)
 Tells wheter the object is a rnamlMoleculeId.

int rnamlequalsMoleculeId (const rnamlMoleculeId *left, const rnamlMoleculeId *right)
 Tells if left and right are equals.

const char * rnamlgetMoleculeIdRef (const rnamlMoleculeId *moleculeId)
 Gets the moleculeId ref.

void rnamlsetMoleculeIdRef (rnamlMoleculeId *moleculeId, const char *ref)
 Sets the moleculeId ref.

xmlcpgObjectrnamltoXMLMoleculeId (const rnamlMoleculeId *moleculeId)
 Translates the rnamlMoleculeId structure into a xmlcpgElement conforming to the RNAML standard.


Typedef Documentation

typedef struct rnamlMOLECULEID rnamlMoleculeId
 

Rnaml structure containing the moleculeid informations.


Function Documentation

rnamlMoleculeId* rnamlcloneMoleculeId const rnamlMoleculeId   moleculeid
 

Clones a rnamlMoleculeId struture.

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

void rnamldeleteMoleculeId rnamlMoleculeId   moleculeid
 

Frees the rnamlMoleculeId structure.

Parameters:
moleculeid  the rnamlMoleculeId structure to free.

int rnamlequalsMoleculeId const rnamlMoleculeId   left,
const rnamlMoleculeId   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* rnamlgetMoleculeIdRef const rnamlMoleculeId   moleculeId
 

Gets the moleculeId ref.

Parameters:
moleculeId  the rnamlMoleculeId structure.
Returns:
the moleculeId ref string or NULL if moleculeId is NULL or not an rnamlMoleculeId.

int rnamlisMoleculeId const rnamlObject   obj
 

Tells wheter the object is a rnamlMoleculeId.

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

rnamlMoleculeId* rnamlnewMoleculeId  
 

Creates a new rnamlMoleculeId structure.

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

void rnamlsetMoleculeIdRef rnamlMoleculeId   moleculeId,
const char *    ref
 

Sets the moleculeId ref.

The previous moleculeId ref is freed and a copy of ref is generated.

Parameters:
moleculeId  the rnamlMoleculeId structure.
ref  the moleculeId ref.

xmlcpgObject* rnamltoXMLMoleculeId const rnamlMoleculeId   moleculeId
 

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

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


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