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

baseconformation.h File Reference

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

Go to the source code of this file.

Typedefs

typedef rnamlBASECONFORMATION rnamlBaseConformation
 Rnaml structure containing the baseconformation informations.


Functions

rnamlBaseConformationrnamlnewBaseConformation ()
 Creates a new rnamlBaseConformation structure.

rnamlBaseConformationrnamlcloneBaseConformation (const rnamlBaseConformation *baseconformation)
 Clones a rnamlBaseConformation struture.

void rnamldeleteBaseConformation (rnamlBaseConformation *baseconformation)
 Frees the rnamlBaseConformation structure.

int rnamlisBaseConformation (const rnamlObject *obj)
 Tells wheter the object is a rnamlBaseConformation.

int rnamlequalsBaseConformation (const rnamlBaseConformation *left, const rnamlBaseConformation *right)
 Tells if left and right are equals.

rnamlBaseIdrnamlgetBaseConformationBaseId (rnamlBaseConformation *baseConformation)
 Gets the baseId from the baseConformation.

void rnamlsetBaseConformationBaseId (rnamlBaseConformation *baseConformation, rnamlBaseId *baseId)
 Sets the baseConformation baseId.

const char * rnamlgetBaseConformationPucker (const rnamlBaseConformation *baseConformation)
 Gets the pucker from the baseConformation.

void rnamlsetBaseConformationPucker (rnamlBaseConformation *baseConformation, const char *pucker)
 Sets the baseConformation pucker.

const char * rnamlgetBaseConformationGlycosyl (const rnamlBaseConformation *baseConformation)
 Gets the glycosyl from the baseConformation.

void rnamlsetBaseConformationGlycosyl (rnamlBaseConformation *baseConformation, const char *glycosyl)
 Sets the baseConformation glycosyl.

rnamlBaseTorsionAnglesrnamlgetBaseConformationBaseTorsionAngles (rnamlBaseConformation *baseConformation)
 Gets the baseTorsionAngles from the baseConformation.

void rnamlsetBaseConformationBaseTorsionAngles (rnamlBaseConformation *baseConformation, rnamlBaseTorsionAngles *baseTorsionAngles)
 Sets the baseConformation baseTorsionAngles.

xmlcpgObjectrnamltoXMLBaseConformation (const rnamlBaseConformation *baseConformation)
 Translates the rnamlBaseConformation structure into a xmlcpgElement conforming to the RNAML standard.


Typedef Documentation

typedef struct rnamlBASECONFORMATION rnamlBaseConformation
 

Rnaml structure containing the baseconformation informations.


Function Documentation

rnamlBaseConformation* rnamlcloneBaseConformation const rnamlBaseConformation   baseconformation
 

Clones a rnamlBaseConformation struture.

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

void rnamldeleteBaseConformation rnamlBaseConformation   baseconformation
 

Frees the rnamlBaseConformation structure.

Parameters:
baseconformation  the rnamlBaseConformation structure to free.

int rnamlequalsBaseConformation const rnamlBaseConformation   left,
const rnamlBaseConformation   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* rnamlgetBaseConformationBaseId rnamlBaseConformation   baseConformation
 

Gets the baseId from the baseConformation.

Parameters:
baseConformation  the rnamlBaseConformation structure.
Returns:
the baseConformation baseId is NULL or if baseConformation is NULL or not an rnamlBaseConformation.

rnamlBaseTorsionAngles* rnamlgetBaseConformationBaseTorsionAngles rnamlBaseConformation   baseConformation
 

Gets the baseTorsionAngles from the baseConformation.

Parameters:
baseConformation  the rnamlBaseConformation structure.
Returns:
the baseConformation baseTorsionAngles is NULL or if baseConformation is NULL or not an rnamlBaseConformation.

const char* rnamlgetBaseConformationGlycosyl const rnamlBaseConformation   baseConformation
 

Gets the glycosyl from the baseConformation.

Parameters:
baseConformation  the rnamlBaseConformation structure.
Returns:
the baseConformation glycosyl string or NULL if baseConformation is NULL or not an rnamlBaseConformation.

const char* rnamlgetBaseConformationPucker const rnamlBaseConformation   baseConformation
 

Gets the pucker from the baseConformation.

Parameters:
baseConformation  the rnamlBaseConformation structure.
Returns:
the baseConformation pucker string or NULL if baseConformation is NULL or not an rnamlBaseConformation.

int rnamlisBaseConformation const rnamlObject   obj
 

Tells wheter the object is a rnamlBaseConformation.

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

rnamlBaseConformation* rnamlnewBaseConformation  
 

Creates a new rnamlBaseConformation structure.

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

void rnamlsetBaseConformationBaseId rnamlBaseConformation   baseConformation,
rnamlBaseId   baseId
 

Sets the baseConformation baseId.

The previous baseId info is freed

Parameters:
baseConformation  the rnamlBaseConformation structure.
baseConformation  the baseConformation baseId.

void rnamlsetBaseConformationBaseTorsionAngles rnamlBaseConformation   baseConformation,
rnamlBaseTorsionAngles   baseTorsionAngles
 

Sets the baseConformation baseTorsionAngles.

The previous baseTorsionAngles info is freed

Parameters:
baseConformation  the rnamlBaseConformation structure.
baseConformation  the baseConformation baseTorsionAngles.

void rnamlsetBaseConformationGlycosyl rnamlBaseConformation   baseConformation,
const char *    glycosyl
 

Sets the baseConformation glycosyl.

The previous baseConformation glycosyl is freed and a copy of glycosyl is generated.

Parameters:
baseConformation  the rnamlBaseConformation structure.
glycosyl  the baseConformation glycosyl.

void rnamlsetBaseConformationPucker rnamlBaseConformation   baseConformation,
const char *    pucker
 

Sets the baseConformation pucker.

The previous baseConformation pucker is freed and a copy of pucker is generated.

Parameters:
baseConformation  the rnamlBaseConformation structure.
pucker  the baseConformation pucker.

xmlcpgObject* rnamltoXMLBaseConformation const rnamlBaseConformation   baseConformation
 

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

Parameters:
molecule  the rnamlBaseConformation 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