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

object.c File Reference

#include "object.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "affiliation.h"
#include "alignment.h"
#include "alignmentid.h"
#include "alisequence.h"
#include "atom.h"
#include "analysis.h"
#include "author.h"
#include "base.h"
#include "baseconformation.h"
#include "baseid.h"
#include "baseid5p.h"
#include "baseid3p.h"
#include "basepair.h"
#include "basepairid.h"
#include "basestack.h"
#include "basetorsionangles.h"
#include "basetriple.h"
#include "booktitle.h"
#include "consensusmolecule.h"
#include "databaseentry.h"
#include "date.h"
#include "distanceconstraint.h"
#include "editor.h"
#include "end.h"
#include "file.h"
#include "freeenergy.h"
#include "helix.h"
#include "helixid.h"
#include "identity.h"
#include "interactions.h"
#include "issue.h"
#include "journal.h"
#include "length.h"
#include "marshaller.h"
#include "method.h"
#include "model.h"
#include "modelid.h"
#include "modelinfo.h"
#include "modification.h"
#include "moleculeclass.h"
#include "molecule.h"
#include "moleculeid.h"
#include "numberingrange.h"
#include "numberingsystem.h"
#include "numberingtable.h"
#include "pages.h"
#include "path.h"
#include "pcdata.h"
#include "person.h"
#include "progname.h"
#include "program.h"
#include "progversion.h"
#include "pseudoknot.h"
#include "pubmedid.h"
#include "resolution.h"
#include "revision.h"
#include "rnaml.h"
#include "secondarystructuredisplay.h"
#include "segment.h"
#include "seqannotation.h"
#include "seqdata.h"
#include "singlestrand.h"
#include "ssbasecoord.h"
#include "surfaceconstraint.h"
#include "strannotation.h"
#include "structure.h"
#include "taxonomy.h"
#include "title.h"
#include "unmarshaller.h"
#include "url.h"
#include "volume.h"
#include "reference.h"

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.

char * rnamlidsToString (const xmlcpgList *list)
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.


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.

char* rnamlidsToString const xmlcpgList   list [static]
 

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:50 2003 for xmlcpg by doxygen1.2.18