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

helixid.h File Reference

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

Go to the source code of this file.

Typedefs

typedef rnamlHELIXID rnamlHelixId
 Rnaml structure containing the helixid informations.


Functions

rnamlHelixIdrnamlnewHelixId ()
 Creates a new rnamlHelixId structure.

rnamlHelixIdrnamlcloneHelixId (const rnamlHelixId *helixid)
 Clones a rnamlHelixId struture.

void rnamldeleteHelixId (rnamlHelixId *helixid)
 Frees the rnamlHelixId structure.

int rnamlisHelixId (const rnamlObject *obj)
 Tells wheter the object is a rnamlHelixId.

int rnamlequalsHelixId (const rnamlHelixId *left, const rnamlHelixId *right)
 Tells if left and right are equals.

const char * rnamlgetHelixIdRef (const rnamlHelixId *helixId)
 Gets the helixId ref.

void rnamlsetHelixIdRef (rnamlHelixId *helixId, const char *ref)
 Sets the helixId ref.

xmlcpgObjectrnamltoXMLHelixId (const rnamlHelixId *helixId)
 Translates the rnamlHelixId structure into a xmlcpgElement conforming to the RNAML standard.


Typedef Documentation

typedef struct rnamlHELIXID rnamlHelixId
 

Rnaml structure containing the helixid informations.


Function Documentation

rnamlHelixId* rnamlcloneHelixId const rnamlHelixId   helixid
 

Clones a rnamlHelixId struture.

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

void rnamldeleteHelixId rnamlHelixId   helixid
 

Frees the rnamlHelixId structure.

Parameters:
helixid  the rnamlHelixId structure to free.

int rnamlequalsHelixId const rnamlHelixId   left,
const rnamlHelixId   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.

const char* rnamlgetHelixIdRef const rnamlHelixId   helixId
 

Gets the helixId ref.

Parameters:
helixId  the rnamlHelixId structure.
Returns:
the helixId ref string or NULL if helixId is NULL or not an rnamlHelixId.

int rnamlisHelixId const rnamlObject   obj
 

Tells wheter the object is a rnamlHelixId.

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

rnamlHelixId* rnamlnewHelixId  
 

Creates a new rnamlHelixId structure.

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

void rnamlsetHelixIdRef rnamlHelixId   helixId,
const char *    ref
 

Sets the helixId ref.

The previous helixId ref is freed and a copy of ref is generated.

Parameters:
helixId  the rnamlHelixId structure.
ref  the helixId ref.

xmlcpgObject* rnamltoXMLHelixId const rnamlHelixId   helixId
 

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

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


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