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

rnaml.h File Reference

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

Go to the source code of this file.

Typedefs

typedef rnamlRNAML rnamlRnaml
 Rnaml structure containing the rnaml informations.


Functions

rnamlRnamlrnamlnewRnaml ()
 Creates a new rnamlRnaml structure.

rnamlRnamlrnamlcloneRnaml (const rnamlRnaml *rnaml)
 Clones a rnamlRnaml structure.

void rnamldeleteRnaml (rnamlRnaml *rnaml)
 Frees the rnamlRnaml structure.

int rnamlisRnaml (const rnamlObject *obj)
 Tells wheter the object is a rnamlRnaml.

int rnamlequalsRnaml (const rnamlRnaml *left, const rnamlRnaml *right)
 Tells if left and right are equals.

const char * rnamlgetRnamlVersion (const rnamlRnaml *rnaml)
 Gets the rnaml version.

void rnamlsetRnamlVersion (rnamlRnaml *rnaml, const char *version)
 Sets the rnaml version.

xmlcpgListrnamlgetRnamlChildren (rnamlRnaml *rnaml)
 Gets the rnaml children collection.

void rnamladdRnamlChild (rnamlRnaml *rnaml, rnamlObject *child)
 Adds a child into a rnaml.

xmlcpgObjectrnamltoXMLRnaml (const rnamlRnaml *rnaml)
 Translates the rnamlRnaml structure into a xmlcpgElement conforming to the RNAML standard.

xmlcpgDocumentrnamltoXMLDocument (const rnamlRnaml *rnaml)
 Translates the rnamlRnaml structure into a xmlcpgDocument.

xmlcpgPrologrnamlbuildProlog ()
 Builds the document prolog.

void rnamlinit ()
 Initializes the library; it puts the GERTable, the UEMTable and the validator structure into the staticDTDTable.


Typedef Documentation

typedef struct rnamlRNAML rnamlRnaml
 

Rnaml structure containing the rnaml informations.


Function Documentation

void rnamladdRnamlChild rnamlRnaml   rnaml,
rnamlObject   child
 

Adds a child into a rnaml.

Parameters:
rnaml  the rnamlRnaml structure.
child  the rnamlObject structure.

xmlcpgProlog* rnamlbuildProlog  
 

Builds the document prolog.

Returns:
a new xmlcpg structure containing the prolog.

rnamlRnaml* rnamlcloneRnaml const rnamlRnaml   rnaml
 

Clones a rnamlRnaml structure.

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

void rnamldeleteRnaml rnamlRnaml   rnaml
 

Frees the rnamlRnaml structure.

Parameters:
rnaml  the rnamlRnaml structure to free.

int rnamlequalsRnaml const rnamlRnaml   left,
const rnamlRnaml   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* rnamlgetRnamlChildren rnamlRnaml   rnaml
 

Gets the rnaml children collection.

Parameters:
rnaml  the rnamlRnaml structure.
Returns:
the rnaml children collection list.

const char* rnamlgetRnamlVersion const rnamlRnaml   rnaml
 

Gets the rnaml version.

Parameters:
rnaml  the rnamlRnaml structure.
Returns:
the rnaml version string or NULL if rnaml is NULL or not an rnamlRnaml.

void rnamlinit  
 

Initializes the library; it puts the GERTable, the UEMTable and the validator structure into the staticDTDTable.

int rnamlisRnaml const rnamlObject   obj
 

Tells wheter the object is a rnamlRnaml.

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

rnamlRnaml* rnamlnewRnaml  
 

Creates a new rnamlRnaml structure.

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

void rnamlsetRnamlVersion rnamlRnaml   rnaml,
const char *    version
 

Sets the rnaml version.

The previous rnaml version is freed and a copy of version is generated.

Parameters:
rnaml  the rnamlRnaml structure.
version  the rnaml version.

xmlcpgDocument* rnamltoXMLDocument const rnamlRnaml   rnaml
 

Translates the rnamlRnaml structure into a xmlcpgDocument.

Parameters:
rnaml  the rnamlRnaml structure to translate.
Returns:
the xmlcpgDocument or NULL if rnaml is NULL or rnaml is not a rnamlRnaml.

xmlcpgObject* rnamltoXMLRnaml const rnamlRnaml   rnaml
 

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

Parameters:
rnaml  the rnamlRnaml 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