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

moleculeclass.h File Reference

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

Go to the source code of this file.

Typedefs

typedef rnamlMOLECULECLASS rnamlMoleculeClass
 Rnaml structure containing the moleculeclass informations.


Functions

rnamlMoleculeClassrnamlnewMoleculeClass ()
 Creates a new rnamlMoleculeClass structure.

rnamlMoleculeClassrnamlcloneMoleculeClass (const rnamlMoleculeClass *moleculeclass)
 Clones a rnamlMoleculeClass struture.

void rnamldeleteMoleculeClass (rnamlMoleculeClass *moleculeclass)
 Frees the rnamlMoleculeClass structure.

int rnamlisMoleculeClass (const rnamlObject *obj)
 Tells wheter the object is a rnamlMoleculeClass.

int rnamlequalsMoleculeClass (const rnamlMoleculeClass *left, const rnamlMoleculeClass *right)
 Tells if left and right are equals.

rnamlIdentityrnamlgetMoleculeClassIdentity (rnamlMoleculeClass *moleculeClass)
 Gets the identity from the moleculeClass.

void rnamlsetMoleculeClassIdentity (rnamlMoleculeClass *moleculeClass, rnamlIdentity *identity)
 Sets the moleculeClass identity.

xmlcpgListrnamlgetMoleculeClassChildren (const rnamlMoleculeClass *moleculeClass)
 Gets the child from the moleculeClass collection.

void rnamladdMoleculeClassChild (rnamlMoleculeClass *moleculeClass, rnamlObject *child)
 Adds a moleculeClass child.

xmlcpgObjectrnamltoXMLMoleculeClass (const rnamlMoleculeClass *moleculeClass)
 Translates the rnamlMoleculeClass structure into a xmlcpgElement conforming to the RNAML standard.


Typedef Documentation

typedef struct rnamlMOLECULECLASS rnamlMoleculeClass
 

Rnaml structure containing the moleculeclass informations.


Function Documentation

void rnamladdMoleculeClassChild rnamlMoleculeClass   moleculeClass,
rnamlObject   child
 

Adds a moleculeClass child.

Parameters:
moleculeClass  the rnamlMoleculeClass structure.
child  the rnaml substructure converted into xmlcpgObject.

rnamlMoleculeClass* rnamlcloneMoleculeClass const rnamlMoleculeClass   moleculeclass
 

Clones a rnamlMoleculeClass struture.

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

void rnamldeleteMoleculeClass rnamlMoleculeClass   moleculeclass
 

Frees the rnamlMoleculeClass structure.

Parameters:
moleculeclass  the rnamlMoleculeClass structure to free.

int rnamlequalsMoleculeClass const rnamlMoleculeClass   left,
const rnamlMoleculeClass   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* rnamlgetMoleculeClassChildren const rnamlMoleculeClass   moleculeClass
 

Gets the child from the moleculeClass collection.

Parameters:
moleculeClass  the rnamlMoleculeClass structure.
Returns:
the moleculeClass child collection

rnamlIdentity* rnamlgetMoleculeClassIdentity rnamlMoleculeClass   moleculeClass
 

Gets the identity from the moleculeClass.

Parameters:
moleculeClass  the rnamlMoleculeClass structure.
Returns:
the moleculeClass identity is NULL or if moleculeClass is NULL or not an rnamlMoleculeClass.

int rnamlisMoleculeClass const rnamlObject   obj
 

Tells wheter the object is a rnamlMoleculeClass.

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

rnamlMoleculeClass* rnamlnewMoleculeClass  
 

Creates a new rnamlMoleculeClass structure.

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

void rnamlsetMoleculeClassIdentity rnamlMoleculeClass   moleculeClass,
rnamlIdentity   identity
 

Sets the moleculeClass identity.

The previous identity info is freed

Parameters:
moleculeClass  the rnamlMoleculeClass structure.
moleculeClass  the moleculeClass identity.

xmlcpgObject* rnamltoXMLMoleculeClass const rnamlMoleculeClass   moleculeClass
 

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

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


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