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

basepairid.h File Reference

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

Go to the source code of this file.

Typedefs

typedef rnamlBASEPAIRID rnamlBasePairId
 Rnaml structure containing the basepairid informations.


Functions

rnamlBasePairIdrnamlnewBasePairId ()
 Creates a new rnamlBasePairId structure.

rnamlBasePairIdrnamlcloneBasePairId (const rnamlBasePairId *basepairid)
 Clones a rnamlBasePairId struture.

void rnamldeleteBasePairId (rnamlBasePairId *basepairid)
 Frees the rnamlBasePairId structure.

int rnamlisBasePairId (const rnamlObject *obj)
 Tells wheter the object is a rnamlBasePairId.

int rnamlequalsBasePairId (const rnamlBasePairId *left, const rnamlBasePairId *right)
 Tells if left and right are equals.

const char * rnamlgetBasePairIdRef (const rnamlBasePairId *basePairId)
 Gets the basePairId ref.

void rnamlsetBasePairIdRef (rnamlBasePairId *basePairId, const char *ref)
 Sets the basePairId ref.

xmlcpgObjectrnamltoXMLBasePairId (const rnamlBasePairId *basePairId)
 Translates the rnamlBasePairId structure into a xmlcpgElement conforming to the RNAML standard.


Typedef Documentation

typedef struct rnamlBASEPAIRID rnamlBasePairId
 

Rnaml structure containing the basepairid informations.


Function Documentation

rnamlBasePairId* rnamlcloneBasePairId const rnamlBasePairId   basepairid
 

Clones a rnamlBasePairId struture.

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

void rnamldeleteBasePairId rnamlBasePairId   basepairid
 

Frees the rnamlBasePairId structure.

Parameters:
basepairid  the rnamlBasePairId structure to free.

int rnamlequalsBasePairId const rnamlBasePairId   left,
const rnamlBasePairId   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* rnamlgetBasePairIdRef const rnamlBasePairId   basePairId
 

Gets the basePairId ref.

Parameters:
basePairId  the rnamlBasePairId structure.
Returns:
the basePairId ref string or NULL if basePairId is NULL or not an rnamlBasePairId.

int rnamlisBasePairId const rnamlObject   obj
 

Tells wheter the object is a rnamlBasePairId.

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

rnamlBasePairId* rnamlnewBasePairId  
 

Creates a new rnamlBasePairId structure.

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

void rnamlsetBasePairIdRef rnamlBasePairId   basePairId,
const char *    ref
 

Sets the basePairId ref.

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

Parameters:
basePairId  the rnamlBasePairId structure.
ref  the basePairId ref.

xmlcpgObject* rnamltoXMLBasePairId const rnamlBasePairId   basePairId
 

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

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


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