SpeciesGlyph_t Class Reference

Detailed Description

layout A glyph for an SBML species.

In addition to the attributes it inherits from GraphicalObject_t, the SpeciesGlyph_t object has an optional 'species' attribute.

Public Member Functions
SpeciesGlyph_t *	SpeciesGlyph_clone (const SpeciesGlyph_t *sg)
SpeciesGlyph_t *	SpeciesGlyph_create (void)
	Creates a new SpeciesGlyph_t and returns the pointer to it. More...
SpeciesGlyph_t *	SpeciesGlyph_createFrom (const SpeciesGlyph_t *temp)
	Create a new SpeciesGlyph_t structure from a template. More...
SpeciesGlyph_t *	SpeciesGlyph_createWith (const char *sid)
	Creates a new SpeciesGlyph_t with the given id. More...
SpeciesGlyph_t *	SpeciesGlyph_createWithSpeciesId (const char *id, const char *speciesId)
	Creates a new SpeciesGlyph_t referencing with the given id and species id. More...
void	SpeciesGlyph_free (SpeciesGlyph_t *sg)
	Frees the memory taken by the given compartment glyph. More...
const char *	SpeciesGlyph_getSpeciesId (const SpeciesGlyph_t *sg)
	Gets the the id of the associated species. More...
void	SpeciesGlyph_initDefaults (SpeciesGlyph_t *sg)
	Calls initDefaults from GraphicalObject_t. More...
int	SpeciesGlyph_isSetSpeciesId (const SpeciesGlyph_t *sg)
	Returns 0 (false) if the id of the associated species is the empty string, 1 (true) otherwise. More...
void	SpeciesGlyph_setSpeciesId (SpeciesGlyph_t *sg, const char *id)
	Sets the associated species id. More...

Member Function Documentation

SpeciesGlyph_t * SpeciesGlyph_clone

(

const SpeciesGlyph_t *

sg

)

Returns

a (deep) copy of this SpeciesGlyph_t.

Parameters

sg	the SpeciesGlyph_t structure.

SpeciesGlyph_t * SpeciesGlyph_create

(

void

)

Creates a new SpeciesGlyph_t and returns the pointer to it.

SpeciesGlyph_t * SpeciesGlyph_createFrom

(

const SpeciesGlyph_t *

temp

)

Create a new SpeciesGlyph_t structure from a template.

Parameters

temp	the SpeciesGlyph_t structure to copy.

SpeciesGlyph_t * SpeciesGlyph_createWith

(

const char *

sid

)

Creates a new SpeciesGlyph_t with the given id.

Parameters

sid	the id of the created SpeciesGlyph_t.

SpeciesGlyph_t * SpeciesGlyph_createWithSpeciesId	(	const char *	id,
		const char *	speciesId
	)

Creates a new SpeciesGlyph_t referencing with the given id and species id.

Parameters

id	the id of the created SpeciesGlyph_t.
speciesId	the string to use as the species id.

void SpeciesGlyph_free

(

SpeciesGlyph_t *

sg

)

Frees the memory taken by the given compartment glyph.

Parameters

sg	the SpeciesGlyph_t structure.

const char * SpeciesGlyph_getSpeciesId

(

const SpeciesGlyph_t *

sg

)

Gets the the id of the associated species.

Parameters

sg	the SpeciesGlyph_t structure.

void SpeciesGlyph_initDefaults

(

SpeciesGlyph_t *

sg

)

Calls initDefaults from GraphicalObject_t.

Parameters

sg	the SpeciesGlyph_t structure.

int SpeciesGlyph_isSetSpeciesId

(

const SpeciesGlyph_t *

sg

)

Returns 0 (false) if the id of the associated species is the empty string, 1 (true) otherwise.

Parameters

sg	the SpeciesGlyph_t structure.

void SpeciesGlyph_setSpeciesId	(	SpeciesGlyph_t *	sg,
		const char *	id
	)

Sets the associated species id.

Parameters

sg	the SpeciesGlyph_t structure.
id	the string to use as the species id.