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

person.h File Reference

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

Go to the source code of this file.

Typedefs

typedef rnamlPERSON rnamlPerson
 Rnaml structure containing the person informations.


Functions

rnamlPersonrnamlnewPerson ()
 Creates a new rnamlPerson structure.

rnamlPersonrnamlclonePerson (const rnamlPerson *person)
 Clones a rnamlPerson struture.

void rnamldeletePerson (rnamlPerson *person)
 Frees the rnamlPerson structure.

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

int rnamlequalsPerson (const rnamlPerson *left, const rnamlPerson *right)
 Tells if left and right are equals.

const char * rnamlgetPersonFirstName (const rnamlPerson *person)
 Gets the firstName from the person.

void rnamlsetPersonFirstName (rnamlPerson *person, const char *firstName)
 Sets the person firstName.

const char * rnamlgetPersonLastName (const rnamlPerson *person)
 Gets the lastName from the person.

void rnamlsetPersonLastName (rnamlPerson *person, const char *lastName)
 Sets the person lastName.

void rnamladdPersonAffiliation (rnamlPerson *person, rnamlAffiliation *affiliation)
 Adds a affiliation into a person.

xmlcpgListrnamlgetPersonAffiliations (rnamlPerson *person)
 Gets the person's affiliation list.

xmlcpgObjectrnamltoXMLPerson (const rnamlPerson *person)
 Translates the rnamlPerson structure into a xmlcpgElement conforming to the RNAML standard.


Typedef Documentation

typedef struct rnamlPERSON rnamlPerson
 

Rnaml structure containing the person informations.


Function Documentation

void rnamladdPersonAffiliation rnamlPerson   person,
rnamlAffiliation   affiliation
 

Adds a affiliation into a person.

Parameters:
person  the rnamlPerson structure.
affiliation  the rnamlAffiliation structure.

rnamlPerson* rnamlclonePerson const rnamlPerson   person
 

Clones a rnamlPerson struture.

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

void rnamldeletePerson rnamlPerson   person
 

Frees the rnamlPerson structure.

Parameters:
person  the rnamlPerson structure to free.

int rnamlequalsPerson const rnamlPerson   left,
const rnamlPerson   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* rnamlgetPersonAffiliations rnamlPerson   person
 

Gets the person's affiliation list.

Parameters:
person  the rnamlPerson structure.
Returns:
the person's affiliation xmlcpgList or NULL if something goes wrong.

const char* rnamlgetPersonFirstName const rnamlPerson   person
 

Gets the firstName from the person.

Parameters:
person  the rnamlPerson structure.
Returns:
the person firstName string or NULL if person is NULL or not an rnamlPerson.

const char* rnamlgetPersonLastName const rnamlPerson   person
 

Gets the lastName from the person.

Parameters:
person  the rnamlPerson structure.
Returns:
the person lastName string or NULL if person is NULL or not an rnamlPerson.

int rnamlisPerson const rnamlObject   obj
 

Tells wheter the object is a rnamlPerson.

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

rnamlPerson* rnamlnewPerson  
 

Creates a new rnamlPerson structure.

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

void rnamlsetPersonFirstName rnamlPerson   person,
const char *    firstName
 

Sets the person firstName.

The previous person firstName is freed and a copy of firstName is generated.

Parameters:
person  the rnamlPerson structure.
firstName  the person firstName.

void rnamlsetPersonLastName rnamlPerson   person,
const char *    lastName
 

Sets the person lastName.

The previous person lastName is freed and a copy of lastName is generated.

Parameters:
person  the rnamlPerson structure.
lastName  the person lastName.

xmlcpgObject* rnamltoXMLPerson const rnamlPerson   person
 

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

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


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