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

pseudoknot.h File Reference

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

Go to the source code of this file.

Typedefs

typedef rnamlPSEUDOKNOT rnamlPseudoknot
 Rnaml structure containing the pseudoknot informations.


Functions

rnamlPseudoknotrnamlnewPseudoknot ()
 Creates a new rnamlPseudoknot structure.

rnamlPseudoknotrnamlclonePseudoknot (const rnamlPseudoknot *pseudoknot)
 Clones a rnamlPseudoknot struture.

void rnamldeletePseudoknot (rnamlPseudoknot *pseudoknot)
 Frees the rnamlPseudoknot structure.

int rnamlisPseudoknot (const rnamlObject *obj)
 Tells wheter the object is a rnamlPseudoknot.

int rnamlequalsPseudoknot (const rnamlPseudoknot *left, const rnamlPseudoknot *right)
 Tells if left and right are equals.

rnamlHelixIdrnamlgetPseudoknotHelixId1 (rnamlPseudoknot *pseudoknot)
 Gets the pseudoknot helixId1.

void rnamlsetPseudoknotHelixId1 (rnamlPseudoknot *pseudoknot, rnamlHelixId *helixId1)
 Sets the pseudoknot helixId1.

rnamlHelixIdrnamlgetPseudoknotHelixId2 (rnamlPseudoknot *pseudoknot)
 Gets the pseudoknot helixId2.

void rnamlsetPseudoknotHelixId2 (rnamlPseudoknot *pseudoknot, rnamlHelixId *helixId2)
 Sets the pseudoknot helixId2.

xmlcpgObjectrnamltoXMLPseudoknot (const rnamlPseudoknot *pseudoknot)
 Translates the rnamlPseudoknot structure into a xmlcpgElement conforming to the RNAML standard.


Typedef Documentation

typedef struct rnamlPSEUDOKNOT rnamlPseudoknot
 

Rnaml structure containing the pseudoknot informations.


Function Documentation

rnamlPseudoknot* rnamlclonePseudoknot const rnamlPseudoknot   pseudoknot
 

Clones a rnamlPseudoknot struture.

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

void rnamldeletePseudoknot rnamlPseudoknot   pseudoknot
 

Frees the rnamlPseudoknot structure.

Parameters:
pseudoknot  the rnamlPseudoknot structure to free.

int rnamlequalsPseudoknot const rnamlPseudoknot   left,
const rnamlPseudoknot   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.

rnamlHelixId* rnamlgetPseudoknotHelixId1 rnamlPseudoknot   pseudoknot
 

Gets the pseudoknot helixId1.

Parameters:
pseudoknot  the rnamlPseudoknot structure.
Returns:
the pseudoknot helixId1 is NULL or if pseudoknot is NULL or not an rnamlPseudoknot.

rnamlHelixId* rnamlgetPseudoknotHelixId2 rnamlPseudoknot   pseudoknot
 

Gets the pseudoknot helixId2.

Parameters:
pseudoknot  the rnamlPseudoknot structure.
Returns:
the pseudoknot helixId2 is NULL or if pseudoknot is NULL or not an rnamlPseudoknot.

int rnamlisPseudoknot const rnamlObject   obj
 

Tells wheter the object is a rnamlPseudoknot.

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

rnamlPseudoknot* rnamlnewPseudoknot  
 

Creates a new rnamlPseudoknot structure.

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

void rnamlsetPseudoknotHelixId1 rnamlPseudoknot   pseudoknot,
rnamlHelixId   helixId1
 

Sets the pseudoknot helixId1.

The previous helixId1 info is freed

Parameters:
pseudoknot  the rnamlPseudoknot structure.
pseudoknot  the pseudoknot helixId1.

void rnamlsetPseudoknotHelixId2 rnamlPseudoknot   pseudoknot,
rnamlHelixId   helixId2
 

Sets the pseudoknot helixId2.

The previous helixId2 info is freed

Parameters:
pseudoknot  the rnamlPseudoknot structure.
pseudoknot  the pseudoknot helixId2.

xmlcpgObject* rnamltoXMLPseudoknot const rnamlPseudoknot   pseudoknot
 

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

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


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