libSBML C API  libSBML 5.20.2 C API
Loading...
Searching...
No Matches
Layout.h File Reference

Definition of Layout_t for SBML Layout_t. More...

Include dependency graph for Layout.h:
This graph shows which files directly or indirectly include this file:

Functions

void Layout_addAdditionalGraphicalObject (Layout_t *l, GraphicalObject_t *go)
 _tAdds_t _ta_t _tnew_t _tcopy_t _tof_t @_tp_t _tgo_t _tto_t _tthe_t _tlist_t _tof_t _tadditional_t _tgraphical_t _tobjects_t.
 
void Layout_addCompartmentGlyph (Layout_t *l, CompartmentGlyph_t *cg)
 _tAdds_t _ta_t _tnew_t _tcopy_t _tof_t @_tp_t _tcg_t _tto_t _tthe_t _tlist_t _tof_t _tcompartment_t _tglyphs_t.
 
void Layout_addReactionGlyph (Layout_t *l, ReactionGlyph_t *rg)
 _tAdds_t _ta_t _tnew_t _tcopy_t _tof_t @_tp_t _trg_t _tto_t _tthe_t _tlist_t _tof_t _treaction_t _tglyphs_t.
 
void Layout_addSpeciesGlyph (Layout_t *l, SpeciesGlyph_t *sg)
 _tAdds_t _ta_t _tnew_t _tcopy_t _tof_t @_tp_t _tsg_t _tto_t _tthe_t _tlist_t _tof_t _tspecies_t _tglyphs_t.
 
void Layout_addTextGlyph (Layout_t *l, TextGlyph_t *tg)
 _tAdds_t _ta_t _tnew_t _tcopy_t _tof_t @_tp_t _ttg_t _tto_t _tthe_t _tlist_t _tof_t _ttext_t _tglyphs_t.
 
Layout_tLayout_clone (const Layout_t *l)
 @_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthis_t _tLayout_t_t.
 
Layout_tLayout_create (void)
 _tCreates_t _ta_t _tnew_t _tLayout_t_t _twith_t _tthe_t _tdefault_t _tSBML_t _tlevel_t, _tversion_t, _tand_t _tpackage_t _tversion_t, _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
GraphicalObject_tLayout_createAdditionalGraphicalObject (Layout_t *l)
 _tCreates_t _ta_t _tGraphicalObject_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthe_t _tend_t _tof_t _tthe_t _tadditional_t _tgraphical_t _tobjects_t _tlist_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tstructure_t.
 
CompartmentGlyph_tLayout_createCompartmentGlyph (Layout_t *l)
 _tCreates_t _ta_t _tComparmentGlyph_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthe_t _tend_t _tof_t _tthe_t _tcompartment_t _tglyphs_t _tlist_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tstructure_t.
 
Layout_tLayout_createFrom (const Layout_t *temp)
 _tCreates_t _ta_t _tclone_t _tof_t @_tp_t _ttemp_t, _tor_t _tan_t _tempty_t _tLayout_t_t _tstructure_t _tif_t @_tp_t _ttemp_t _tis_t @_tc_t _tNULL_t.
 
GeneralGlyph_tLayout_createGeneralGlyph (Layout_t *l)
 _tCreates_t _ta_t _tGeneralGlyph_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthe_t _tend_t _tof_t _tthe_t _tadditional_t _tobjects_t _tlist_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tstructure_t.
 
ReactionGlyph_tLayout_createReactionGlyph (Layout_t *l)
 _tCreates_t _ta_t _tReactionGlyph_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthe_t _tend_t _tof_t _tthe_t _treaction_t _tglyphs_t _tlist_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tstructure_t.
 
SpeciesGlyph_tLayout_createSpeciesGlyph (Layout_t *l)
 _tCreates_t _ta_t _tSpeciesGlyph_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthe_t _tend_t _tof_t _tthe_t _tspecies_t _tglyphs_t _tlist_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tstructure_t.
 
TextGlyph_tLayout_createTextGlyph (Layout_t *l)
 _tCreates_t _ta_t _tTextGlyph_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthe_t _tend_t _tof_t _tthe_t _ttext_t _tglyphs_t _tlist_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tstructure_t.
 
Layout_tLayout_createWith (const char *sid)
 _tCreates_t _ta_t _tnew_t _tLayout_t_t _twith_t _tthe_t _tdefault_t _tSBML_t _tlevel_t, _tversion_t, _tand_t _tpackage_t _tversion_t, _tand_t _twith_t _tthe_t _tgiven_t @_tp_t _tid_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
Layout_tLayout_createWithDimensions (const char *sid, const Dimensions_t *dimensions)
 _tCreates_t _ta_t _tnew_t _tLayout_t_t _twith_t _tthe_t _tdefault_t _tSBML_t _tlevel_t, _tversion_t, _tand_t _tpackage_t _tversion_t, _tand_t _twith_t _tthe_t _tgiven_t _tDimensions_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
Layout_tLayout_createWithSize (const char *sid, double width, double height, double depth)
 _tCreates_t _ta_t _tnew_t _tLayout_t_t _twith_t _tthe_t _tdefault_t _tSBML_t _tlevel_t, _tversion_t, _tand_t _tpackage_t _tversion_t, _tand_t _twith_t _tthe_t _tgiven_t _twidth_t, _theight_t _tand_t _tdepth_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
void Layout_free (Layout_t *l)
 _tFrees_t _tthe_t _tmemory_t _tfor_t _tthe_t _tgiven_t _tlayout_t.
 
GraphicalObject_tLayout_getAdditionalGraphicalObject (Layout_t *l, unsigned int index)
 _tReturns_t _ta_t _tpointer_t _tto_t _tthe_t _tAdditionalGraphicalObject_t_t _twith_t _tthe_t _tgiven_t _tindex_t.
 
CompartmentGlyph_tLayout_getCompartmentGlyph (Layout_t *l, unsigned int index)
 _tReturns_t _ta_t _tpointer_t _tto_t _tthe_t _tCompartmentGlyph_t_t _twith_t _tthe_t _tgiven_t _tindex_t.
 
Dimensions_tLayout_getDimensions (Layout_t *l)
 _tReturns_t _ta_t _tDimensions_t_t _tpointer_t _tfrom_t _tthe_t _tlayout_t.
 
const char * Layout_getId (const Layout_t *l)
 _tReturns_t _tthe_t _tid_t
 
ListOf_tLayout_getListOfAdditionalGraphicalObjects (Layout_t *l)
 _tReturns_t _ta_t _tpointer_t _tto_t _tthe_t _tlist_t _tof_t _tadditional_t _tGraphicalObjects_t.
 
ListOf_tLayout_getListOfCompartmentGlyphs (Layout_t *l)
 _tReturns_t _ta_t _tpointer_t _tto_t _tthe_t _tlist_t _tof_t _tCompartmentGlyph_t_t'_ts_t.
 
ListOf_tLayout_getListOfReactionGlyphs (Layout_t *l)
 _tReturns_t _ta_t _tpointer_t _tto_t _tthe_t _tlist_t _tof_t _tReactionGlyphs_t.
 
ListOf_tLayout_getListOfSpeciesGlyphs (Layout_t *l)
 _tReturns_t _ta_t _tpointer_t _tto_t _tthe_t _tlist_t _tof_t _tSpeciesGlyphs_t.
 
ListOf_tLayout_getListOfTextGlyphs (Layout_t *l)
 _tReturns_t _ta_t _tpointer_t _tto_t _tthe_t _tlist_t _tof_t _tTextGlyphs_t.
 
unsigned int Layout_getNumAdditionalGraphicalObjects (const Layout_t *l)
 _tReturns_t _tthe_t _tnumber_t _tof_t _tadditional_t _tGraphicalObjects_t.
 
unsigned int Layout_getNumCompartmentGlyphs (const Layout_t *l)
 _tReturns_t _tthe_t _tnumber_t _tof_t _tCompartmentGlyphs_t.
 
unsigned int Layout_getNumReactionGlyphs (const Layout_t *l)
 _tReturns_t _tthe_t _tnumber_t _tof_t _tReactionGlyphs_t.
 
unsigned int Layout_getNumSpeciesGlyphs (const Layout_t *l)
 _tReturns_t _tthe_t _tnumber_t _tof_t _tSpeciesGlyphs_t.
 
unsigned int Layout_getNumTextGlyphs (const Layout_t *l)
 _tReturns_t _tthe_t _tnumber_t _tof_t _tTextGlyphs_t.
 
ReactionGlyph_tLayout_getReactionGlyph (Layout_t *l, unsigned int index)
 _tReturns_t _ta_t _tpointer_t _tto_t _tthe_t _tReactionGlyph_t_t _twith_t _tthe_t _tgiven_t _tindex_t.
 
SpeciesGlyph_tLayout_getSpeciesGlyph (Layout_t *l, unsigned int index)
 _tReturns_t _ta_t _tpointer_t _tto_t _tthe_t _tSpeciesGlyph_t_t _twith_t _tthe_t _tgiven_t _tindex_t.
 
TextGlyph_tLayout_getTextGlyph (Layout_t *l, unsigned int index)
 _tReturns_t _ta_t _tpointer_t _tto_t _tthe_t _tGraphicalObject_t_t _twith_t _tthe_t _tgiven_t _tindex_t.
 
void Layout_initDefaults (Layout_t *l)
 _tDoes_t _tnothing_t _tsince_t _tno_t _tdefaults_t _tare_t _tdefined_t _tfor_t _tLayout_t_t.
 
int Layout_isSetId (const Layout_t *l)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tid_t _tis_t _tset_t
 
GraphicalObject_tLayout_removeAdditionalGraphicalObject (Layout_t *l, unsigned int index)
 _tRemoves_t _tthe_t _tgraphical_t _tobject_t _twith_t _tthe_t _tgiven_t _tindex_t.
 
GraphicalObject_tLayout_removeAdditionalGraphicalObjectWithId (Layout_t *l, const char *id)
 _tRemoves_t _tthe_t _tgraphical_t _tobject_t _twith_t _tthe_t _tgiven_t @_tp_t _tid_t.
 
CompartmentGlyph_tLayout_removeCompartmentGlyph (Layout_t *l, unsigned int index)
 _tRemoves_t _tthe_t _tcompartment_t _tglyph_t _twith_t _tthe_t _tgiven_t _tindex_t.
 
CompartmentGlyph_tLayout_removeCompartmentGlyphWithId (Layout_t *l, const char *id)
 _tRemoves_t _tthe_t _tcompartment_t _tglyph_t _twith_t _tthe_t _tgiven_t @_tp_t _tid_t.
 
ReactionGlyph_tLayout_removeReactionGlyph (Layout_t *l, unsigned int index)
 _tRemoves_t _tthe_t _treaction_t _tglyph_t _twith_t _tthe_t _tgiven_t _tindex_t.
 
ReactionGlyph_tLayout_removeReactionGlyphWithId (Layout_t *l, const char *id)
 _tRemoves_t _tthe_t _treaction_t _tglyph_t _twith_t _tthe_t _tgiven_t @_tp_t _tid_t.
 
SpeciesGlyph_tLayout_removeSpeciesGlyph (Layout_t *l, unsigned int index)
 _tRemoves_t _tthe_t _tspecies_t _tglyph_t _twith_t _tthe_t _tgiven_t _tindex_t.
 
SpeciesGlyph_tLayout_removeSpeciesGlyphWithId (Layout_t *l, const char *id)
 _tRemoves_t _tthe_t _tspecies_t _tglyph_t _twith_t _tthe_t _tgiven_t @_tp_t _tid_t.
 
SpeciesReferenceGlyph_tLayout_removeSpeciesReferenceGlyphWithId (Layout_t *l, const char *id)
 _tRemoves_t _tthe_t _tspecies_t _treference_t _tglyph_t _twith_t _tthe_t _tgiven_t @_tp_t _tid_t.
 
TextGlyph_tLayout_removeTextGlyph (Layout_t *l, unsigned int index)
 _tRemoves_t _tthe_t _ttext_t _tglyph_t _twith_t _tthe_t _tgiven_t _tindex_t.
 
TextGlyph_tLayout_removeTextGlyphWithId (Layout_t *l, const char *id)
 _tRemoves_t _tthe_t _ttext_t _tglyph_t _twith_t _tthe_t _tgiven_t @_tp_t _tid_t.
 
void Layout_setDimensions (Layout_t *l, const Dimensions_t *dimensions)
 _tSets_t _tthe_t _tdimensions_t _tof_t _tthe_t _tgiven_t _tLayout_t_t _tstructure_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tdimensions_t.
 
int Layout_setId (Layout_t *l, const char *sid)
 _tSets_t _tthe_t _tid_t
 
void Layout_unsetId (Layout_t *l)
 _tUnsets_t _tthe_t _tid_t
 

Detailed Description

Definition of Layout_t for SBML Layout_t.

Author
Ralph Gauges

Function Documentation

◆ Layout_addAdditionalGraphicalObject()

void Layout_addAdditionalGraphicalObject ( Layout_t l,
GraphicalObject_t go 
)

_tAdds_t _ta_t _tnew_t _tcopy_t _tof_t @_tp_t _tgo_t _tto_t _tthe_t _tlist_t _tof_t _tadditional_t _tgraphical_t _tobjects_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t. @_tparam_t _tgo_t _tthe_t _tGraphicalObject_t_t _tto_t _tadd_t _tto_t _tthe_t _tLayout_t_t _tstructure_t.

@_tmemberof_t _tLayout_t_t

◆ Layout_addCompartmentGlyph()

void Layout_addCompartmentGlyph ( Layout_t l,
CompartmentGlyph_t cg 
)

_tAdds_t _ta_t _tnew_t _tcopy_t _tof_t @_tp_t _tcg_t _tto_t _tthe_t _tlist_t _tof_t _tcompartment_t _tglyphs_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t. @_tparam_t _tcg_t _tthe_t _tCompartmentGlyph_t_t _tto_t _tadd_t _tto_t _tthe_t _tLayout_t_t _tstructure_t.

@_tmemberof_t _tLayout_t_t

◆ Layout_addReactionGlyph()

void Layout_addReactionGlyph ( Layout_t l,
ReactionGlyph_t rg 
)

_tAdds_t _ta_t _tnew_t _tcopy_t _tof_t @_tp_t _trg_t _tto_t _tthe_t _tlist_t _tof_t _treaction_t _tglyphs_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t. @_tparam_t _trg_t _tthe_t _tReactionGlyph_t_t _tto_t _tadd_t _tto_t _tthe_t _tLayout_t_t _tstructure_t.

@_tmemberof_t _tLayout_t_t

◆ Layout_addSpeciesGlyph()

void Layout_addSpeciesGlyph ( Layout_t l,
SpeciesGlyph_t sg 
)

_tAdds_t _ta_t _tnew_t _tcopy_t _tof_t @_tp_t _tsg_t _tto_t _tthe_t _tlist_t _tof_t _tspecies_t _tglyphs_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t. @_tparam_t _tsg_t _tthe_t _tSpeciesGlyph_t_t _tto_t _tadd_t _tto_t _tthe_t _tLayout_t_t _tstructure_t.

@_tmemberof_t _tLayout_t_t

◆ Layout_addTextGlyph()

void Layout_addTextGlyph ( Layout_t l,
TextGlyph_t tg 
)

_tAdds_t _ta_t _tnew_t _tcopy_t _tof_t @_tp_t _ttg_t _tto_t _tthe_t _tlist_t _tof_t _ttext_t _tglyphs_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t. @_tparam_t _ttg_t _tthe_t _tTextGlyph_t_t _tto_t _tadd_t _tto_t _tthe_t _tLayout_t_t _tstructure_t.

@_tmemberof_t _tLayout_t_t

◆ Layout_clone()

Layout_t * Layout_clone ( const Layout_t l)

@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthis_t _tLayout_t_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_create()

Layout_t * Layout_create ( void  )

_tCreates_t _ta_t _tnew_t _tLayout_t_t _twith_t _tthe_t _tdefault_t _tSBML_t _tlevel_t, _tversion_t, _tand_t _tpackage_t _tversion_t, _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tLayout_t_t

_tCreates_t _ta_t _tnew_t _tLayout_t_t _twith_t _tthe_t _tdefault_t _tSBML_t _tlevel_t, _tversion_t, _tand_t _tpackage_t _tversion_t, _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

◆ Layout_createAdditionalGraphicalObject()

GraphicalObject_t * Layout_createAdditionalGraphicalObject ( Layout_t l)

_tCreates_t _ta_t _tGraphicalObject_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthe_t _tend_t _tof_t _tthe_t _tadditional_t _tgraphical_t _tobjects_t _tlist_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tstructure_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_createCompartmentGlyph()

CompartmentGlyph_t * Layout_createCompartmentGlyph ( Layout_t l)

_tCreates_t _ta_t _tComparmentGlyph_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthe_t _tend_t _tof_t _tthe_t _tcompartment_t _tglyphs_t _tlist_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tstructure_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_createFrom()

Layout_t * Layout_createFrom ( const Layout_t temp)

_tCreates_t _ta_t _tclone_t _tof_t @_tp_t _ttemp_t, _tor_t _tan_t _tempty_t _tLayout_t_t _tstructure_t _tif_t @_tp_t _ttemp_t _tis_t @_tc_t _tNULL_t.

@_tparam_t _ttemp_t _tthe_t _tLayout_t_t _tstructure_t _tto_t _tcopy_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_createGeneralGlyph()

GeneralGlyph_t * Layout_createGeneralGlyph ( Layout_t l)

_tCreates_t _ta_t _tGeneralGlyph_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthe_t _tend_t _tof_t _tthe_t _tadditional_t _tobjects_t _tlist_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tstructure_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_createReactionGlyph()

ReactionGlyph_t * Layout_createReactionGlyph ( Layout_t l)

_tCreates_t _ta_t _tReactionGlyph_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthe_t _tend_t _tof_t _tthe_t _treaction_t _tglyphs_t _tlist_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tstructure_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_createSpeciesGlyph()

SpeciesGlyph_t * Layout_createSpeciesGlyph ( Layout_t l)

_tCreates_t _ta_t _tSpeciesGlyph_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthe_t _tend_t _tof_t _tthe_t _tspecies_t _tglyphs_t _tlist_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tstructure_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_createTextGlyph()

TextGlyph_t * Layout_createTextGlyph ( Layout_t l)

_tCreates_t _ta_t _tTextGlyph_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthe_t _tend_t _tof_t _tthe_t _ttext_t _tglyphs_t _tlist_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tstructure_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_createWith()

Layout_t * Layout_createWith ( const char *  sid)

_tCreates_t _ta_t _tnew_t _tLayout_t_t _twith_t _tthe_t _tdefault_t _tSBML_t _tlevel_t, _tversion_t, _tand_t _tpackage_t _tversion_t, _tand_t _twith_t _tthe_t _tgiven_t @_tp_t _tid_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tsid_t _tthe_t _tid_t _tof_t _tthe_t _tcreated_t _tLayout_t_t.

@_tmemberof_t _tLayout_t_t

◆ Layout_createWithDimensions()

Layout_t * Layout_createWithDimensions ( const char *  sid,
const Dimensions_t dimensions 
)

_tCreates_t _ta_t _tnew_t _tLayout_t_t _twith_t _tthe_t _tdefault_t _tSBML_t _tlevel_t, _tversion_t, _tand_t _tpackage_t _tversion_t, _tand_t _twith_t _tthe_t _tgiven_t _tDimensions_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tsid_t _tthe_t _tid_t _tof_t _tthe_t _tcreated_t _tLayout_t_t. @_tparam_t _tdimensions_t _tthe_t _tdimensions_t _tof_t _tthe_t _tcreated_t _tLayout_t_t _tstructure_t.

@_tmemberof_t _tLayout_t_t

◆ Layout_createWithSize()

Layout_t * Layout_createWithSize ( const char *  sid,
double  width,
double  height,
double  depth 
)

_tCreates_t _ta_t _tnew_t _tLayout_t_t _twith_t _tthe_t _tdefault_t _tSBML_t _tlevel_t, _tversion_t, _tand_t _tpackage_t _tversion_t, _tand_t _twith_t _tthe_t _tgiven_t _twidth_t, _theight_t _tand_t _tdepth_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tsid_t _tthe_t _tid_t _tof_t _tthe_t _tcreated_t _tLayout_t_t. @_tparam_t _twidth_t _tthe_t _tvalue_t _tof_t _tthe_t _twidth_t. @_tparam_t _theight_t _tthe_t _tvalue_t _tof_t _tthe_t _theight_t. @_tparam_t _tdepth_t _tthe_t _tvalue_t _tof_t _tthe_t _tdepth_t.

@_tmemberof_t _tLayout_t_t

◆ Layout_free()

void Layout_free ( Layout_t l)

_tFrees_t _tthe_t _tmemory_t _tfor_t _tthe_t _tgiven_t _tlayout_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t.

@_tmemberof_t _tLayout_t_t

◆ Layout_getAdditionalGraphicalObject()

GraphicalObject_t * Layout_getAdditionalGraphicalObject ( Layout_t l,
unsigned int  index 
)

_tReturns_t _ta_t _tpointer_t _tto_t _tthe_t _tAdditionalGraphicalObject_t_t _twith_t _tthe_t _tgiven_t _tindex_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t. @_tparam_t _tindex_t _tthe_t _tindex_t _tof_t _tthe_t _tdesired_t _tGraphicalObject_t_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_getCompartmentGlyph()

CompartmentGlyph_t * Layout_getCompartmentGlyph ( Layout_t l,
unsigned int  index 
)

_tReturns_t _ta_t _tpointer_t _tto_t _tthe_t _tCompartmentGlyph_t_t _twith_t _tthe_t _tgiven_t _tindex_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t. @_tparam_t _tindex_t _tthe_t _tindex_t _tof_t _tthe_t _tdesired_t _tCompartmentGlyph_t_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_getDimensions()

Dimensions_t * Layout_getDimensions ( Layout_t l)

_tReturns_t _ta_t _tDimensions_t_t _tpointer_t _tfrom_t _tthe_t _tlayout_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_getId()

const char * Layout_getId ( const Layout_t l)

_tReturns_t _tthe_t _tid_t

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t.

@_tcopydetails_t _tdoc_warning_returns_owned_char_t

@_tmemberof_t _tLayout_t_t

◆ Layout_getListOfAdditionalGraphicalObjects()

ListOf_t * Layout_getListOfAdditionalGraphicalObjects ( Layout_t l)

_tReturns_t _ta_t _tpointer_t _tto_t _tthe_t _tlist_t _tof_t _tadditional_t _tGraphicalObjects_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_getListOfCompartmentGlyphs()

ListOf_t * Layout_getListOfCompartmentGlyphs ( Layout_t l)

_tReturns_t _ta_t _tpointer_t _tto_t _tthe_t _tlist_t _tof_t _tCompartmentGlyph_t_t'_ts_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_getListOfReactionGlyphs()

ListOf_t * Layout_getListOfReactionGlyphs ( Layout_t l)

_tReturns_t _ta_t _tpointer_t _tto_t _tthe_t _tlist_t _tof_t _tReactionGlyphs_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_getListOfSpeciesGlyphs()

ListOf_t * Layout_getListOfSpeciesGlyphs ( Layout_t l)

_tReturns_t _ta_t _tpointer_t _tto_t _tthe_t _tlist_t _tof_t _tSpeciesGlyphs_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_getListOfTextGlyphs()

ListOf_t * Layout_getListOfTextGlyphs ( Layout_t l)

_tReturns_t _ta_t _tpointer_t _tto_t _tthe_t _tlist_t _tof_t _tTextGlyphs_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_getNumAdditionalGraphicalObjects()

unsigned int Layout_getNumAdditionalGraphicalObjects ( const Layout_t l)

_tReturns_t _tthe_t _tnumber_t _tof_t _tadditional_t _tGraphicalObjects_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t.

@_tmemberof_t _tLayout_t_t

◆ Layout_getNumCompartmentGlyphs()

unsigned int Layout_getNumCompartmentGlyphs ( const Layout_t l)

_tReturns_t _tthe_t _tnumber_t _tof_t _tCompartmentGlyphs_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t.

@_tmemberof_t _tLayout_t_t

◆ Layout_getNumReactionGlyphs()

unsigned int Layout_getNumReactionGlyphs ( const Layout_t l)

_tReturns_t _tthe_t _tnumber_t _tof_t _tReactionGlyphs_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t.

@_tmemberof_t _tLayout_t_t

◆ Layout_getNumSpeciesGlyphs()

unsigned int Layout_getNumSpeciesGlyphs ( const Layout_t l)

_tReturns_t _tthe_t _tnumber_t _tof_t _tSpeciesGlyphs_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t.

@_tmemberof_t _tLayout_t_t

◆ Layout_getNumTextGlyphs()

unsigned int Layout_getNumTextGlyphs ( const Layout_t l)

_tReturns_t _tthe_t _tnumber_t _tof_t _tTextGlyphs_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t.

@_tmemberof_t _tLayout_t_t

◆ Layout_getReactionGlyph()

ReactionGlyph_t * Layout_getReactionGlyph ( Layout_t l,
unsigned int  index 
)

_tReturns_t _ta_t _tpointer_t _tto_t _tthe_t _tReactionGlyph_t_t _twith_t _tthe_t _tgiven_t _tindex_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t. @_tparam_t _tindex_t _tthe_t _tindex_t _tof_t _tthe_t _tdesired_t _tReactionGlyph_t_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_getSpeciesGlyph()

SpeciesGlyph_t * Layout_getSpeciesGlyph ( Layout_t l,
unsigned int  index 
)

_tReturns_t _ta_t _tpointer_t _tto_t _tthe_t _tSpeciesGlyph_t_t _twith_t _tthe_t _tgiven_t _tindex_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t. @_tparam_t _tindex_t _tthe_t _tindex_t _tof_t _tthe_t _tdesired_t _tSpeciesGlyph_t_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_getTextGlyph()

TextGlyph_t * Layout_getTextGlyph ( Layout_t l,
unsigned int  index 
)

_tReturns_t _ta_t _tpointer_t _tto_t _tthe_t _tGraphicalObject_t_t _twith_t _tthe_t _tgiven_t _tindex_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t. @_tparam_t _tindex_t _tthe_t _tindex_t _tof_t _tthe_t _tdesired_t _tTextGlyph_t_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_initDefaults()

void Layout_initDefaults ( Layout_t l)

_tDoes_t _tnothing_t _tsince_t _tno_t _tdefaults_t _tare_t _tdefined_t _tfor_t _tLayout_t_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t.

@_tmemberof_t _tLayout_t_t

◆ Layout_isSetId()

int Layout_isSetId ( const Layout_t l)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tid_t _tis_t _tset_t

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t.

@_tmemberof_t _tLayout_t_t

◆ Layout_removeAdditionalGraphicalObject()

GraphicalObject_t * Layout_removeAdditionalGraphicalObject ( Layout_t l,
unsigned int  index 
)

_tRemoves_t _tthe_t _tgraphical_t _tobject_t _twith_t _tthe_t _tgiven_t _tindex_t.

_tIf_t _tthe_t _tindex_t _tis_t _tinvalid_t, _tnothing_t _tis_t _tremoved_t, _tand_t @_tc_t _tNULL_t _tis_t _treturned_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t. @_tparam_t _tindex_t _tthe_t _tindex_t _tof_t _tthe_t _tGraphicalObject_t_t _tto_t _tremove_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_removeAdditionalGraphicalObjectWithId()

GraphicalObject_t * Layout_removeAdditionalGraphicalObjectWithId ( Layout_t l,
const char *  id 
)

_tRemoves_t _tthe_t _tgraphical_t _tobject_t _twith_t _tthe_t _tgiven_t @_tp_t _tid_t.

_tIf_t _tthe_t _tid_t _tis_t _tnot_t _tfound_t, _tnothing_t _tis_t _tremoved_t, _tand_t @_tc_t _tNULL_t _tis_t _treturned_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t. @_tparam_t _tid_t _tthe_t _tid_t _tof_t _tthe_t _tGraphicalObject_t_t _tto_t _tremove_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_removeCompartmentGlyph()

CompartmentGlyph_t * Layout_removeCompartmentGlyph ( Layout_t l,
unsigned int  index 
)

_tRemoves_t _tthe_t _tcompartment_t _tglyph_t _twith_t _tthe_t _tgiven_t _tindex_t.

_tIf_t _tthe_t _tindex_t _tis_t _tinvalid_t, _tnothing_t _tis_t _tremoved_t, _tand_t @_tc_t _tNULL_t _tis_t _treturned_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t. @_tparam_t _tindex_t _tthe_t _tindex_t _tof_t _tthe_t _tCompartmentGlyph_t_t _tto_t _tremove_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_removeCompartmentGlyphWithId()

CompartmentGlyph_t * Layout_removeCompartmentGlyphWithId ( Layout_t l,
const char *  id 
)

_tRemoves_t _tthe_t _tcompartment_t _tglyph_t _twith_t _tthe_t _tgiven_t @_tp_t _tid_t.

_tIf_t _tthe_t _tid_t _tis_t _tnot_t _tfound_t, _tnothing_t _tis_t _tremoved_t, _tand_t @_tc_t _tNULL_t _tis_t _treturned_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t. @_tparam_t _tid_t _tthe_t _tid_t _tof_t _tthe_t _tCompartmentGlyph_t_t _tto_t _tremove_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_removeReactionGlyph()

ReactionGlyph_t * Layout_removeReactionGlyph ( Layout_t l,
unsigned int  index 
)

_tRemoves_t _tthe_t _treaction_t _tglyph_t _twith_t _tthe_t _tgiven_t _tindex_t.

_tIf_t _tthe_t _tindex_t _tis_t _tinvalid_t, _tnothing_t _tis_t _tremoved_t, _tand_t @_tc_t _tNULL_t _tis_t _treturned_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t. @_tparam_t _tindex_t _tthe_t _tindex_t _tof_t _tthe_t _tReactionGlyph_t_t _tto_t _tremove_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_removeReactionGlyphWithId()

ReactionGlyph_t * Layout_removeReactionGlyphWithId ( Layout_t l,
const char *  id 
)

_tRemoves_t _tthe_t _treaction_t _tglyph_t _twith_t _tthe_t _tgiven_t @_tp_t _tid_t.

_tIf_t _tthe_t _tid_t _tis_t _tnot_t _tfound_t, _tnothing_t _tis_t _tremoved_t, _tand_t @_tc_t _tNULL_t _tis_t _treturned_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t. @_tparam_t _tid_t _tthe_t _tid_t _tof_t _tthe_t _tReactionGlyph_t_t _tto_t _tremove_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_removeSpeciesGlyph()

SpeciesGlyph_t * Layout_removeSpeciesGlyph ( Layout_t l,
unsigned int  index 
)

_tRemoves_t _tthe_t _tspecies_t _tglyph_t _twith_t _tthe_t _tgiven_t _tindex_t.

_tIf_t _tthe_t _tindex_t _tis_t _tinvalid_t, _tnothing_t _tis_t _tremoved_t, _tand_t @_tc_t _tNULL_t _tis_t _treturned_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t. @_tparam_t _tindex_t _tthe_t _tindex_t _tof_t _tthe_t _tSpeciesGlyph_t_t _tto_t _tremove_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_removeSpeciesGlyphWithId()

SpeciesGlyph_t * Layout_removeSpeciesGlyphWithId ( Layout_t l,
const char *  id 
)

_tRemoves_t _tthe_t _tspecies_t _tglyph_t _twith_t _tthe_t _tgiven_t @_tp_t _tid_t.

_tIf_t _tthe_t _tid_t _tis_t _tnot_t _tfound_t, _tnothing_t _tis_t _tremoved_t, _tand_t @_tc_t _tNULL_t _tis_t _treturned_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t. @_tparam_t _tid_t _tthe_t _tid_t _tof_t _tthe_t _tSpeciesGlyph_t_t _tto_t _tremove_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_removeSpeciesReferenceGlyphWithId()

SpeciesReferenceGlyph_t * Layout_removeSpeciesReferenceGlyphWithId ( Layout_t l,
const char *  id 
)

_tRemoves_t _tthe_t _tspecies_t _treference_t _tglyph_t _twith_t _tthe_t _tgiven_t @_tp_t _tid_t.

_tIf_t _tthe_t _tid_t _tis_t _tnot_t _tfound_t, _tnothing_t _tis_t _tremoved_t, _tand_t @_tc_t _tNULL_t _tis_t _treturned_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t. @_tparam_t _tid_t _tthe_t _tid_t _tof_t _tthe_t _tSpeciesReferenceGlyph_t_t _tto_t _tremove_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_removeTextGlyph()

TextGlyph_t * Layout_removeTextGlyph ( Layout_t l,
unsigned int  index 
)

_tRemoves_t _tthe_t _ttext_t _tglyph_t _twith_t _tthe_t _tgiven_t _tindex_t.

_tIf_t _tthe_t _tindex_t _tis_t _tinvalid_t, _tnothing_t _tis_t _tremoved_t, _tand_t @_tc_t _tNULL_t _tis_t _treturned_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t. @_tparam_t _tindex_t _tthe_t _tindex_t _tof_t _tthe_t _tTextGlyph_t_t _tto_t _tremove_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_removeTextGlyphWithId()

TextGlyph_t * Layout_removeTextGlyphWithId ( Layout_t l,
const char *  id 
)

_tRemoves_t _tthe_t _ttext_t _tglyph_t _twith_t _tthe_t _tgiven_t @_tp_t _tid_t.

_tIf_t _tthe_t _tid_t _tis_t _tnot_t _tfound_t, _tnothing_t _tis_t _tremoved_t, _tand_t @_tc_t _tNULL_t _tis_t _treturned_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t. @_tparam_t _tid_t _tthe_t _tid_t _tof_t _tthe_t _tTextGlyph_t_t _tto_t _tremove_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tLayout_t_t

◆ Layout_setDimensions()

void Layout_setDimensions ( Layout_t l,
const Dimensions_t dimensions 
)

_tSets_t _tthe_t _tdimensions_t _tof_t _tthe_t _tgiven_t _tLayout_t_t _tstructure_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tdimensions_t.

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t. @_tparam_t _tdimensions_t _tthe_t _tdimensions_t _tto_t _tuse_t _tfor_t _tthe_t _tLayout_t_t _tstructure_t.

@_tmemberof_t _tLayout_t_t

◆ Layout_setId()

int Layout_setId ( Layout_t l,
const char *  sid 
)

_tSets_t _tthe_t _tid_t

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t. @_tparam_t _tsid_t _tthe_t _tstring_t _tto_t _tuse_t _tas_t _tthe_t _tID_t _tof_t _tthe_t _tLayout_t_t.

@_tmemberof_t _tLayout_t_t

◆ Layout_unsetId()

void Layout_unsetId ( Layout_t l)

_tUnsets_t _tthe_t _tid_t

@_tparam_t _tl_t _tthe_t _tLayout_t_t _tstructure_t.

@_tmemberof_t _tLayout_t_t