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

title.h File Reference

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

Go to the source code of this file.

Typedefs

typedef rnamlTITLE rnamlTitle
 Rnaml structure containing the title informations.


Functions

rnamlTitlernamlnewTitle ()
 Creates a new rnamlTitle structure.

rnamlTitlernamlcloneTitle (const rnamlTitle *title)
 Clones a rnamlTitle struture.

void rnamldeleteTitle (rnamlTitle *title)
 Frees the rnamlTitle structure.

int rnamlisTitle (const rnamlObject *obj)
 Tells wheter the object is a rnamlTitle.

int rnamlequalsTitle (const rnamlTitle *left, const rnamlTitle *right)
 Tells if left and right are equals.

const char * rnamlgetTitleValue (const rnamlTitle *title)
 Gets the value title.

void rnamlsetTitleValue (rnamlTitle *title, const char *value)
 Sets the title value.

xmlcpgObjectrnamltoXMLTitle (const rnamlTitle *title)
 Translates the rnamlTitle structure into a xmlcpgElement conforming to the RNAML standard.


Typedef Documentation

typedef struct rnamlTITLE rnamlTitle
 

Rnaml structure containing the title informations.


Function Documentation

rnamlTitle* rnamlcloneTitle const rnamlTitle   title
 

Clones a rnamlTitle struture.

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

void rnamldeleteTitle rnamlTitle   title
 

Frees the rnamlTitle structure.

Parameters:
title  the rnamlTitle structure to free.

int rnamlequalsTitle const rnamlTitle   left,
const rnamlTitle   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* rnamlgetTitleValue const rnamlTitle   title
 

Gets the value title.

Parameters:
title  the rnamlTitle structure.
Returns:
the title value string or NULL if title is NULL or not an rnamlTitle.

int rnamlisTitle const rnamlObject   obj
 

Tells wheter the object is a rnamlTitle.

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

rnamlTitle* rnamlnewTitle  
 

Creates a new rnamlTitle structure.

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

void rnamlsetTitleValue rnamlTitle   title,
const char *    value
 

Sets the title value.

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

Parameters:
title  the rnamlTitle structure.
value  the title value.

xmlcpgObject* rnamltoXMLTitle const rnamlTitle   title
 

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

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


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