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

baseid.c File Reference

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

Compounds

struct  rnamlBASEID

Functions

rnamlBaseIdrnamlnewBaseId ()
 Creates a new rnamlBaseId structure.

rnamlBaseIdrnamlcloneBaseId (const rnamlBaseId *baseId)
 Clones a rnamlBaseId struture.

void rnamldeleteBaseId (rnamlBaseId *baseId)
 Frees the rnamlBaseId structure.

int rnamlisBaseId (const rnamlObject *obj)
 Tells wheter the object is a rnamlBaseId.

int rnamlequalsBaseId (const rnamlBaseId *left, const rnamlBaseId *right)
 Tells if left and right are equals.

rnamlMoleculeIdrnamlgetBaseIdMoleculeId (rnamlBaseId *baseId)
 Gets the moleculeId from the baseId.

void rnamlsetBaseIdMoleculeId (rnamlBaseId *baseId, rnamlMoleculeId *moleculeId)
 Sets the baseId moleculeId.

rnamlModelIdrnamlgetBaseIdModelId (rnamlBaseId *baseId)
 Gets the modelId from the baseId.

void rnamlsetBaseIdModelId (rnamlBaseId *baseId, rnamlModelId *modelId)
 Sets the baseId modelId.

const char * rnamlgetBaseIdStrand (const rnamlBaseId *baseId)
 Gets the strand from the baseId.

void rnamlsetBaseIdStrand (rnamlBaseId *baseId, const char *strand)
 Sets the baseId strand.

int rnamlgetBaseIdPosition (const rnamlBaseId *baseId)
 Gets the baseId position.

void rnamlsetBaseIdPosition (rnamlBaseId *baseId, int position)
 Sets the baseId position.

xmlcpgObjectrnamltoXMLBaseId (const rnamlBaseId *baseId)
 Translates the rnamlBaseId structure into a xmlcpgElement conforming to the RNAML standard.


Function Documentation

rnamlBaseId* rnamlcloneBaseId const rnamlBaseId   baseid
 

Clones a rnamlBaseId struture.

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

void rnamldeleteBaseId rnamlBaseId   baseid
 

Frees the rnamlBaseId structure.

Parameters:
baseid  the rnamlBaseId structure to free.

int rnamlequalsBaseId const rnamlBaseId   left,
const rnamlBaseId   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.

rnamlModelId* rnamlgetBaseIdModelId rnamlBaseId   baseId
 

Gets the modelId from the baseId.

Parameters:
baseId  the rnamlBaseId structure.
Returns:
the baseId modelId is NULL or if baseId is NULL or not an rnamlBaseId.

rnamlMoleculeId* rnamlgetBaseIdMoleculeId rnamlBaseId   baseId
 

Gets the moleculeId from the baseId.

Parameters:
baseId  the rnamlBaseId structure.
Returns:
the baseId moleculeId is NULL or if baseId is NULL or not an rnamlBaseId.

int rnamlgetBaseIdPosition const rnamlBaseId   baseId
 

Gets the baseId position.

Parameters:
baseId  the rnamlBaseId structure.
Returns:
the baseId position or -1 if baseId is NULL or not an rnamlBaseId.

const char* rnamlgetBaseIdStrand const rnamlBaseId   baseId
 

Gets the strand from the baseId.

Parameters:
baseId  the rnamlBaseId structure.
Returns:
the baseId strand string or NULL if baseId is NULL or not an rnamlBaseId.

int rnamlisBaseId const rnamlObject   obj
 

Tells wheter the object is a rnamlBaseId.

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

rnamlBaseId* rnamlnewBaseId  
 

Creates a new rnamlBaseId structure.

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

void rnamlsetBaseIdModelId rnamlBaseId   baseId,
rnamlModelId   modelId
 

Sets the baseId modelId.

The previous modelId info is freed

Parameters:
baseId  the rnamlBaseId structure.
baseId  the baseId modelId.

void rnamlsetBaseIdMoleculeId rnamlBaseId   baseId,
rnamlMoleculeId   moleculeId
 

Sets the baseId moleculeId.

The previous moleculeId info is freed

Parameters:
baseId  the rnamlBaseId structure.
baseId  the baseId moleculeId.

void rnamlsetBaseIdPosition rnamlBaseId   baseId,
int    position
 

Sets the baseId position.

Parameters:
baseId  the rnamlBaseId structure.
position  the baseId position.

void rnamlsetBaseIdStrand rnamlBaseId   baseId,
const char *    strand
 

Sets the baseId strand.

The previous baseId strand is freed and a copy of strand is generated.

Parameters:
baseId  the rnamlBaseId structure.
strand  the baseId strand.

xmlcpgObject* rnamltoXMLBaseId const rnamlBaseId   baseId
 

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

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


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