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

taxonomy.h File Reference

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

Go to the source code of this file.

Typedefs

typedef rnamlTAXONOMY rnamlTaxonomy
 Rnaml structure containing the taxonomy informations.


Functions

rnamlTaxonomyrnamlnewTaxonomy ()
 Creates a new rnamlTaxonomy structure.

rnamlTaxonomyrnamlcloneTaxonomy (const rnamlTaxonomy *taxonomy)
 Clones a rnamlTaxonomy struture.

void rnamldeleteTaxonomy (rnamlTaxonomy *taxonomy)
 Frees the rnamlTaxonomy structure.

int rnamlisTaxonomy (const rnamlObject *obj)
 Tells wheter the object is a rnamlTaxonomy.

int rnamlequalsTaxonomy (const rnamlTaxonomy *left, const rnamlTaxonomy *right)
 Tells if left and right are equals.

const char * rnamlgetTaxonomyDomain (const rnamlTaxonomy *taxonomy)
 Gets the domain from the taxonomy.

void rnamlsetTaxonomyDomain (rnamlTaxonomy *taxonomy, const char *domain)
 Sets the taxonomy domain.

const char * rnamlgetTaxonomyKingdom (const rnamlTaxonomy *taxonomy)
 Gets the kingdom from the taxonomy.

void rnamlsetTaxonomyKingdom (rnamlTaxonomy *taxonomy, const char *kingdom)
 Sets the taxonomy kingdom.

const char * rnamlgetTaxonomyPhylum (const rnamlTaxonomy *taxonomy)
 Gets the phylum from the taxonomy.

void rnamlsetTaxonomyPhylum (rnamlTaxonomy *taxonomy, const char *phylum)
 Sets the taxonomy phylum.

const char * rnamlgetTaxonomyClass (const rnamlTaxonomy *taxonomy)
 Gets the class from the taxonomy.

void rnamlsetTaxonomyClass (rnamlTaxonomy *taxonomy, const char *clazz)
 Sets the taxonomy class.

const char * rnamlgetTaxonomyOrder (const rnamlTaxonomy *taxonomy)
 Gets the order from the taxonomy.

void rnamlsetTaxonomyOrder (rnamlTaxonomy *taxonomy, const char *order)
 Sets the taxonomy order.

const char * rnamlgetTaxonomyFamily (const rnamlTaxonomy *taxonomy)
 Gets the family from the taxonomy.

void rnamlsetTaxonomyFamily (rnamlTaxonomy *taxonomy, const char *family)
 Sets the taxonomy family.

const char * rnamlgetTaxonomyGenus (const rnamlTaxonomy *taxonomy)
 Gets the genus from the taxonomy.

void rnamlsetTaxonomyGenus (rnamlTaxonomy *taxonomy, const char *genus)
 Sets the taxonomy genus.

const char * rnamlgetTaxonomySpecies (const rnamlTaxonomy *taxonomy)
 Gets the species from the taxonomy.

void rnamlsetTaxonomySpecies (rnamlTaxonomy *taxonomy, const char *species)
 Sets the taxonomy species.

const char * rnamlgetTaxonomyStrain (const rnamlTaxonomy *taxonomy)
 Gets the strain from the taxonomy.

void rnamlsetTaxonomyStrain (rnamlTaxonomy *taxonomy, const char *strain)
 Sets the taxonomy strain.

xmlcpgObjectrnamltoXMLTaxonomy (const rnamlTaxonomy *taxonomy)
 Translates the rnamlTaxonomy structure into a xmlcpgElement conforming to the RNAML standard.


Typedef Documentation

typedef struct rnamlTAXONOMY rnamlTaxonomy
 

Rnaml structure containing the taxonomy informations.


Function Documentation

rnamlTaxonomy* rnamlcloneTaxonomy const rnamlTaxonomy   taxonomy
 

Clones a rnamlTaxonomy struture.

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

void rnamldeleteTaxonomy rnamlTaxonomy   taxonomy
 

Frees the rnamlTaxonomy structure.

Parameters:
taxonomy  the rnamlTaxonomy structure to free.

int rnamlequalsTaxonomy const rnamlTaxonomy   left,
const rnamlTaxonomy   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* rnamlgetTaxonomyClass const rnamlTaxonomy   taxonomy
 

Gets the class from the taxonomy.

Parameters:
taxonomy  the rnamlTaxonomy structure.
Returns:
the taxonomy class string or NULL if taxonomy is NULL or not an rnamlTaxonomy.

const char* rnamlgetTaxonomyDomain const rnamlTaxonomy   taxonomy
 

Gets the domain from the taxonomy.

Parameters:
taxonomy  the rnamlTaxonomy structure.
Returns:
the taxonomy domain string or NULL if taxonomy is NULL or not an rnamlTaxonomy.

const char* rnamlgetTaxonomyFamily const rnamlTaxonomy   taxonomy
 

Gets the family from the taxonomy.

Parameters:
taxonomy  the rnamlTaxonomy structure.
Returns:
the taxonomy family string or NULL if taxonomy is NULL or not an rnamlTaxonomy.

const char* rnamlgetTaxonomyGenus const rnamlTaxonomy   taxonomy
 

Gets the genus from the taxonomy.

Parameters:
taxonomy  the rnamlTaxonomy structure.
Returns:
the taxonomy genus string or NULL if taxonomy is NULL or not an rnamlTaxonomy.

const char* rnamlgetTaxonomyKingdom const rnamlTaxonomy   taxonomy
 

Gets the kingdom from the taxonomy.

Parameters:
taxonomy  the rnamlTaxonomy structure.
Returns:
the taxonomy kingdom string or NULL if taxonomy is NULL or not an rnamlTaxonomy.

const char* rnamlgetTaxonomyOrder const rnamlTaxonomy   taxonomy
 

Gets the order from the taxonomy.

Parameters:
taxonomy  the rnamlTaxonomy structure.
Returns:
the taxonomy order string or NULL if taxonomy is NULL or not an rnamlTaxonomy.

const char* rnamlgetTaxonomyPhylum const rnamlTaxonomy   taxonomy
 

Gets the phylum from the taxonomy.

Parameters:
taxonomy  the rnamlTaxonomy structure.
Returns:
the taxonomy phylum string or NULL if taxonomy is NULL or not an rnamlTaxonomy.

const char* rnamlgetTaxonomySpecies const rnamlTaxonomy   taxonomy
 

Gets the species from the taxonomy.

Parameters:
taxonomy  the rnamlTaxonomy structure.
Returns:
the taxonomy species string or NULL if taxonomy is NULL or not an rnamlTaxonomy.

const char* rnamlgetTaxonomyStrain const rnamlTaxonomy   taxonomy
 

Gets the strain from the taxonomy.

Parameters:
taxonomy  the rnamlTaxonomy structure.
Returns:
the taxonomy strain string or NULL if taxonomy is NULL or not an rnamlTaxonomy.

int rnamlisTaxonomy const rnamlObject   obj
 

Tells wheter the object is a rnamlTaxonomy.

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

rnamlTaxonomy* rnamlnewTaxonomy  
 

Creates a new rnamlTaxonomy structure.

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

void rnamlsetTaxonomyClass rnamlTaxonomy   taxonomy,
const char *    clazz
 

Sets the taxonomy class.

The previous taxonomy class is freed and a copy of class is generated.

Parameters:
taxonomy  the rnamlTaxonomy structure.
clazz  the taxonomy class.

void rnamlsetTaxonomyDomain rnamlTaxonomy   taxonomy,
const char *    domain
 

Sets the taxonomy domain.

The previous taxonomy domain is freed and a copy of domain is generated.

Parameters:
taxonomy  the rnamlTaxonomy structure.
domain  the taxonomy domain.

void rnamlsetTaxonomyFamily rnamlTaxonomy   taxonomy,
const char *    family
 

Sets the taxonomy family.

The previous taxonomy family is freed and a copy of family is generated.

Parameters:
taxonomy  the rnamlTaxonomy structure.
family  the taxonomy family.

void rnamlsetTaxonomyGenus rnamlTaxonomy   taxonomy,
const char *    genus
 

Sets the taxonomy genus.

The previous taxonomy genus is freed and a copy of genus is generated.

Parameters:
taxonomy  the rnamlTaxonomy structure.
genus  the taxonomy genus.

void rnamlsetTaxonomyKingdom rnamlTaxonomy   taxonomy,
const char *    kingdom
 

Sets the taxonomy kingdom.

The previous taxonomy kingdom is freed and a copy of kingdom is generated.

Parameters:
taxonomy  the rnamlTaxonomy structure.
kingdom  the taxonomy kingdom.

void rnamlsetTaxonomyOrder rnamlTaxonomy   taxonomy,
const char *    order
 

Sets the taxonomy order.

The previous taxonomy order is freed and a copy of order is generated.

Parameters:
taxonomy  the rnamlTaxonomy structure.
order  the taxonomy order.

void rnamlsetTaxonomyPhylum rnamlTaxonomy   taxonomy,
const char *    phylum
 

Sets the taxonomy phylum.

The previous taxonomy phylum is freed and a copy of phylum is generated.

Parameters:
taxonomy  the rnamlTaxonomy structure.
phylum  the taxonomy phylum.

void rnamlsetTaxonomySpecies rnamlTaxonomy   taxonomy,
const char *    species
 

Sets the taxonomy species.

The previous taxonomy species is freed and a copy of species is generated.

Parameters:
taxonomy  the rnamlTaxonomy structure.
species  the taxonomy species.

void rnamlsetTaxonomyStrain rnamlTaxonomy   taxonomy,
const char *    strain
 

Sets the taxonomy strain.

The previous taxonomy strain is freed and a copy of strain is generated.

Parameters:
taxonomy  the rnamlTaxonomy structure.
strain  the taxonomy strain.

xmlcpgObject* rnamltoXMLTaxonomy const rnamlTaxonomy   taxonomy
 

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

Parameters:
molecule  the rnamlTaxonomy 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