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

basepair.h File Reference

#include "baseid5p.h"
#include "baseid3p.h"
#include "object.h"
#include "xmlcpg.h"

Go to the source code of this file.

Typedefs

typedef rnamlBASEPAIR rnamlBasePair
 Rnaml structure containing the basepair informations.


Functions

rnamlBasePairrnamlnewBasePair ()
 Creates a new rnamlBasePair structure.

rnamlBasePairrnamlcloneBasePair (const rnamlBasePair *basepair)
 Clones a rnamlBasePair struture.

void rnamldeleteBasePair (rnamlBasePair *basepair)
 Frees the rnamlBasePair structure.

int rnamlisBasePair (const rnamlObject *obj)
 Tells wheter the object is a rnamlBasePair.

int rnamlequalsBasePair (const rnamlBasePair *left, const rnamlBasePair *right)
 Tells if left and right are equals.

rnamlBaseId5prnamlgetBasePairBaseId5p (rnamlBasePair *basePair)
 Gets the baseId5p from the basePair.

void rnamlsetBasePairBaseId5p (rnamlBasePair *basePair, rnamlBaseId5p *baseId5p)
 Sets the basePair baseId5p.

rnamlBaseId3prnamlgetBasePairBaseId3p (rnamlBasePair *basePair)
 Gets the baseId3p from the basePair.

void rnamlsetBasePairBaseId3p (rnamlBasePair *basePair, rnamlBaseId3p *baseId3p)
 Sets the basePair baseId3p.

const char * rnamlgetBasePairEdge5p (const rnamlBasePair *basePair)
 Gets the edge5p from the basePair.

void rnamlsetBasePairEdge5p (rnamlBasePair *basePair, const char *edge5p)
 Sets the basePair edge5p.

const char * rnamlgetBasePairEdge3p (const rnamlBasePair *basePair)
 Gets the edge3p from the basePair.

void rnamlsetBasePairEdge3p (rnamlBasePair *basePair, const char *edge3p)
 Sets the basePair edge3p.

const char * rnamlgetBasePairBondOrientation (const rnamlBasePair *basePair)
 Gets the bondOrientation from the basePair.

void rnamlsetBasePairBondOrientation (rnamlBasePair *basePair, const char *bondOrientation)
 Sets the basePair bondOrientation.

const char * rnamlgetBasePairStrandOrientation (const rnamlBasePair *basePair)
 Gets the strandOrientation from the basePair.

void rnamlsetBasePairStrandOrientation (rnamlBasePair *basePair, const char *strandOrientation)
 Sets the basePair strandOrientation.

xmlcpgObjectrnamltoXMLBasePair (const rnamlBasePair *basePair)
 Translates the rnamlBasePair structure into a xmlcpgElement conforming to the RNAML standard.


Typedef Documentation

typedef struct rnamlBASEPAIR rnamlBasePair
 

Rnaml structure containing the basepair informations.


Function Documentation

rnamlBasePair* rnamlcloneBasePair const rnamlBasePair   basepair
 

Clones a rnamlBasePair struture.

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

void rnamldeleteBasePair rnamlBasePair   basepair
 

Frees the rnamlBasePair structure.

Parameters:
basepair  the rnamlBasePair structure to free.

int rnamlequalsBasePair const rnamlBasePair   left,
const rnamlBasePair   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* rnamlgetBasePairBaseId3p rnamlBasePair   basePair
 

Gets the baseId3p from the basePair.

Parameters:
basePair  the rnamlBasePair structure.
Returns:
the basePair baseId3p is NULL or if basePair is NULL or not an rnamlBasePair.

rnamlBaseId5p* rnamlgetBasePairBaseId5p rnamlBasePair   basePair
 

Gets the baseId5p from the basePair.

Parameters:
basePair  the rnamlBasePair structure.
Returns:
the basePair baseId5p is NULL or if basePair is NULL or not an rnamlBasePair.

const char* rnamlgetBasePairBondOrientation const rnamlBasePair   basePair
 

Gets the bondOrientation from the basePair.

Parameters:
basePair  the rnamlBasePair structure.
Returns:
the basePair bondOrientation string or NULL if basePair is NULL or not an rnamlBasePair.

const char* rnamlgetBasePairEdge3p const rnamlBasePair   basePair
 

Gets the edge3p from the basePair.

Parameters:
basePair  the rnamlBasePair structure.
Returns:
the basePair edge3p string or NULL if basePair is NULL or not an rnamlBasePair.

const char* rnamlgetBasePairEdge5p const rnamlBasePair   basePair
 

Gets the edge5p from the basePair.

Parameters:
basePair  the rnamlBasePair structure.
Returns:
the basePair edge5p string or NULL if basePair is NULL or not an rnamlBasePair.

const char* rnamlgetBasePairStrandOrientation const rnamlBasePair   basePair
 

Gets the strandOrientation from the basePair.

Parameters:
basePair  the rnamlBasePair structure.
Returns:
the basePair strandOrientation string or NULL if basePair is NULL or not an rnamlBasePair.

int rnamlisBasePair const rnamlObject   obj
 

Tells wheter the object is a rnamlBasePair.

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

rnamlBasePair* rnamlnewBasePair  
 

Creates a new rnamlBasePair structure.

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

void rnamlsetBasePairBaseId3p rnamlBasePair   basePair,
rnamlBaseId3p   baseId3p
 

Sets the basePair baseId3p.

The previous baseId3p info is freed

Parameters:
basePair  the rnamlBasePair structure.
basePair  the basePair baseId3p.

void rnamlsetBasePairBaseId5p rnamlBasePair   basePair,
rnamlBaseId5p   baseId5p
 

Sets the basePair baseId5p.

The previous baseId5p info is freed

Parameters:
basePair  the rnamlBasePair structure.
basePair  the basePair baseId5p.

void rnamlsetBasePairBondOrientation rnamlBasePair   basePair,
const char *    bondOrientation
 

Sets the basePair bondOrientation.

The previous basePair bondOrientation is freed and a copy of bondOrientation is generated.

Parameters:
basePair  the rnamlBasePair structure.
bondOrientation  the basePair bondOrientation.

void rnamlsetBasePairEdge3p rnamlBasePair   basePair,
const char *    edge3p
 

Sets the basePair edge3p.

The previous basePair edge3p is freed and a copy of edge3p is generated.

Parameters:
basePair  the rnamlBasePair structure.
edge3p  the basePair edge3p.

void rnamlsetBasePairEdge5p rnamlBasePair   basePair,
const char *    edge5p
 

Sets the basePair edge5p.

The previous basePair edge5p is freed and a copy of edge5p is generated.

Parameters:
basePair  the rnamlBasePair structure.
edge5p  the basePair edge5p.

void rnamlsetBasePairStrandOrientation rnamlBasePair   basePair,
const char *    strandOrientation
 

Sets the basePair strandOrientation.

The previous basePair strandOrientation is freed and a copy of strandOrientation is generated.

Parameters:
basePair  the rnamlBasePair structure.
strandOrientation  the basePair strandOrientation.

xmlcpgObject* rnamltoXMLBasePair const rnamlBasePair   basePair
 

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

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