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

alisequence.h File Reference

#include "moleculeid.h"
#include "seqdata.h"
#include "object.h"
#include "xmlcpg.h"

Go to the source code of this file.

Typedefs

typedef rnamlALISEQUENCE rnamlAliSequence
 Rnaml structure containing the alisequence informations.


Functions

rnamlAliSequencernamlnewAliSequence ()
 Creates a new rnamlAliSequence structure.

rnamlAliSequencernamlcloneAliSequence (const rnamlAliSequence *alisequence)
 Clones a rnamlAliSequence struture.

void rnamldeleteAliSequence (rnamlAliSequence *alisequence)
 Frees the rnamlAliSequence structure.

int rnamlisAliSequence (const rnamlObject *obj)
 Tells wheter the object is a rnamlAliSequence.

int rnamlequalsAliSequence (const rnamlAliSequence *left, const rnamlAliSequence *right)
 Tells if left and right are equals.

rnamlMoleculeIdrnamlgetAliSequenceMoleculeId (rnamlAliSequence *aliSequence)
 Gets the moleculeId from the aliSequence.

void rnamlsetAliSequenceMoleculeId (rnamlAliSequence *aliSequence, rnamlMoleculeId *moleculeId)
 Sets the aliSequence moleculeId.

rnamlSeqDatarnamlgetAliSequenceSeqData (rnamlAliSequence *aliSequence)
 Gets the seqData from the aliSequence.

void rnamlsetAliSequenceSeqData (rnamlAliSequence *aliSequence, rnamlSeqData *seqData)
 Sets the aliSequence seqData.

xmlcpgObjectrnamltoXMLAliSequence (const rnamlAliSequence *aliSequence)
 Translates the rnamlAliSequence structure into a xmlcpgElement conforming to the RNAML standard.


Typedef Documentation

typedef struct rnamlALISEQUENCE rnamlAliSequence
 

Rnaml structure containing the alisequence informations.


Function Documentation

rnamlAliSequence* rnamlcloneAliSequence const rnamlAliSequence   alisequence
 

Clones a rnamlAliSequence struture.

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

void rnamldeleteAliSequence rnamlAliSequence   alisequence
 

Frees the rnamlAliSequence structure.

Parameters:
alisequence  the rnamlAliSequence structure to free.

int rnamlequalsAliSequence const rnamlAliSequence   left,
const rnamlAliSequence   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.

rnamlMoleculeId* rnamlgetAliSequenceMoleculeId rnamlAliSequence   aliSequence
 

Gets the moleculeId from the aliSequence.

Parameters:
aliSequence  the rnamlAliSequence structure.
Returns:
the aliSequence moleculeId is NULL or if aliSequence is NULL or not an rnamlAliSequence.

rnamlSeqData* rnamlgetAliSequenceSeqData rnamlAliSequence   aliSequence
 

Gets the seqData from the aliSequence.

Parameters:
aliSequence  the rnamlAliSequence structure.
Returns:
the aliSequence seqData is NULL or if aliSequence is NULL or not an rnamlAliSequence.

int rnamlisAliSequence const rnamlObject   obj
 

Tells wheter the object is a rnamlAliSequence.

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

rnamlAliSequence* rnamlnewAliSequence  
 

Creates a new rnamlAliSequence structure.

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

void rnamlsetAliSequenceMoleculeId rnamlAliSequence   aliSequence,
rnamlMoleculeId   moleculeId
 

Sets the aliSequence moleculeId.

The previous moleculeId info is freed

Parameters:
aliSequence  the rnamlAliSequence structure.
aliSequence  the aliSequence moleculeId.

void rnamlsetAliSequenceSeqData rnamlAliSequence   aliSequence,
rnamlSeqData   seqData
 

Sets the aliSequence seqData.

The previous seqData info is freed

Parameters:
aliSequence  the rnamlAliSequence structure.
aliSequence  the aliSequence seqData.

xmlcpgObject* rnamltoXMLAliSequence const rnamlAliSequence   aliSequence
 

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

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


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