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

secondarystructuredisplay.h File Reference

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

Go to the source code of this file.

Typedefs

typedef rnamlSECONDARYSTRUCTUREDISPLAY rnamlSecondaryStructureDisplay
 Rnaml structure containing the secondarystructuredisplay informations.


Functions

rnamlSecondaryStructureDisplayrnamlnewSecondaryStructureDisplay ()
 Creates a new rnamlSecondaryStructureDisplay structure.

rnamlSecondaryStructureDisplayrnamlcloneSecondaryStructureDisplay (const rnamlSecondaryStructureDisplay *secondarystructuredisplay)
 Clones a rnamlSecondaryStructureDisplay struture.

void rnamldeleteSecondaryStructureDisplay (rnamlSecondaryStructureDisplay *secondarystructuredisplay)
 Frees the rnamlSecondaryStructureDisplay structure.

int rnamlisSecondaryStructureDisplay (const rnamlObject *obj)
 Tells wheter the object is a rnamlSecondaryStructureDisplay.

int rnamlequalsSecondaryStructureDisplay (const rnamlSecondaryStructureDisplay *left, const rnamlSecondaryStructureDisplay *right)
 Tells if left and right are equals.

void rnamladdSecondaryStructureDisplaySsBaseCoord (rnamlSecondaryStructureDisplay *secondaryStructureDisplay, rnamlSsBaseCoord *ssBaseCoord)
 Adds a ssBaseCoord into a secondaryStructureDisplay.

xmlcpgListrnamlgetSecondaryStructureDisplaySsBaseCoords (rnamlSecondaryStructureDisplay *secondaryStructureDisplay)
 Gets the secondaryStructureDisplay's ssBaseCoord list.

xmlcpgObjectrnamltoXMLSecondaryStructureDisplay (const rnamlSecondaryStructureDisplay *secondaryStructureDisplay)
 Translates the rnamlSecondaryStructureDisplay structure into a xmlcpgElement conforming to the RNAML standard.


Typedef Documentation

typedef struct rnamlSECONDARYSTRUCTUREDISPLAY rnamlSecondaryStructureDisplay
 

Rnaml structure containing the secondarystructuredisplay informations.


Function Documentation

void rnamladdSecondaryStructureDisplaySsBaseCoord rnamlSecondaryStructureDisplay   secondaryStructureDisplay,
rnamlSsBaseCoord   ssBaseCoord
 

Adds a ssBaseCoord into a secondaryStructureDisplay.

Parameters:
secondaryStructureDisplay  the rnamlSecondaryStructureDisplay structure.
ssBaseCoord  the rnamlSsBaseCoord structure.

rnamlSecondaryStructureDisplay* rnamlcloneSecondaryStructureDisplay const rnamlSecondaryStructureDisplay   secondarystructuredisplay
 

Clones a rnamlSecondaryStructureDisplay struture.

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

void rnamldeleteSecondaryStructureDisplay rnamlSecondaryStructureDisplay   secondarystructuredisplay
 

Frees the rnamlSecondaryStructureDisplay structure.

Parameters:
secondarystructuredisplay  the rnamlSecondaryStructureDisplay structure to free.

int rnamlequalsSecondaryStructureDisplay const rnamlSecondaryStructureDisplay   left,
const rnamlSecondaryStructureDisplay   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.

xmlcpgList* rnamlgetSecondaryStructureDisplaySsBaseCoords rnamlSecondaryStructureDisplay   secondaryStructureDisplay
 

Gets the secondaryStructureDisplay's ssBaseCoord list.

Parameters:
secondaryStructureDisplay  the rnamlSecondaryStructureDisplay structure.
Returns:
the secondaryStructureDisplay's ssBaseCoord xmlcpgList or NULL if something goes wrong.

int rnamlisSecondaryStructureDisplay const rnamlObject   obj
 

Tells wheter the object is a rnamlSecondaryStructureDisplay.

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

rnamlSecondaryStructureDisplay* rnamlnewSecondaryStructureDisplay  
 

Creates a new rnamlSecondaryStructureDisplay structure.

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

xmlcpgObject* rnamltoXMLSecondaryStructureDisplay const rnamlSecondaryStructureDisplay   secondaryStructureDisplay
 

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

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


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