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

ssbasecoord.h File Reference

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

Go to the source code of this file.

Typedefs

typedef rnamlSSBASECOORD rnamlSsBaseCoord
 Rnaml structure containing the ssbasecoord informations.


Functions

rnamlSsBaseCoordrnamlnewSsBaseCoord ()
 Creates a new rnamlSsBaseCoord structure.

rnamlSsBaseCoordrnamlcloneSsBaseCoord (const rnamlSsBaseCoord *ssbasecoord)
 Clones a rnamlSsBaseCoord struture.

void rnamldeleteSsBaseCoord (rnamlSsBaseCoord *ssbasecoord)
 Frees the rnamlSsBaseCoord structure.

int rnamlisSsBaseCoord (const rnamlObject *obj)
 Tells wheter the object is a rnamlSsBaseCoord.

int rnamlequalsSsBaseCoord (const rnamlSsBaseCoord *left, const rnamlSsBaseCoord *right)
 Tells if left and right are equals.

rnamlBaseIdrnamlgetSsBaseCoordBaseId (rnamlSsBaseCoord *ssBaseCoord)
 Gets the baseId from the ssBaseCoord.

void rnamlsetSsBaseCoordBaseId (rnamlSsBaseCoord *ssBaseCoord, rnamlBaseId *baseId)
 Sets the ssBaseCoord baseId.

float rnamlgetSsBaseCoordX (const rnamlSsBaseCoord *ssBaseCoord)
 Gets the x from the ssBaseCoord.

void rnamlsetSsBaseCoordX (rnamlSsBaseCoord *ssBaseCoord, float x)
 Sets the ssBaseCoord x.

float rnamlgetSsBaseCoordY (const rnamlSsBaseCoord *ssBaseCoord)
 Gets the y from the ssBaseCoord.

void rnamlsetSsBaseCoordY (rnamlSsBaseCoord *ssBaseCoord, float y)
 Sets the ssBaseCoord y.

xmlcpgObjectrnamltoXMLSsBaseCoord (const rnamlSsBaseCoord *ssBaseCoord)
 Translates the rnamlSsBaseCoord structure into a xmlcpgElement conforming to the RNAML standard.


Typedef Documentation

typedef struct rnamlSSBASECOORD rnamlSsBaseCoord
 

Rnaml structure containing the ssbasecoord informations.


Function Documentation

rnamlSsBaseCoord* rnamlcloneSsBaseCoord const rnamlSsBaseCoord   ssbasecoord
 

Clones a rnamlSsBaseCoord struture.

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

void rnamldeleteSsBaseCoord rnamlSsBaseCoord   ssbasecoord
 

Frees the rnamlSsBaseCoord structure.

Parameters:
ssbasecoord  the rnamlSsBaseCoord structure to free.

int rnamlequalsSsBaseCoord const rnamlSsBaseCoord   left,
const rnamlSsBaseCoord   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* rnamlgetSsBaseCoordBaseId rnamlSsBaseCoord   ssBaseCoord
 

Gets the baseId from the ssBaseCoord.

Parameters:
ssBaseCoord  the rnamlSsBaseCoord structure.
Returns:
the ssBaseCoord baseId is NULL or if ssBaseCoord is NULL or not an rnamlSsBaseCoord.

float rnamlgetSsBaseCoordX const rnamlSsBaseCoord   ssBaseCoord
 

Gets the x from the ssBaseCoord.

Parameters:
ssBaseCoord  the rnamlSsBaseCoord structure.
Returns:
the x or 0 if ssBaseCoord is NULL or not an rnamlSsBaseCoord.

float rnamlgetSsBaseCoordY const rnamlSsBaseCoord   ssBaseCoord
 

Gets the y from the ssBaseCoord.

Parameters:
ssBaseCoord  the rnamlSsBaseCoord structure.
Returns:
the y or 0 if ssBaseCoord is NULL or not an rnamlSsBaseCoord.

int rnamlisSsBaseCoord const rnamlObject   obj
 

Tells wheter the object is a rnamlSsBaseCoord.

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

rnamlSsBaseCoord* rnamlnewSsBaseCoord  
 

Creates a new rnamlSsBaseCoord structure.

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

void rnamlsetSsBaseCoordBaseId rnamlSsBaseCoord   ssBaseCoord,
rnamlBaseId   baseId
 

Sets the ssBaseCoord baseId.

The previous baseId info is freed

Parameters:
ssBaseCoord  the rnamlSsBaseCoord structure.
ssBaseCoord  the ssBaseCoord baseId.

void rnamlsetSsBaseCoordX rnamlSsBaseCoord   ssBaseCoord,
float    x
 

Sets the ssBaseCoord x.

The previous ssBaseCoord x is freed and a copy of x is generated.

Parameters:
ssBaseCoord  the rnamlSsBaseCoord structure.
x  the ssBaseCoord x.

void rnamlsetSsBaseCoordY rnamlSsBaseCoord   ssBaseCoord,
float    y
 

Sets the ssBaseCoord y.

The previous ssBaseCoord y is freed and a copy of y is generated.

Parameters:
ssBaseCoord  the rnamlSsBaseCoord structure.
y  the ssBaseCoord y.

xmlcpgObject* rnamltoXMLSsBaseCoord const rnamlSsBaseCoord   ssBaseCoord
 

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

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