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

journal.h File Reference

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

Go to the source code of this file.

Typedefs

typedef rnamlJOURNAL rnamlJournal
 Rnaml structure containing the journal informations.


Functions

rnamlJournalrnamlnewJournal ()
 Creates a new rnamlJournal structure.

rnamlJournalrnamlcloneJournal (const rnamlJournal *journal)
 Clones a rnamlJournal struture.

void rnamldeleteJournal (rnamlJournal *journal)
 Frees the rnamlJournal structure.

int rnamlisJournal (const rnamlObject *obj)
 Tells wheter the object is a rnamlJournal.

int rnamlequalsJournal (const rnamlJournal *left, const rnamlJournal *right)
 Tells if left and right are equals.

const char * rnamlgetJournalValue (const rnamlJournal *journal)
 Gets the value journal.

void rnamlsetJournalValue (rnamlJournal *journal, const char *value)
 Sets the journal value.

xmlcpgObjectrnamltoXMLJournal (const rnamlJournal *journal)
 Translates the rnamlJournal structure into a xmlcpgElement conforming to the RNAML standard.


Typedef Documentation

typedef struct rnamlJOURNAL rnamlJournal
 

Rnaml structure containing the journal informations.


Function Documentation

rnamlJournal* rnamlcloneJournal const rnamlJournal   journal
 

Clones a rnamlJournal struture.

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

void rnamldeleteJournal rnamlJournal   journal
 

Frees the rnamlJournal structure.

Parameters:
journal  the rnamlJournal structure to free.

int rnamlequalsJournal const rnamlJournal   left,
const rnamlJournal   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* rnamlgetJournalValue const rnamlJournal   journal
 

Gets the value journal.

Parameters:
journal  the rnamlJournal structure.
Returns:
the journal value string or NULL if journal is NULL or not an rnamlJournal.

int rnamlisJournal const rnamlObject   obj
 

Tells wheter the object is a rnamlJournal.

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

rnamlJournal* rnamlnewJournal  
 

Creates a new rnamlJournal structure.

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

void rnamlsetJournalValue rnamlJournal   journal,
const char *    value
 

Sets the journal value.

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

Parameters:
journal  the rnamlJournal structure.
value  the journal value.

xmlcpgObject* rnamltoXMLJournal const rnamlJournal   journal
 

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

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


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