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

file.h File Reference

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

Go to the source code of this file.

Typedefs

typedef rnamlFILE rnamlFile
 Rnaml structure containing the file informations.


Functions

rnamlFilernamlnewFile ()
 Creates a new rnamlFile structure.

rnamlFilernamlcloneFile (const rnamlFile *file)
 Clones a rnamlFile struture.

void rnamldeleteFile (rnamlFile *file)
 Frees the rnamlFile structure.

int rnamlisFile (const rnamlObject *obj)
 Tells wheter the object is a rnamlFile.

int rnamlequalsFile (const rnamlFile *left, const rnamlFile *right)
 Tells if left and right are equals.

const char * rnamlgetFileValue (const rnamlFile *file)
 Gets the value file.

void rnamlsetFileValue (rnamlFile *file, const char *value)
 Sets the file value.

xmlcpgObjectrnamltoXMLFile (const rnamlFile *file)
 Translates the rnamlFile structure into a xmlcpgElement conforming to the RNAML standard.


Typedef Documentation

typedef struct rnamlFILE rnamlFile
 

Rnaml structure containing the file informations.


Function Documentation

rnamlFile* rnamlcloneFile const rnamlFile   file
 

Clones a rnamlFile struture.

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

void rnamldeleteFile rnamlFile   file
 

Frees the rnamlFile structure.

Parameters:
file  the rnamlFile structure to free.

int rnamlequalsFile const rnamlFile   left,
const rnamlFile   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.

const char* rnamlgetFileValue const rnamlFile   file
 

Gets the value file.

Parameters:
file  the rnamlFile structure.
Returns:
the file value string or NULL if file is NULL or not an rnamlFile.

int rnamlisFile const rnamlObject   obj
 

Tells wheter the object is a rnamlFile.

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

rnamlFile* rnamlnewFile  
 

Creates a new rnamlFile structure.

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

void rnamlsetFileValue rnamlFile   file,
const char *    value
 

Sets the file value.

The previous file value is freed and a copy of value is generated.

Parameters:
file  the rnamlFile structure.
value  the file value.

xmlcpgObject* rnamltoXMLFile const rnamlFile   file
 

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

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


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