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

helix.c File Reference

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "helix.h"

Compounds

struct  rnamlHELIX

Functions

rnamlHelixrnamlnewHelix ()
 Creates a new rnamlHelix structure.

rnamlHelixrnamlcloneHelix (const rnamlHelix *helix)
 Clones a rnamlHelix struture.

void rnamldeleteHelix (rnamlHelix *helix)
 Frees the rnamlHelix structure.

int rnamlisHelix (const rnamlObject *obj)
 Tells wheter the object is a rnamlHelix.

int rnamlequalsHelix (const rnamlHelix *left, const rnamlHelix *right)
 Tells if left and right are equals.

const char * rnamlgetHelixId (const rnamlHelix *helix)
 Gets the helix id.

void rnamlsetHelixId (rnamlHelix *helix, const char *id)
 Sets the helix id.

rnamlBaseId5prnamlgetHelixBaseId5p (rnamlHelix *helix)
 Gets the baseId5p from the helix.

void rnamlsetHelixBaseId5p (rnamlHelix *helix, rnamlBaseId5p *baseId5p)
 Sets the helix baseId5p.

rnamlBaseId3prnamlgetHelixBaseId3p (rnamlHelix *helix)
 Gets the baseId3p from the helix.

void rnamlsetHelixBaseId3p (rnamlHelix *helix, rnamlBaseId3p *baseId3p)
 Sets the helix baseId3p.

rnamlLengthrnamlgetHelixLength (const rnamlHelix *helix)
 Gets the helix length.

void rnamlsetHelixLength (rnamlHelix *helix, rnamlLength *length)
 Sets the helix length.

xmlcpgObjectrnamltoXMLHelix (const rnamlHelix *helix)
 Translates the rnamlHelix structure into a xmlcpgElement conforming to the RNAML standard.


Function Documentation

rnamlHelix* rnamlcloneHelix const rnamlHelix   helix
 

Clones a rnamlHelix struture.

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

void rnamldeleteHelix rnamlHelix   helix
 

Frees the rnamlHelix structure.

Parameters:
helix  the rnamlHelix structure to free.

int rnamlequalsHelix const rnamlHelix   left,
const rnamlHelix   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.

rnamlBaseId3p* rnamlgetHelixBaseId3p rnamlHelix   helix
 

Gets the baseId3p from the helix.

Parameters:
helix  the rnamlHelix structure.
Returns:
the helix baseId3p is NULL or if helix is NULL or not an rnamlHelix.

rnamlBaseId5p* rnamlgetHelixBaseId5p rnamlHelix   helix
 

Gets the baseId5p from the helix.

Parameters:
helix  the rnamlHelix structure.
Returns:
the helix baseId5p is NULL or if helix is NULL or not an rnamlHelix.

const char* rnamlgetHelixId const rnamlHelix   helix
 

Gets the helix id.

Parameters:
helix  the rnamlHelix structure.
Returns:
the helix id string or NULL if helix is NULL or not an rnamlHelix.

rnamlLength* rnamlgetHelixLength const rnamlHelix   helix
 

Gets the helix length.

Parameters:
helix  the rnamlHelix structure.
Returns:
the helix length or NULL if helix is NULL or not an rnamlHelix.

int rnamlisHelix const rnamlObject   obj
 

Tells wheter the object is a rnamlHelix.

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

rnamlHelix* rnamlnewHelix  
 

Creates a new rnamlHelix structure.

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

void rnamlsetHelixBaseId3p rnamlHelix   helix,
rnamlBaseId3p   baseId3p
 

Sets the helix baseId3p.

The previous baseId3p info is freed

Parameters:
helix  the rnamlHelix structure.
helix  the helix baseId3p.

void rnamlsetHelixBaseId5p rnamlHelix   helix,
rnamlBaseId5p   baseId5p
 

Sets the helix baseId5p.

The previous baseId5p info is freed

Parameters:
helix  the rnamlHelix structure.
helix  the helix baseId5p.

void rnamlsetHelixId rnamlHelix   helix,
const char *    id
 

Sets the helix id.

The previous helix id is freed and a copy of id is generated.

Parameters:
helix  the rnamlHelix structure.
id  the helix id.

void rnamlsetHelixLength rnamlHelix   helix,
rnamlLength   length
 

Sets the helix length.

Parameters:
helix  the rnamlHelix structure.
length  the helix length.

xmlcpgObject* rnamltoXMLHelix const rnamlHelix   helix
 

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

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