libSBML C API  5.18.0
CompartmentGlyph_t Class Reference

Detailed Description

layout A glyph for an SBML compartment.

Public Member Functions

CompartmentGlyph_tCompartmentGlyph_clone (const CompartmentGlyph_t *cg)
 
CompartmentGlyph_tCompartmentGlyph_create ()
 Creates a new CompartmentGlyph_t and returns the pointer to it. More...
 
CompartmentGlyph_tCompartmentGlyph_createFrom (const CompartmentGlyph_t *temp)
 Creates a new CompartmentGlyph_t from a template. More...
 
CompartmentGlyph_tCompartmentGlyph_createWith (const char *sid)
 Creates a new CompartmentGlyph_t with the given sid. More...
 
CompartmentGlyph_tCompartmentGlyph_createWithCompartmentId (const char *sid, const char *compId)
 Creates a new CompartmentGlyph_t with the given sid. More...
 
void CompartmentGlyph_free (CompartmentGlyph_t *cg)
 Frees the memory taken by the given compartment glyph. More...
 
const char * CompartmentGlyph_getCompartmentId (const CompartmentGlyph_t *cg)
 Gets the reference compartments id for the given compartment glyph. More...
 
double CompartmentGlyph_getOrder (const CompartmentGlyph_t *cg)
 Returns the compartment order. More...
 
void CompartmentGlyph_initDefaults (CompartmentGlyph_t *cg)
 Calls initDefaults from GraphicalObject_t. More...
 
int CompartmentGlyph_isSetCompartmentId (const CompartmentGlyph_t *cg)
 Returns 0 (false) if the reference compartment has not been set for this glyph and 1 (true) otherwise. More...
 
int CompartmentGlyph_isSetOrder (const CompartmentGlyph_t *cg)
 Returns 1 (true) if the compartment order has been set. More...
 
void CompartmentGlyph_setCompartmentId (CompartmentGlyph_t *cg, const char *id)
 Sets the reference compartment for the compartment glyph. More...
 
int CompartmentGlyph_setOrder (CompartmentGlyph_t *cg, double order)
 Sets the compartment order. More...
 
int CompartmentGlyph_unsetOrder (CompartmentGlyph_t *cg)
 Sets the compartment order. More...
 

Member Function Documentation

CompartmentGlyph_t * CompartmentGlyph_clone ( const CompartmentGlyph_t cg)
Returns
a (deep) copy of this CompartmentGlyph_t.
Parameters
cgthe CompartmentGlyph_t structure.
CompartmentGlyph_t * CompartmentGlyph_create ( )

Creates a new CompartmentGlyph_t and returns the pointer to it.

CompartmentGlyph_t * CompartmentGlyph_createFrom ( const CompartmentGlyph_t temp)

Creates a new CompartmentGlyph_t from a template.

Parameters
tempthe CompartmentGlyph_t structure to copy.
CompartmentGlyph_t * CompartmentGlyph_createWith ( const char *  sid)

Creates a new CompartmentGlyph_t with the given sid.

Parameters
sidthe id of the created CompartmentGlyph_t.
CompartmentGlyph_t * CompartmentGlyph_createWithCompartmentId ( const char *  sid,
const char *  compId 
)

Creates a new CompartmentGlyph_t with the given sid.

Parameters
sidthe id of the created CompartmentGlyph_t.
compIdthe compartment id of the created CompartmentGlyph_t.
void CompartmentGlyph_free ( CompartmentGlyph_t cg)

Frees the memory taken by the given compartment glyph.

Parameters
cgthe CompartmentGlyph_t structure.
const char * CompartmentGlyph_getCompartmentId ( const CompartmentGlyph_t cg)

Gets the reference compartments id for the given compartment glyph.

Parameters
cgthe CompartmentGlyph_t structure.
double CompartmentGlyph_getOrder ( const CompartmentGlyph_t cg)

Returns the compartment order.

Parameters
cgthe CompartmentGlyph_t structure.
void CompartmentGlyph_initDefaults ( CompartmentGlyph_t cg)

Calls initDefaults from GraphicalObject_t.

Parameters
cgthe CompartmentGlyph_t structure.
int CompartmentGlyph_isSetCompartmentId ( const CompartmentGlyph_t cg)

Returns 0 (false) if the reference compartment has not been set for this glyph and 1 (true) otherwise.

Parameters
cgthe CompartmentGlyph_t structure.
int CompartmentGlyph_isSetOrder ( const CompartmentGlyph_t cg)

Returns 1 (true) if the compartment order has been set.

Parameters
cgthe CompartmentGlyph_t structure.
void CompartmentGlyph_setCompartmentId ( CompartmentGlyph_t cg,
const char *  id 
)

Sets the reference compartment for the compartment glyph.

Parameters
cgthe CompartmentGlyph_t structure.
idthe string to use as the compartment id.
int CompartmentGlyph_setOrder ( CompartmentGlyph_t cg,
double  order 
)

Sets the compartment order.

Parameters
cgthe CompartmentGlyph_t structure.
orderthe value to use as the order of the CompartmentGlyph_t.
int CompartmentGlyph_unsetOrder ( CompartmentGlyph_t cg)

Sets the compartment order.

Parameters
cgthe CompartmentGlyph_t structure.