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

object.h File Reference

#include "xmlcpg.h"

Go to the source code of this file.

Compounds

struct  rnamlOBJECT

Typedefs

typedef rnamlOBJECT rnamlObject

Enumerations

enum  rnamlObjectTag {
  rnamlaffiliation, rnamlalignment, rnamlalignmentid, rnamlalisequence,
  rnamlanalysis, rnamlatom, rnamlauthor, rnamlbase,
  rnamlbaseconformation, rnamlbaseid, rnamlbaseid5p, rnamlbaseid3p,
  rnamlbasepair, rnamlbasepairid, rnamlbasestack, rnamlbasetorsionangles,
  rnamlbooktitle, rnamlconsensusmolecule, rnamldatabaseentry, rnamldate,
  rnamldistanceconstraint, rnamleditor, rnamlfreeenergy, rnamlfile,
  rnamlhelix, rnamlhelixid, rnamlidentity, rnamlinteractions,
  rnamlissue, rnamljournal, rnamlmethod, rnamlmodel,
  rnamlmodelid, rnamlmodelinfo, rnamlmodification, rnamlmolecule,
  rnamlmoleculeclass, rnamlmoleculeid, rnamlnumberingrange, rnamlnumberingsystem,
  rnamlnumberingtable, rnamlpages, rnamlpath, rnamlobject,
  rnamlrnaml, rnamlperson, rnamlprogname, rnamlprogram,
  rnamlprogversion, rnamlpseudoknot, rnamlpubmedid, rnamlreference,
  rnamlresolution, rnamlrevision, rnamlsecondarystructuredisplay, rnamlsegment,
  rnamlseqannotation, rnamlseqdata, rnamlsequence, rnamlsinglestrand,
  rnamlssbasecoord, rnamlstrannotation, rnamlstructure, rnamlsurfaceconstraint,
  rnamltaxonomy, rnamltitle, rnamlurl, rnamlvolume,
  rnamlbasetriple, rnamlpcdata, rnamlunmarshaller, rnamlmarshaller,
  rnamllength, rnamlend
}

Functions

void rnamlinitObject (rnamlObject *obj)
 Initializes the object fields.

rnamlObjectrnamlclone (const rnamlObject *obj)
 Clones a rnaml structure.

void rnamldelete (rnamlObject *obj)
 Frees the rnaml structure.

void rnamldeleteObject (rnamlObject *obj)
 Frees the rnamlObject content, it's space is not freed.

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

rnamlObjectrnamlassignObject (rnamlObject *left, const rnamlObject *right)
 Assigns a the right's content to the left one.

int rnamlequalsObject (const rnamlObject *left, const rnamlObject *right)
 Tells if left and right are equals.

int rnamlequals (const rnamlObject *left, const rnamlObject *right)
 Tells if left and right are equals.

const char * rnamlgetObjectComment (const rnamlObject *obj)
 Gets the object comment.

void rnamlsetObjectComment (rnamlObject *obj, const char *comment)
 Sets the object comment.

void rnamladdObjectReferenceId (rnamlObject *obj, const char *referenceId)
 Adds a reference id into the object.

xmlcpgListrnamlgetObjectReferenceIds (rnamlObject *obj)
 Gets the reference ids.

char * rnamlgetObjectReferenceIdsString (const rnamlObject *obj)
 Gets the reference ids in a string.

void rnamladdObjectAnalysisId (rnamlObject *obj, const char *analysisId)
 Adds a analysis id into the object.

xmlcpgListrnamlgetObjectAnalysisIds (rnamlObject *obj)
 Gets the analysis ids.

char * rnamlgetObjectAnalysisIdsString (const rnamlObject *obj)
 Gets the analysis ids in a string.

void rnamladdObjectDatabaseId (rnamlObject *obj, const char *databaseId)
 Adds a database id into the object.

xmlcpgListrnamlgetObjectDatabaseIds (rnamlObject *obj)
 Gets the database ids.

char * rnamlgetObjectDatabaseIdsString (const rnamlObject *obj)
 Gets the database ids in a string.

void rnamltoXMLObjectAttributes (const rnamlObject *obj, xmlcpgElement *element)
 Inserts the attributes into a xmlcpgElement.

xmlcpgObjectrnamltoXML (const rnamlObject *obj)
 Translates the rnaml object structure into a xmlcpgElement conforming to the RNAML standard.


Typedef Documentation

typedef struct rnamlOBJECT rnamlObject
 


Enumeration Type Documentation

enum rnamlObjectTag
 

Enumeration values:
rnamlaffiliation 
rnamlalignment 
rnamlalignmentid 
rnamlalisequence 
rnamlanalysis 
rnamlatom 
rnamlauthor 
rnamlbase 
rnamlbaseconformation 
rnamlbaseid 
rnamlbaseid5p 
rnamlbaseid3p 
rnamlbasepair 
rnamlbasepairid 
rnamlbasestack 
rnamlbasetorsionangles 
rnamlbooktitle 
rnamlconsensusmolecule 
rnamldatabaseentry 
rnamldate 
rnamldistanceconstraint 
rnamleditor 
rnamlfreeenergy 
rnamlfile 
rnamlhelix 
rnamlhelixid 
rnamlidentity 
rnamlinteractions 
rnamlissue 
rnamljournal 
rnamlmethod 
rnamlmodel 
rnamlmodelid 
rnamlmodelinfo 
rnamlmodification 
rnamlmolecule 
rnamlmoleculeclass 
rnamlmoleculeid 
rnamlnumberingrange 
rnamlnumberingsystem 
rnamlnumberingtable 
rnamlpages 
rnamlpath 
rnamlobject 
rnamlrnaml 
rnamlperson 
rnamlprogname 
rnamlprogram 
rnamlprogversion 
rnamlpseudoknot 
rnamlpubmedid 
rnamlreference 
rnamlresolution 
rnamlrevision 
rnamlsecondarystructuredisplay 
rnamlsegment 
rnamlseqannotation 
rnamlseqdata 
rnamlsequence 
rnamlsinglestrand 
rnamlssbasecoord 
rnamlstrannotation 
rnamlstructure 
rnamlsurfaceconstraint 
rnamltaxonomy 
rnamltitle 
rnamlurl 
rnamlvolume 
rnamlbasetriple 
rnamlpcdata 
rnamlunmarshaller 
rnamlmarshaller 
rnamllength 
rnamlend 


Function Documentation

void rnamladdObjectAnalysisId rnamlObject   obj,
const char *    analysisId
 

Adds a analysis id into the object.

Parameters:
obj  the rnamlObject structure.
analysisId  the analysis id string.

void rnamladdObjectDatabaseId rnamlObject   obj,
const char *    databaseId
 

Adds a database id into the object.

Parameters:
obj  the rnamlObject structure.
databaseId  the database id string.

void rnamladdObjectReferenceId rnamlObject   obj,
const char *    referenceId
 

Adds a reference id into the object.

Parameters:
obj  the rnamlObject structure.
referenceId  the reference id string.

rnamlObject* rnamlassignObject rnamlObject   left,
const rnamlObject   right
 

Assigns a the right's content to the left one.

Parameters:
left  the left part of the assignment.
right  the right part of the assignment.
Returns:
the the left part of the assignment.

rnamlObject* rnamlclone const rnamlObject   obj
 

Clones a rnaml structure.

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

void rnamldelete rnamlObject   obj
 

Frees the rnaml structure.

Parameters:
obj  the rnamlObject structure to free.

void rnamldeleteObject rnamlObject   obj
 

Frees the rnamlObject content, it's space is not freed.

Parameters:
obj  the rnamlObject structure to delete.

int rnamlequals const rnamlObject   left,
const rnamlObject   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.

int rnamlequalsObject const rnamlObject   left,
const rnamlObject   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* rnamlgetObjectAnalysisIds rnamlObject   obj
 

Gets the analysis ids.

Parameters:
obj  the rnamlObject structure.
Returns:
the analysis ids list or NULL if obj is not a rnamlObject.

char* rnamlgetObjectAnalysisIdsString const rnamlObject   obj
 

Gets the analysis ids in a string.

An empty string is returned if no ids are present.

Parameters:
obj  the rnamlObject structure.
Returns:
the analysis ids string or NULL if obj is not a rnamlObject.

const char* rnamlgetObjectComment const rnamlObject   obj
 

Gets the object comment.

Parameters:
obj  the rnamlObject structure.
Returns:
the object comment string or NULL if obj is NULL or not an rnamlObject.

xmlcpgList* rnamlgetObjectDatabaseIds rnamlObject   obj
 

Gets the database ids.

Parameters:
obj  the rnamlObject structure.
Returns:
the database ids list or NULL if obj is not a rnamlObject.

char* rnamlgetObjectDatabaseIdsString const rnamlObject   obj
 

Gets the database ids in a string.

An empty string is returned if no ids are present.

Parameters:
obj  the rnamlObject structure.
Returns:
the database ids string or NULL if obj is not a rnamlObject.

xmlcpgList* rnamlgetObjectReferenceIds rnamlObject   obj
 

Gets the reference ids.

Parameters:
obj  the rnamlObject structure.
Returns:
the reference ids list or NULL if obj is not a rnamlObject.

char* rnamlgetObjectReferenceIdsString const rnamlObject   obj
 

Gets the reference ids in a string.

An empty string is returned if no ids are present.

Parameters:
obj  the rnamlObject structure.
Returns:
the reference ids string or NULL if obj is not a rnamlObject.

void rnamlinitObject rnamlObject   obj
 

Initializes the object fields.

Parameters:
obj  the object to initialize.

int rnamlisObject const rnamlObject   obj
 

Tells wheter the object is a rnamlObject.

Parameters:
obj  the rnamlObject structure.
Returns:
1 if the object is a rnamlObject, 0 otherwise.

void rnamlsetObjectComment rnamlObject   obj,
const char *    comment
 

Sets the object comment.

The previous object comment is freed and a copy of comment is generated.

Parameters:
obj  the rnamlObject structure.
comment  the object comment string.

xmlcpgObject* rnamltoXML const rnamlObject   obj
 

Translates the rnaml object structure into a xmlcpgElement conforming to the RNAML standard.

Parameters:
obj  the rnamlObject structure to translate.
Returns:
the xmlcpgObject or NULL if something goes wrong.

void rnamltoXMLObjectAttributes const rnamlObject   obj,
xmlcpgElement   element
 

Inserts the attributes into a xmlcpgElement.

Parameters:
obj  the rnamlObject structure.
element  the xmlcpgElement.


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