libSBML C API  libSBML 5.20.4 C API
Loading...
Searching...
No Matches
SBMLNamespaces.h File Reference

SBMLNamespaces_t class to store level/version and namespace. More...

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

Functions

int SBMLNamespaces_addNamespaces (SBMLNamespaces_t *sbmlns, const XMLNamespaces_t *xmlns)
 _tAdd_t _tthe_t _tXML_t _tnamespaces_t _tlist_t _tto_t _tthe_t _tset_t _tof_t _tnamespaces_t _twithin_t _tthis_t _tSBMLNamespaces_t_t _tstructure_t.
 
int SBMLNamespaces_addPackageNamespace (SBMLNamespaces_t *sbmlns, const char *pkgName, unsigned int pkgVersion, const char *prefix)
 _tAdd_t _tan_t _tXML_t _tnamespace_t (_ta_t _tpair_t _tof_t _tURI_t _tand_t _tprefix_t) _tof_t _ta_t _tpackage_t _textension_t _tto_t _tthe_t _tset_t _tof_t _tnamespaces_t _twithin_t _tthis_t _tSBMLNamespaces_t _tobject_t.
 
int SBMLNamespaces_addPackageNamespaces (SBMLNamespaces_t *sbmlns, const XMLNamespaces_t *xmlns)
 _tAdd_t _tthe_t _tXML_t _tnamespaces_t _tof_t _tpackage_t _textensions_t _tin_t _tthe_t _tgiven_t _tXMLNamespace_t _tobject_t _tto_t _tthe_t _tset_t _tof_t _tnamespaces_t _twithin_t _tthis_t _tSBMLNamespaces_t _tobject_t (_tNon_t-_tpackage_t _tXML_t _tnamespaces_t _tare_t _tnot_t _tadded_t _tby_t _tthis_t _tfunction_t).
 
SBMLNamespaces_tSBMLNamespaces_create (unsigned int level, unsigned int version)
 _tCreates_t _ta_t _tnew_t _tSBMLNamespaces_t_t _tstructure_t _tcorresponding_t _tto_t _tthe_t _tgiven_t _tSBML_t @_tp_t _tlevel_t _tand_t @_tp_t _tversion_t.
 
void SBMLNamespaces_free (SBMLNamespaces_t *ns)
 _tDestroys_t _tthis_t _tSBMLNamespaces_t_t _tstructure_t.
 
unsigned int SBMLNamespaces_getLevel (SBMLNamespaces_t *sbmlns)
 _tGet_t _tthe_t _tSBML_t _tLevel_t _tof_t _tthis_t _tSBMLNamespaces_t_t _tstructure_t.
 
XMLNamespaces_tSBMLNamespaces_getNamespaces (SBMLNamespaces_t *sbmlns)
 _tGet_t _tthe_t _tXML_t _tNamespaces_t _tlist_t _tof_t _tthis_t _tSBMLNamespaces_t_t _tstructure_t.
 
char * SBMLNamespaces_getSBMLNamespaceURI (unsigned int level, unsigned int version)
 _tReturns_t _ta_t _tstring_t _trepresenting_t _tthe_t _tSBML_t _tXML_t _tnamespace_t _tfor_t _tthe_t _tgiven_t @_tp_t _tlevel_t _tand_t @_tp_t _tversion_t _tof_t _tSBML_t.
 
SBMLNamespaces_t ** SBMLNamespaces_getSupportedNamespaces (int *length)
 _tReturns_t _tan_t _tarray_t _tof_t _tSBML_t _tNamespaces_t _tsupported_t _tby_t _tthis_t _tversion_t _tof_t _tLibSBML_t.
 
unsigned int SBMLNamespaces_getVersion (SBMLNamespaces_t *sbmlns)
 _tGet_t _tthe_t _tSBML_t _tVersion_t _tof_t _tthis_t _tSBMLNamespaces_t_t _tstructure_t.
 

Variables

static const unsigned int SBML_DEFAULT_LEVEL = 3
 @_tclass_t _tdoc_sbmlnamespaces_what_is_it_t
 
static const unsigned int SBML_DEFAULT_VERSION = 2
 
static const char *const SBML_XMLNS_L1 = "http://www.sbml.org/sbml/level1"
 
static const char *const SBML_XMLNS_L2V1 = "http://www.sbml.org/sbml/level2"
 
static const char *const SBML_XMLNS_L2V2 = "http://www.sbml.org/sbml/level2/version2"
 
static const char *const SBML_XMLNS_L2V3 = "http://www.sbml.org/sbml/level2/version3"
 
static const char *const SBML_XMLNS_L2V4 = "http://www.sbml.org/sbml/level2/version4"
 
static const char *const SBML_XMLNS_L2V5 = "http://www.sbml.org/sbml/level2/version5"
 
static const char *const SBML_XMLNS_L3V1 = "http://www.sbml.org/sbml/level3/version1/core"
 
static const char *const SBML_XMLNS_L3V2 = "http://www.sbml.org/sbml/level3/version2/core"
 

Detailed Description

SBMLNamespaces_t class to store level/version and namespace.

Author
Sarah Keating

Function Documentation

◆ SBMLNamespaces_addNamespaces()

int SBMLNamespaces_addNamespaces ( SBMLNamespaces_t sbmlns,
const XMLNamespaces_t xmlns 
)

_tAdd_t _tthe_t _tXML_t _tnamespaces_t _tlist_t _tto_t _tthe_t _tset_t _tof_t _tnamespaces_t _twithin_t _tthis_t _tSBMLNamespaces_t_t _tstructure_t.

@_tparam_t _tsbmlns_t _tthe_t _tSBMLNamespaces_t_t _tstructure_t _tto_t _tadd_t _tto_t. @_tparam_t _txmlns_t _tthe_t _tXML_t _tnamespaces_t _tto_t _tbe_t _tadded_t.

@_tmemberof_t _tSBMLNamespaces_t_t

◆ SBMLNamespaces_addPackageNamespace()

int SBMLNamespaces_addPackageNamespace ( SBMLNamespaces_t sbmlns,
const char *  pkgName,
unsigned int  pkgVersion,
const char *  prefix 
)

_tAdd_t _tan_t _tXML_t _tnamespace_t (_ta_t _tpair_t _tof_t _tURI_t _tand_t _tprefix_t) _tof_t _ta_t _tpackage_t _textension_t _tto_t _tthe_t _tset_t _tof_t _tnamespaces_t _twithin_t _tthis_t _tSBMLNamespaces_t _tobject_t.

_tThe_t _tSBML_t _tLevel_t _tand_t _tSBML_t _tVersion_t _tof_t _tthis_t _tobject_t _tis_t _tused_t.

@_tparam_t _tsbmlns_t _tthe_t _tSBMLNamespaces_t_t _tstructure_t _tto_t _tadd_t _tto_t. @_tparam_t _tpkgName_t _tthe_t _tstring_t _tof_t _tpackage_t _tname_t (_te_t._tg_t. "_tlayout_t", "_tmulti_t"). @_tparam_t _tpkgVersion_t _tthe_t _tpackage_t _tversion_t. @_tparam_t _tprefix_t _tthe_t _tprefix_t _tof_t _tthe_t _tpackage_t _tnamespace_t _tto_t _tbe_t _tadded_t. _tThe_t _tpackage_t'_ts_t _tname_t _twill_t _tbe_t _tused_t _tif_t _tthe_t _tgiven_t _tstring_t _tis_t _tempty_t (_tdefault_t).

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t}

@_tnote_t _tAn_t _tXML_t _tnamespace_t _tof_t _ta_t _tnon_t-_tregistered_t _tpackage_t _textension_t _tcan_t'_tt_t _tbe_t _tadded_t _tby_t _tthis_t _tfunction_t (@_tsbmlconstant_t{_tLIBSBML_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t} _twill_t _tbe_t _treturned_t).

@_tsee_t _taddNamespace_t(@_tif_t _tjava_t _tString_t, _tString_t@_tendif_t)

◆ SBMLNamespaces_addPackageNamespaces()

int SBMLNamespaces_addPackageNamespaces ( SBMLNamespaces_t sbmlns,
const XMLNamespaces_t xmlns 
)

_tAdd_t _tthe_t _tXML_t _tnamespaces_t _tof_t _tpackage_t _textensions_t _tin_t _tthe_t _tgiven_t _tXMLNamespace_t _tobject_t _tto_t _tthe_t _tset_t _tof_t _tnamespaces_t _twithin_t _tthis_t _tSBMLNamespaces_t _tobject_t (_tNon_t-_tpackage_t _tXML_t _tnamespaces_t _tare_t _tnot_t _tadded_t _tby_t _tthis_t _tfunction_t).

@_tparam_t _tsbmlns_t _tthe_t _tSBMLNamespaces_t_t _tstructure_t _tto_t _tadd_t _tto_t. @_tparam_t _txmlns_t _tthe_t _tXML_t _tnamespaces_t _tto_t _tbe_t _tadded_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t}

@_tnote_t _tXML_t _tnamespaces_t _tof_t _ta_t _tnon_t-_tregistered_t _tpackage_t _textensions_t _tare_t _tnot_t _tadded_t (_tjust_t _tignored_t) _tby_t _tthis_t _tfunction_t. @_tsbmlconstant_t{_tLIBSBML_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t} _twill_t _tbe_t _treturned_t _tif_t _tthe_t _tgiven_t _txmlns_t _tis_t @_tc_t _tNULL_t.

◆ SBMLNamespaces_create()

SBMLNamespaces_t * SBMLNamespaces_create ( unsigned int  level,
unsigned int  version 
)

_tCreates_t _ta_t _tnew_t _tSBMLNamespaces_t_t _tstructure_t _tcorresponding_t _tto_t _tthe_t _tgiven_t _tSBML_t @_tp_t _tlevel_t _tand_t @_tp_t _tversion_t.

_tSBMLNamespaces_t_t _tstructures_t _tare_t _tused_t _tin_t _tlibSBML_t _tto_t _tcommunicate_t _tSBML_t _tLevel_t _tand_t _tVersion_t _tdata_t _tbetween_t _tconstructors_t _tand_t _tother_t _tmethods_t. _tThe_t _tSBMLNamespaces_t_t _tstructure_t _tclass_t _ttracks_t _t3_t-_ttuples_t (_ttriples_t) _tconsisting_t _tof_t _tSBML_t _tLevel_t, _tVersion_t, _tand_t _tthe_t _tcorresponding_t _tSBML_t _tXML_t _tnamespace_t. _tMost_t _tconstructors_t _tfor_t _tSBML_t _tstructures_t _tin_t _tlibSBML_t _ttake_t _ta_t _tSBMLNamespaces_t_t _tstructure_t _tas_t _tan_t _targument_t, _tthereby_t _tallowing_t _tthe_t _tconstructor_t _tto_t _tproduce_t _tthe_t _tproper_t _tcombination_t _tof_t _tattributes_t _tand_t _tother_t _tinternal_t _tdata_t _tstructures_t _tfor_t _tthe_t _tgiven_t _tSBML_t _tLevel_t _tand_t _tVersion_t.

_tThe_t _tplural_t _tname_t "_tSBMLNamespaces_t" _tis_t _tnot_t _ta_t _tmistake_t, _tbecause_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t, _tstructures_t _tmay_t _thave_t _textensions_t _tadded_t _tby_t _tLevel_t&_tnbsp_t;_t3_t _tpackages_t _tused_t _tby_t _ta_t _tgiven_t _tmodel_t; _thowever_t, _tuntil_t _tthe_t _tintroduction_t _tof_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t, _tthe_t _tSBMLNamespaces_t_t _tstructure_t _tonly_t _trecords_t _tone_t _tSBML_t _tLevel_t/_tVersion_t/_tnamespace_t _tcombination_t _tat_t _ta_t _ttime_t.

@_tparam_t _tlevel_t _tthe_t _tSBML_t _tlevel_t. @_tparam_t _tversion_t _tthe_t _tSBML_t _tversion_t.

@_treturn_t _tSBMLNamespaces_t_t _tstructure_t _tcreated_t

@_tifnot_t _thasDefaultArgs_t @_thtmlinclude_t _twarn_t-_tdefault_t-_targs_t-_tin_t-_tdocs._thtml_t @_tendif_t

@_tmemberof_t _tSBMLNamespaces_t_t

_tCreates_t _ta_t _tnew_t _tSBMLNamespaces_t_t _tstructure_t _tcorresponding_t _tto_t _tthe_t _tgiven_t _tSBML_t @_tp_t _tlevel_t _tand_t @_tp_t _tversion_t.

@_tcond_t _tdoxygenIgnored_t

◆ SBMLNamespaces_free()

void SBMLNamespaces_free ( SBMLNamespaces_t ns)

_tDestroys_t _tthis_t _tSBMLNamespaces_t_t _tstructure_t.

@_tparam_t _tns_t _tSBMLNamespaces_t_t _tstructure_t _tto_t _tbe_t _tfreed_t.

@_tmemberof_t _tSBMLNamespaces_t_t

◆ SBMLNamespaces_getLevel()

unsigned int SBMLNamespaces_getLevel ( SBMLNamespaces_t sbmlns)

_tGet_t _tthe_t _tSBML_t _tLevel_t _tof_t _tthis_t _tSBMLNamespaces_t_t _tstructure_t.

@_tparam_t _tsbmlns_t _tthe_t _tSBMLNamespaces_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t _tthe_t _tSBML_t _tLevel_t _tof_t _tthis_t _tSBMLNamespaces_t_t _tstructure_t.

@_tmemberof_t _tSBMLNamespaces_t_t

◆ SBMLNamespaces_getNamespaces()

XMLNamespaces_t * SBMLNamespaces_getNamespaces ( SBMLNamespaces_t sbmlns)

_tGet_t _tthe_t _tXML_t _tNamespaces_t _tlist_t _tof_t _tthis_t _tSBMLNamespaces_t_t _tstructure_t.

@_tparam_t _tsbmlns_t _tthe_t _tSBMLNamespaces_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t _tthe_t _tXMLNamespaces_t_t _tstructure_t _tof_t _tthis_t _tSBMLNamespaces_t_t _tstructure_t.

@_tmemberof_t _tSBMLNamespaces_t_t

◆ SBMLNamespaces_getSBMLNamespaceURI()

char * SBMLNamespaces_getSBMLNamespaceURI ( unsigned int  level,
unsigned int  version 
)

_tReturns_t _ta_t _tstring_t _trepresenting_t _tthe_t _tSBML_t _tXML_t _tnamespace_t _tfor_t _tthe_t _tgiven_t @_tp_t _tlevel_t _tand_t @_tp_t _tversion_t _tof_t _tSBML_t.

@_tparam_t _tlevel_t _tthe_t _tSBML_t _tlevel_t. @_tparam_t _tversion_t _tthe_t _tSBML_t _tversion_t.

@_treturn_t _ta_t _tstring_t _trepresenting_t _tthe_t _tSBML_t _tnamespace_t _tthat_t _treflects_t _tthe_t _tSBML_t _tLevel_t _tand_t _tVersion_t _tspecified_t.

@_tmemberof_t _tSBMLNamespaces_t_t

◆ SBMLNamespaces_getSupportedNamespaces()

SBMLNamespaces_t ** SBMLNamespaces_getSupportedNamespaces ( int *  length)

_tReturns_t _tan_t _tarray_t _tof_t _tSBML_t _tNamespaces_t _tsupported_t _tby_t _tthis_t _tversion_t _tof_t _tLibSBML_t.

@_tparam_t _tlength_t _tan_t _tinteger_t _tholding_t _tthe_t _tlength_t _tof_t _tthe_t _tarray_t. @_treturn_t _tan_t _tarray_t _tof_t _tSBML_t _tnamespaces_t, _tor_t @_tc_t _tNULL_t _tif_t _tlength_t _tis_t @_tc_t _tNULL_t. _tThe_t _tarray_t _thas_t _tto_t _tbe_t _tfreed_t _tby_t _tthe_t _tcaller_t.

@_tmemberof_t _tSBMLNamespaces_t_t

◆ SBMLNamespaces_getVersion()

unsigned int SBMLNamespaces_getVersion ( SBMLNamespaces_t sbmlns)

_tGet_t _tthe_t _tSBML_t _tVersion_t _tof_t _tthis_t _tSBMLNamespaces_t_t _tstructure_t.

@_tparam_t _tsbmlns_t _tthe_t _tSBMLNamespaces_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t _tthe_t _tSBML_t _tVersion_t _tof_t _tthis_t _tSBMLNamespaces_t_t _tstructure_t.

@_tmemberof_t _tSBMLNamespaces_t_t

Variable Documentation

◆ SBML_DEFAULT_LEVEL

const unsigned int SBML_DEFAULT_LEVEL = 3
static

@_tclass_t _tdoc_sbmlnamespaces_what_is_it_t

@_tpar_t _tSBMLNamespaces_t _tobjects_t _tare_t _tused_t _tin_t _tlibSBML_t _tto_t _tcommunicate_t _tSBML_t _tLevel_t _tand_t _tVersion_t _tdata_t _tbetween_t _tconstructors_t _tand_t _tother_t _tmethods_t. _tThe_t _tSBMLNamespaces_t _tobject_t _tclass_t _tholds_t _ttriples_t _tconsisting_t _tof_t _tSBML_t _tLevel_t, _tVersion_t, _tand_t _tthe_t _tcorresponding_t _tSBML_t _tXML_t _tnamespace_t. _tMost_t _tconstructors_t _tfor_t _tSBML_t _tobjects_t _tin_t _tlibSBML_t _ttake_t _ta_t _tSBMLNamespaces_t _tobject_t _tas_t _tan_t _targument_t, _tthereby_t _tallowing_t _tthe_t _tconstructor_t _tto_t _tproduce_t _tthe_t _tproper_t _tcombination_t _tof_t _tattributes_t _tand_t _tother_t _tinternal_t _tdata_t _tstructures_t _tfor_t _tthe_t _tgiven_t _tSBML_t _tLevel_t _tand_t _tVersion_t.

_tThe_t _tplural_t _tname_t (_tSBMLNamespaces_t) _tis_t _tnot_t _ta_t _tmistake_t, _tbecause_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t, _tobjects_t _tmay_t _thave_t _textensions_t _tadded_t _tby_t _tLevel_t&_tnbsp_t;_t3_t _tpackages_t _tused_t _tby_t _ta_t _tgiven_t _tmodel_t _tand_t _ttherefore_t _tmay_t _thave_t _tmultiple_t _tnamespaces_t _tassociated_t _twith_t _tthem_t. _tIn_t _tSBML_t _tLevels_t _tbelow_t _tLevel_t&_tnbsp_t;_t3_t, _tthe_t _tSBMLNamespaces_t _tobject_t _tonly_t _trecords_t _tone_t _tSBML_t _tLevel_t/_tVersion_t/_tnamespace_t _tcombination_t _tat_t _ta_t _ttime_t. _tMost_t _tconstructors_t _tfor_t _tSBML_t _tobjects_t _tin_t _tlibSBML_t _ttake_t _ta_t _tSBMLNamespaces_t _tobject_t _tas_t _tan_t _targument_t, _tthereby_t _tallowing_t _tthe_t _tconstructor_t _tto_t _tproduce_t _tthe_t _tproper_t _tcombination_t _tof_t _tattributes_t _tand_t _tother_t _tinternal_t _tdata_t _tstructures_t _tfor_t _tthe_t _tgiven_t _tSBML_t _tLevel_t _tand_t _tVersion_t.

◆ SBML_DEFAULT_VERSION

const unsigned int SBML_DEFAULT_VERSION = 2
static

◆ SBML_XMLNS_L1

const char* const SBML_XMLNS_L1 = "http://www.sbml.org/sbml/level1"
static

◆ SBML_XMLNS_L2V1

const char* const SBML_XMLNS_L2V1 = "http://www.sbml.org/sbml/level2"
static

◆ SBML_XMLNS_L2V2

const char* const SBML_XMLNS_L2V2 = "http://www.sbml.org/sbml/level2/version2"
static

◆ SBML_XMLNS_L2V3

const char* const SBML_XMLNS_L2V3 = "http://www.sbml.org/sbml/level2/version3"
static

◆ SBML_XMLNS_L2V4

const char* const SBML_XMLNS_L2V4 = "http://www.sbml.org/sbml/level2/version4"
static

◆ SBML_XMLNS_L2V5

const char* const SBML_XMLNS_L2V5 = "http://www.sbml.org/sbml/level2/version5"
static

◆ SBML_XMLNS_L3V1

const char* const SBML_XMLNS_L3V1 = "http://www.sbml.org/sbml/level3/version1/core"
static

◆ SBML_XMLNS_L3V2

const char* const SBML_XMLNS_L3V2 = "http://www.sbml.org/sbml/level3/version2/core"
static