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

modification.h File Reference

#include "baseid.h"
#include "object.h"
#include "xmlcpg.h"

Go to the source code of this file.

Typedefs

typedef rnamlMODIFICATION rnamlModification
 Rnaml structure containing the modification informations.


Functions

rnamlModificationrnamlnewModification ()
 Creates a new rnamlModification structure.

rnamlModificationrnamlcloneModification (const rnamlModification *modification)
 Clones a rnamlModification struture.

void rnamldeleteModification (rnamlModification *modification)
 Frees the rnamlModification structure.

int rnamlisModification (const rnamlObject *obj)
 Tells wheter the object is a rnamlModification.

int rnamlequalsModification (const rnamlModification *left, const rnamlModification *right)
 Tells if left and right are equals.

rnamlBaseIdrnamlgetModificationBaseId (rnamlModification *modification)
 Gets the baseId from the modification.

void rnamlsetModificationBaseId (rnamlModification *modification, rnamlBaseId *baseId)
 Sets the modification baseId.

const char * rnamlgetModificationModifiedType (const rnamlModification *modification)
 Gets the modifiedType from the modification.

void rnamlsetModificationModifiedType (rnamlModification *modification, const char *modifiedType)
 Sets the modification modifiedType.

xmlcpgObjectrnamltoXMLModification (const rnamlModification *modification)
 Translates the rnamlModification structure into a xmlcpgElement conforming to the RNAML standard.


Typedef Documentation

typedef struct rnamlMODIFICATION rnamlModification
 

Rnaml structure containing the modification informations.


Function Documentation

rnamlModification* rnamlcloneModification const rnamlModification   modification
 

Clones a rnamlModification struture.

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

void rnamldeleteModification rnamlModification   modification
 

Frees the rnamlModification structure.

Parameters:
modification  the rnamlModification structure to free.

int rnamlequalsModification const rnamlModification   left,
const rnamlModification   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.

rnamlBaseId* rnamlgetModificationBaseId rnamlModification   modification
 

Gets the baseId from the modification.

Parameters:
modification  the rnamlModification structure.
Returns:
the modification baseId is NULL or if modification is NULL or not an rnamlModification.

const char* rnamlgetModificationModifiedType const rnamlModification   modification
 

Gets the modifiedType from the modification.

Parameters:
modification  the rnamlModification structure.
Returns:
the modification modifiedType string or NULL if modification is NULL or not an rnamlModification.

int rnamlisModification const rnamlObject   obj
 

Tells wheter the object is a rnamlModification.

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

rnamlModification* rnamlnewModification  
 

Creates a new rnamlModification structure.

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

void rnamlsetModificationBaseId rnamlModification   modification,
rnamlBaseId   baseId
 

Sets the modification baseId.

The previous baseId info is freed

Parameters:
modification  the rnamlModification structure.
modification  the modification baseId.

void rnamlsetModificationModifiedType rnamlModification   modification,
const char *    modifiedType
 

Sets the modification modifiedType.

The previous modification modifiedType is freed and a copy of modifiedType is generated.

Parameters:
modification  the rnamlModification structure.
modifiedType  the modification modifiedType.

xmlcpgObject* rnamltoXMLModification const rnamlModification   modification
 

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

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


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