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

basestack.h File Reference

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

Go to the source code of this file.

Typedefs

typedef rnamlBASESTACK rnamlBaseStack
 Rnaml structure containing the basestack informations.


Functions

rnamlBaseStackrnamlnewBaseStack ()
 Creates a new rnamlBaseStack structure.

rnamlBaseStackrnamlcloneBaseStack (const rnamlBaseStack *basestack)
 Clones a rnamlBaseStack struture.

void rnamldeleteBaseStack (rnamlBaseStack *basestack)
 Frees the rnamlBaseStack structure.

int rnamlisBaseStack (const rnamlObject *obj)
 Tells wheter the object is a rnamlBaseStack.

int rnamlequalsBaseStack (const rnamlBaseStack *left, const rnamlBaseStack *right)
 Tells if left and right are equals.

rnamlBaseIdrnamlgetBaseStackBaseId1 (rnamlBaseStack *baseStack)
 Gets the baseStack baseId1.

void rnamlsetBaseStackBaseId1 (rnamlBaseStack *baseStack, rnamlBaseId *baseId1)
 Sets the baseStack baseId1.

rnamlBaseIdrnamlgetBaseStackBaseId2 (rnamlBaseStack *baseStack)
 Gets the baseStack baseId2.

void rnamlsetBaseStackBaseId2 (rnamlBaseStack *baseStack, rnamlBaseId *baseId2)
 Sets the baseStack baseId2.

xmlcpgObjectrnamltoXMLBaseStack (const rnamlBaseStack *baseStack)
 Translates the rnamlBaseStack structure into a xmlcpgElement conforming to the RNAML standard.


Typedef Documentation

typedef struct rnamlBASESTACK rnamlBaseStack
 

Rnaml structure containing the basestack informations.


Function Documentation

rnamlBaseStack* rnamlcloneBaseStack const rnamlBaseStack   basestack
 

Clones a rnamlBaseStack struture.

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

void rnamldeleteBaseStack rnamlBaseStack   basestack
 

Frees the rnamlBaseStack structure.

Parameters:
basestack  the rnamlBaseStack structure to free.

int rnamlequalsBaseStack const rnamlBaseStack   left,
const rnamlBaseStack   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* rnamlgetBaseStackBaseId1 rnamlBaseStack   baseStack
 

Gets the baseStack baseId1.

Parameters:
baseStack  the rnamlBaseStack structure.
Returns:
the baseStack baseId is NULL or if baseStack is NULL or not an rnamlBaseStack.

rnamlBaseId* rnamlgetBaseStackBaseId2 rnamlBaseStack   baseStack
 

Gets the baseStack baseId2.

Parameters:
baseStack  the rnamlBaseStack structure.
Returns:
the baseStack baseId is NULL or if baseStack is NULL or not an rnamlBaseStack.

int rnamlisBaseStack const rnamlObject   obj
 

Tells wheter the object is a rnamlBaseStack.

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

rnamlBaseStack* rnamlnewBaseStack  
 

Creates a new rnamlBaseStack structure.

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

void rnamlsetBaseStackBaseId1 rnamlBaseStack   baseStack,
rnamlBaseId   baseId1
 

Sets the baseStack baseId1.

The previous baseId1 info is freed

Parameters:
baseStack  the rnamlBaseStack structure.
baseStack  the baseStack baseId.

void rnamlsetBaseStackBaseId2 rnamlBaseStack   baseStack,
rnamlBaseId   baseId2
 

Sets the baseStack baseId2.

The previous baseId info is freed

Parameters:
baseStack  the rnamlBaseStack structure.
baseStack  the baseStack baseId.

xmlcpgObject* rnamltoXMLBaseStack const rnamlBaseStack   baseStack
 

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

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


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