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

Definition of a CVTerm_t class for adding annotations to a Model_t. More...

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

Enumerations

enum  BiolQualifierType_t {
  BQB_IS ,
  BQB_HAS_PART ,
  BQB_IS_PART_OF ,
  BQB_IS_VERSION_OF ,
  BQB_HAS_VERSION ,
  BQB_IS_HOMOLOG_TO ,
  BQB_IS_DESCRIBED_BY ,
  BQB_IS_ENCODED_BY ,
  BQB_ENCODES ,
  BQB_OCCURS_IN ,
  BQB_HAS_PROPERTY ,
  BQB_IS_PROPERTY_OF ,
  BQB_HAS_TAXON ,
  BQB_UNKNOWN
}
 @_tenum_t _tBiolQualifierType_t_t More...
 
enum  ModelQualifierType_t {
  BQM_IS ,
  BQM_IS_DESCRIBED_BY ,
  BQM_IS_DERIVED_FROM ,
  BQM_IS_INSTANCE_OF ,
  BQM_HAS_INSTANCE ,
  BQM_UNKNOWN
}
 @_tenum_t _tModelQualifierType_t_t More...
 
enum  QualifierType_t {
  MODEL_QUALIFIER ,
  BIOLOGICAL_QUALIFIER ,
  UNKNOWN_QUALIFIER
}
 @_tclass_t _tdoc_cvterm_common_description_t More...
 

Functions

BiolQualifierType_t BiolQualifierType_fromString (const char *s)
 _tThis_t _tmethod_t _ttakes_t _ta_t _tstring_t _tand_t _treturns_t _ta_t _tbiol_t _tqualifier_t _trepresenting_t _tthe_t _tstring_t.
 
const char * BiolQualifierType_toString (BiolQualifierType_t type)
 _tThis_t _tmethod_t _ttakes_t _ta_t _tbiol_t _tqualifier_t _ttype_t _tcode_t _tand_t _treturns_t _ta_t _tstring_t _trepresenting_t _tthe_t _tcode_t.
 
int CVTerm_addNestedCVTerm (CVTerm_t *cvt, const CVTerm_t *term)
 _tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tCVTerm_t_t _tto_t _tthe_t _tlist_t _tof_t _tnested_t _tCVTerm_t_t'_ts_t _twithin_t _tthis_t _tCVTerm_t_t _tstructure_t.
 
int CVTerm_addResource (CVTerm_t *term, const char *resource)
 _tAdds_t _ta_t _tresource_t _tto_t _tthe_t _tCVTerm_t_t.
 
CVTerm_tCVTerm_clone (const CVTerm_t *term)
 _tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tCVTerm_t_t _tstructure_t
 
CVTerm_tCVTerm_createFromNode (const XMLNode_t *node)
 _tCreate_t _ta_t _tnew_t _tCVTerm_t_t _tfrom_t _tthe_t _tgiven_t #_tXMLNode_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
CVTerm_tCVTerm_createWithQualifierType (QualifierType_t type)
 _tCreates_t _ta_t _tnew_t _tCVTerm_t_t _twith_t _tthe_t _tgiven_t #_tQualifierType_t_t _tvalue_t @_tp_t _ttype_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
void CVTerm_free (CVTerm_t *c)
 _tFrees_t _tthe_t _tgiven_t _tCVTerm_t_t _tstructure_t.
 
BiolQualifierType_t CVTerm_getBiologicalQualifierType (CVTerm_t *term)
 _tTakes_t _ta_t _tCVTerm_t_t _tstructure_t _tand_t _treturns_t _tthe_t #_tBiolQualifierType_t_t.
 
const List_tCVTerm_getListNestedCVTerms (const CVTerm_t *cvt)
 _tReturns_t _ta_t _tlist_t _tof_t _tCVTerm_t_t _tstructures_t _tcontained_t _twithin_t _tthis_t _tCVTerm_t_t _tstructure_t.
 
ModelQualifierType_t CVTerm_getModelQualifierType (CVTerm_t *term)
 _tTakes_t _ta_t _tCVTerm_t_t _tstructure_t _tand_t _treturns_t _tthe_t #_tModelQualifierType_t_t _ttype_t.
 
const CVTerm_tCVTerm_getNestedCVTerm (const CVTerm_t *cvt, unsigned int n)
 _tReturns_t _tthe_t _tnth_t _tCVTerm_t_t _tin_t _tthe_t _tlist_t _tof_t _tCVTerm_t_t'_ts_t _tof_t _tthis_t _tCVTerm_t_t _tstructure_t.
 
unsigned int CVTerm_getNumNestedCVTerms (const CVTerm_t *cvt)
 _tReturns_t _tthe_t _tnumber_t _tof_t _tCVTerm_t_t _tstructures_t _tnested_t _twithin_t _tthis_t _tCVTerm_t_t _tstructure_t.
 
unsigned int CVTerm_getNumResources (CVTerm_t *term)
 _tReturns_t _tthe_t _tnumber_t _tof_t _tresources_t _tfor_t _tthis_t CVTerm_t_t.
 
QualifierType_t CVTerm_getQualifierType (CVTerm_t *term)
 _tTakes_t _ta_t _tCVTerm_t_t _tstructure_t _tand_t _treturns_t _tits_t #_tQualifierType_t_t _ttype_t.
 
XMLAttributes_tCVTerm_getResources (CVTerm_t *term)
 _tTakes_t _ta_t _tCVTerm_t_t _tstructure_t _tand_t _treturns_t _tthe_t _tresources_t.
 
char * CVTerm_getResourceURI (CVTerm_t *term, unsigned int n)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t _tnth_t _tresource_t _tfor_t _tthis_t CVTerm_t_t.
 
int CVTerm_hasRequiredAttributes (CVTerm_t *term)
 _tChecks_t _tif_t _tthe_t _tCVTerm_t_t _thas_t _tall_t _tthe_t _trequired_t _tattributes_t.
 
CVTerm_tCVTerm_removeNestedCVTerm (CVTerm_t *cvt, unsigned int n)
 _tRemoves_t _tthe_t _tnth_t _tCVTerm_t_t _tin_t _tthe_t _tlist_t _tof_t _tCVTerm_t_t'_ts_t _tof_t _tthis_t _tCVTerm_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
int CVTerm_removeResource (CVTerm_t *term, const char *resource)
 _tRemoves_t _ta_t _tresource_t _tfrom_t _tthe_t _tCVTerm_t_t.
 
int CVTerm_setBiologicalQualifierType (CVTerm_t *term, BiolQualifierType_t type)
 _tSets_t _tthe_t #_tBiolQualifierType_t_t _tof_t _tthis_t CVTerm_t_t.
 
int CVTerm_setBiologicalQualifierTypeByString (CVTerm_t *term, const char *qualifier)
 _tSets_t _tthe_t #_tBiolQualifierType_t_t _tof_t _tthis_t CVTerm_t_t.
 
int CVTerm_setModelQualifierType (CVTerm_t *term, ModelQualifierType_t type)
 _tSets_t _tthe_t #_tModelQualifierType_t_t _tof_t _tthis_t CVTerm_t_t.
 
int CVTerm_setModelQualifierTypeByString (CVTerm_t *term, const char *qualifier)
 _tSets_t _tthe_t #_tModelQualifierType_t_t _tof_t _tthis_t CVTerm_t_t.
 
int CVTerm_setQualifierType (CVTerm_t *term, QualifierType_t type)
 _tSets_t _tthe_t #_tQualifierType_t_t _tof_t _tthis_t CVTerm_t_t.
 
ModelQualifierType_t ModelQualifierType_fromString (const char *s)
 _tThis_t _tmethod_t _ttakes_t _ta_t _tstring_t _tand_t _treturns_t _ta_t _tmodel_t _tqualifier_t _trepresenting_t _tthe_t _tstring_t.
 
const char * ModelQualifierType_toString (ModelQualifierType_t type)
 _tThis_t _tmethod_t _ttakes_t _ta_t _tmodel_t _tqualifier_t _ttype_t _tcode_t _tand_t _treturns_t _ta_t _tstring_t _trepresenting_t _tthe_t _tcode_t.
 

Detailed Description

Definition of a CVTerm_t class for adding annotations to a Model_t.

Author
Sarah Keating

Enumeration Type Documentation

◆ BiolQualifierType_t

@_tenum_t _tBiolQualifierType_t_t

_tEnumeration_t _tof_t _tpossible_t <_tem_t>_tbiological_t _tqualifiers_t</_tem_t> _tused_t _tfor_t _tannotations_t. _tAnnotations_t _twith_t _tthis_t _ttype_t _tof_t _tqualifier_t _texpress_t _ta_t _trelationship_t _tbetween_t _tan_t _tannotation_t _tresource_t _tand_t _tthe_t <_tem_t>_tbiological_t _tconcept_t</_tem_t> _trepresented_t _tby_t _ta_t _tgiven_t _tobject_t _tin_t _tthe_t _tmodel_t. _tThe_t _tdiagram_t _tbelow_t _tillustrates_t _tthe_t _trelationship_t _tin_t _tthis_t _tcase_t:

@_timage_t _thtml_t _tbiology_t-_tqualifiers_t._tpng_t "_tRelationship_t _texpressed_t _tby_t _tbiological_t _tqualifiers_t" @_timage_t _tlatex_t _tbiology_t-_tqualifiers_t._tpng_t "_tRelationship_t _texpressed_t _tby_t _tbiological_t _tqualifiers_t" <_tbr_t>

Enumerator
BQB_IS 

The biological entity represented by the object in the model is identical to the subject of the referenced resource.

BQB_HAS_PART 

The biological entity represented by the object in the model includes the subject of the referenced resource.

BQB_IS_PART_OF 

The biological entity represented by the object in the model is a physical or logical part of the subject of the referenced resource. For example, this could be used to indicate that the molecular entity represented by a given object in the model is part of the referenced molecular complex.

BQB_IS_VERSION_OF 

The biological entity represented by the object in the model is a version or an instance of the subject of the referenced resource.

BQB_HAS_VERSION 

The subject of the referenced resource is a version or an instance of the biological entity represented by the model element.

BQB_IS_HOMOLOG_TO 

The biological entity represented by the object in the model is homologous to the subject of the referenced resource.

BQB_IS_DESCRIBED_BY 

The biological entity represented by the object in the model is described by the subject of the referenced resource. This could be used, for example, to link a species or a parameter to the literature that describes the concentration of that species or the value of that parameter.

BQB_IS_ENCODED_BY 

The biological entity represented by the object in the model is encoded, directly or transitively, by the subject of the referenced resource.

BQB_ENCODES 

The biological entity represented by the object in the model encodes directly or transitively the subject of the referenced resource.

BQB_OCCURS_IN 

The biological entity represented by the object in the model is physically limited to a location. The location is the subject of the referenced resource.

BQB_HAS_PROPERTY 

The subject of the referenced resource is a property of the biological entity represented by the model element.

BQB_IS_PROPERTY_OF 

The biological entity represented by the object in the model is a property of the referenced resource.

BQB_HAS_TAXON 

The biological entity represented by the object in the model is taxonomically restricted, where the restriction is the subject of the referenced resource. This relation may be used to ascribe a species restriction to a biochemical reaction.

BQB_UNKNOWN 

The relationship is unknown.

◆ ModelQualifierType_t

@_tenum_t _tModelQualifierType_t_t

_tEnumeration_t _tof_t _tpossible_t <_tem_t>_tmodel_t _tqualifiers_t</_tem_t> _tused_t _tfor_t _tannotations_t. _tAnnotations_t _twith_t _tthis_t _ttype_t _tof_t _tqualifier_t _texpress_t _ta_t _trelationship_t _tbetween_t _tan_t _tannotation_t _tresource_t _tand_t _tthe_t <_tem_t>_tmodeling_t _tconcept_t</_tem_t> _trepresented_t _tby_t _ta_t _tgiven_t _tobject_t _tin_t _tthe_t _tmodel_t. _tThe_t _tdiagram_t _tbelow_t _tillustrates_t _tthe_t _trelationship_t _tin_t _tthis_t _tcase_t:

@_timage_t _thtml_t _tmodel_t-_tqualifiers_t._tpng_t "_tRelationship_t _texpressed_t _tby_t _tmodel_t _tqualifiers_t" @_timage_t _tlatex_t _tmodel_t-_tqualifiers_t._tpng_t "_tRelationship_t _texpressed_t _tby_t _tmodel_t _tqualifiers_t" <_tbr_t>

Enumerator
BQM_IS 

The modeling entity represented by the object in the model is identical to the subject of the referenced resource.

BQM_IS_DESCRIBED_BY 

The modeling entity represented by the object in the model is described by the subject of the referenced resource. For example, this relationship could be used to link a model element to a document (such as a paper published in the literature) describing the element.

BQM_IS_DERIVED_FROM 

The modeling entity represented by the object in the model is derived from or adapted from the referenced resource. This relation could be used, for instance, to express a refinement or adaptation in usage of a model component located elsewere.

BQM_IS_INSTANCE_OF 

The modeling entity represented by the object in the model is is an instance of the subject of the referenced resource. For instance, this qualifier might be used to link a specific model with its generic form.

BQM_HAS_INSTANCE 

The modeling entity represented by the object in the model has for instance (is a class of) the subject of the referenced resource. For instance, this qualifier might be used to link a generic model with its specific forms.

BQM_UNKNOWN 

The relationship is unknown.

◆ QualifierType_t

@_tclass_t _tdoc_cvterm_common_description_t

@_tpar_t _tThe_t _tRDF_t _telement_t _tused_t _tin_t _tthe_t _tSBML_t _tformat_t _tfor_t _treferring_t _tto_t _texternal_t _tentities_t _tis_t <_tcode_t>&_tlt_t;_trdf_t:_tDescription_t&_tgt_t;</_tcode_t>, _twith_t _ta_t <_tcode_t>&_tlt_t;_trdf_t:_tBag_t&_tgt_t;</_tcode_t> _telement_t _tinside_t _tof_t _tit_t _tcontaining_t _tone_t _tor_t _tmore_t <_tcode_t>&_tlt_t;_trdf_t:_tli_t&_tgt_t;</_tcode_t> _telements_t. _tThe_t _tfollowing_t _ttemplate_t _tillustrates_t _tthe_t _tstructure_t: <_tpre_t _tclass_t="_tfragment_t"> &_tlt_t;_trdf_t:_tDescription_t _trdf_t:_tabout_t=&_tquot_t;#<_tspan_t _tstyle_t="_tborder_t-_tbottom_t: _t1px_t _tsolid_t _tblack_t">_tmeta_t _tid_t</_tspan_t>&_tquot_t;&_tgt_t; &_tnbsp_t;&_tnbsp_t;<_tspan_t _tstyle_t="_tbackground_t-_tcolor_t: #_tddd_t; _tborder_t-_tbottom_t: _t2px_t _tdotted_t #_t888_t">_tHISTORY_t</_tspan_t> &_tnbsp_t;&_tnbsp_t;&_tlt_t;<_tspan_t _tstyle_t="_tbackground_t-_tcolor_t: #_tbbb_t">_tRELATION_ELEMENT_t</_tspan_t>&_tgt_t; &_tnbsp_t;&_tnbsp_t;&_tnbsp_t;&_tnbsp_t;&_tlt_t;_trdf_t:_tBag_t&_tgt_t; &_tnbsp_t;&_tnbsp_t;&_tnbsp_t;&_tnbsp_t;&_tlt_t;_trdf_t:_tli_t _trdf_t:_tresource_t=&_tquot_t;<_tspan_t _tstyle_t="_tbackground_t-_tcolor_t: #_td0d0ee_t">_tresource_t _tURI_t</_tspan_t>&_tquot_t; /&_tgt_t; &_tnbsp_t;&_tnbsp_t;&_tnbsp_t;&_tnbsp_t;<_tspan_t _tstyle_t="_tbackground_t-_tcolor_t: #_tedd_t">...</_tspan_t> &_tnbsp_t;&_tnbsp_t;&_tnbsp_t;&_tnbsp_t;&_tlt_t;/_trdf_t:_tBag_t&_tgt_t; &_tnbsp_t;&_tnbsp_t;&_tlt_t;/<_tspan_t _tstyle_t="_tbackground_t-_tcolor_t: #_tbbb_t">_tRELATION_ELEMENT_t</_tspan_t>&_tgt_t; &_tnbsp_t;&_tnbsp_t;<_tspan_t _tstyle_t="_tbackground_t-_tcolor_t: #_tedd_t">...</_tspan_t> &_tlt_t;/_trdf_t:_tDescription_t&_tgt_t; </_tpre_t> _tIn_t _tthe_t _ttemplate_t _tabove_t, _tthe_t _tplaceholder_t <_tspan_t _tclass_t="_tcode_t" _tstyle_t="_tborder_t-_tbottom_t: _t1px_t _tsolid_t _tblack_t">_tmeta_t _tid_t</_tspan_t> _tstands_t _tfor_t _tthe_t _telement_t'_ts_t _tmeta_t _tidentifier_t, _twhich_t _tis_t _ta_t _tfield_t _tavailable_t _ton_t _tall_t _tSBML_t _tcomponents_t _tderived_t _tfrom_t _tthe_t _tSBase_t _tbase_t _tobject_t _tclass_t. _tThe_t <_tspan_t _tstyle_t="_tborder_t-_tbottom_t: _t2px_t _tdotted_t #_t888_t">_tdotted_t</_tspan_t> _tportions_t _tare_t _toptional_t, _tand_t _tthe_t _tellipses_t <_tspan_t _tclass_t="_tcode_t" _tstyle_t="_tbackground_t-_tcolor_t: #_tedd_t">...</_tspan_t> _tare_t _tplaceholders_t _tfor_t _tzero_t _tor_t _tmore_t _telements_t _tof_t _tthe_t _tsame_t _tform_t _tas_t _tthe_t _timmediately_t _tpreceding_t _telement_t.

@_tenum_t _tQualifierType_t_t

_tEnumeration_t _tused_t _tto_t _tindicate_t _tthe_t _ttype_t _tof_t <_ta_t _ttarget_t="_blank_t" _thref_t="_thttp_t://_tco_t._tmbine_t._torg_t/_tstandards_t/_tqualifiers_t/">_tBioModels_t._tnet_t</_ta_t> _tqualifier_t _tin_t _ta_t _tgiven_t _tCVTerm_t _tobject_t. _tThe_t _tqualification_t _tof_t _tan_t _tannotation_t _tis_t _timportant_t _tto_t _tconvey_t _tthe_t _trelationship_t _tbetween_t _ta_t _tgiven_t _tmodel_t _tcomponent_t _tand_t _tthe_t _tresource_t _tused_t _tto_t _tannotate_t _tit_t. _tThis_t _trelationship_t _tis_t _trarely_t _tone_t-_tto_t-_tone_t, _tand_t _tthe_t _tinformation_t _tcontent_t _tof_t _tan_t _tannotation_t _tis_t _tgreatly_t _tincreased_t _tif_t _tone_t _tknows_t _twhat_t _tit_t _trepresents_t (_tas_t _topposed_t _tto_t _tknowing_t _tmerely_t _tthat_t _tthe_t _ttwo_t "_tare_t _trelated_t _tsomehow_t").

_tIn_t _tthe_t _tSBML_t/_tMIRIAM_t/_tBioModels_t._tnet_t _tscheme_t _tof_t _tthings_t, _tthere_t _tare_t _tcurrently_t _ttwo_t _tkinds_t _tof_t _tqualifiers_t. _tThey_t _tare_t _tused_t _tfor_t _tdifferent_t _tpurposes_t. _tOne_t _tpurpose_t _tis_t _tin_t _tthe_t _trefinement_t _tof_t _tthe_t _trelationship_t _tbetween_t _tan_t _tannotation_t _tresource_t _tand_t _tthe_t <_tem_t>_tmodeling_t _tconcept_t</_tem_t> _trepresented_t _tby_t _ta_t _tmodel_t _telement_t. _tThe_t _tsecond_t _tpurpose_t _tis_t _tin_t _tthe_t _trefinement_t _tof_t _tthe_t _trelationship_t _tbetween_t _tan_t _tannotation_t _tresource_t _tand_t _tthe_t <_tem_t>_tbiological_t _tobject_t</_tem_t> _trepresented_t _tby_t _ta_t _tmodel_t _telement_t. _tIn_t _tlibSBML_t, _teach_t _tof_t _tthese_t _ttwo_t _tcategories_t _tof_t _tqualifiers_t _thave_t _ttheir_t _town_t @_tif_t _tclike_t _tenumerations_t: @_telse_t _tset_t _tof_t _tconstants_t:@_tendif_t @_tif_t _tclike_t #_tModelQualifierType_t_t _tfor_t _tthe_t _tformer_t _ttype_t, _tand_t #_tBiolQualifierType_t_t _tfor_t _tthe_t _tlatter_t@_telse_t _tthose_t _twhose_t _tnames_t _tbegin_t _twith_t <_tcode_t>_tBQM__t</_tcode_t> _tfor_t _tthe_t _tformer_t _ttype_t, _tand_t _tthose_t _twhose_t _tnames_t _tbegin_t _twith_t <_tcode_t>_tBQB__t</_tcode_t> _tfor_t _tthe_t _tlatter_t.@_tendif_t.

_tOne_t _tcan_t _tview_t _tthe_t _tannotation_t _tof_t _ta_t _tmodel_t _tcomponent_t _tas_t _ta_t _tstatement_t _tin_t _tthe_t _tform_t _tof_t _ta_t @_tem_t _ttriple_t. _tThe_t _tresource_t _tused_t _tin_t _tthe_t _tannotation_t _tis_t _tthe_t @_tem_t _tobject_t, _twhile_t _tthe_t _tqualifier_t _tis_t _tthe_t @_tem_t _tpredicate_t. _tIn_t _tsituations_t _twhere_t _ta_t _tmodel_t _tqualifier_t _tis_t _tused_t, _tthe_t @_tem_t _tsubject_t _tof_t _tthe_t _trelation_t _tis_t _tthe_t _tmodeling_t _tconcept_t _trepresented_t _tby_t _tthe_t _tmodel_t _tcomponent_t _treferenced_t _tby_t _tthe_t _tannotation_t. _tThe_t _tmodeling_t _tconcept_t _tmay_t _tbe_t _tthe_t _tmodel_t _titself_t, _ta_t _tmathematical_t _tconstruct_t, _tor_t _ta_t _thypothesis_t _tthat_t _tis_t _tproposed_t, _tchanging_t _tthe_t _tway_t _twe_t _tpreviously_t _tunderstood_t _tthe_t _tmodel_t, _tetc_t. _tConversely_t, _tin_t _tsituations_t _twhere_t _ta_t _tbiology_t _tqualifier_t _tis_t _tused_t, _tthe_t @_tem_t _tsubject_t _tof_t _tthe_t _trelation_t _tis_t _tthe_t _tbiological_t _tor_t _tbiochemical_t _tobject_t _trepresented_t _tby_t _tthe_t _tenclosing_t _tmodel_t _telement_t.

Enumerator
MODEL_QUALIFIER 

The qualifier is a model qualifier.

BIOLOGICAL_QUALIFIER 

The qualifier is a biological qualifier.

UNKNOWN_QUALIFIER 

The qualifier has not been set or is unknown.

Function Documentation

◆ BiolQualifierType_fromString()

BiolQualifierType_t BiolQualifierType_fromString ( const char *  s)

_tThis_t _tmethod_t _ttakes_t _ta_t _tstring_t _tand_t _treturns_t _ta_t _tbiol_t _tqualifier_t _trepresenting_t _tthe_t _tstring_t.

_tThis_t _tmethod_t _ttakes_t _ta_t _tstring_t _tas_t _targument_t _tand_t _treturns_t _ta_t _tbiol_t _tqualifier_t _ttype_t _tcorresponding_t _tto_t _tthat_t _tstring_t. _tFor_t _texample_t, _tpassing_t _tit_t _tthe_t _tstring_t <_tcode_t>"_thasVersion_t"</_tcode_t> _twill_t _treturn_t _tthe_t _tqualifier_t @_tsbmlconstant_t{_tBQB_HAS_VERSION_t, _tBiolQualifierType_t_t}.

@_tparam_t _ts_t _tthe_t _tstring_t _tto_t _ttranslate_t _tto_t _ta_t @_tif_t _tclike_t #_tBiolQualifierType_t_t _tvalue_t@_telse_t _tlibSBML_t _tconstant_t _tvalue_t _trepresenting_t _ta_t _tbiological_t _tqualifier_t@_tendif_t.

@_treturn_t _ta_t _tlibSBML_t _tqualifier_t _tenumeration_t _tvalue_t _tfor_t _tthe_t _tgiven_t _thuman_t _treadable_t _tqualifier_t _tname_t.

@_tif_t _tconly_t @_tmemberof_t _tCVTerm_t_t @_tendif_t

◆ BiolQualifierType_toString()

const char * BiolQualifierType_toString ( BiolQualifierType_t  type)

_tThis_t _tmethod_t _ttakes_t _ta_t _tbiol_t _tqualifier_t _ttype_t _tcode_t _tand_t _treturns_t _ta_t _tstring_t _trepresenting_t _tthe_t _tcode_t.

_tThis_t _tmethod_t _ttakes_t _ta_t _tbiol_t _tqualifier_t _ttype_t _tas_t _targument_t _tand_t _treturns_t _ta_t _tstring_t _tname_t _tcorresponding_t _tto_t _tthat_t _tcode_t. _tFor_t _texample_t, _tpassing_t _tit_t _tthe_t _tqualifier_t @_tsbmlconstant_t{_tBQB_HAS_VERSION_t, _tBiolQualifierType_t_t} _twill_t _treturn_t _tthe_t _tstring_t <_tcode_t>"_thasVersion_t"</_tcode_t>.

@_tparam_t _ttype_t _tthe_t @_tif_t _tclike_t #_tBiolQualifierType_t_t@_tendif_t _tvalue_t _tto_t _ttranslate_t. @_tifnot_t _tclike_t _tThe_t _tvalue_t _tshould_t _tbe_t _ta_t _tconstant_t _twhose_t _tname_t _tbegins_t _twith_t @_tc_t _tBQB__t, _tsuch_t _tas_t (_tfor_t _texample_t) @_tsbmlconstant_t{_tBQB_IS_t, _tBiolQualifierType_t_t}.@_tendif_t

@_treturn_t _ta_t _thuman_t _treadable_t _tqualifier_t _tname_t _tfor_t _tthe_t _tgiven_t _ttype_t.

@_tnote_t _tThe_t _tcaller_t _tdoes_t _tnot_t _town_t _tthe_t _treturned_t _tstring_t _tand_t _tis_t _ttherefore_t _tnot_t _tallowed_t _tto_t _tmodify_t _tit_t.

@_tif_t _tconly_t @_tmemberof_t _tCVTerm_t_t @_tendif_t

◆ CVTerm_addNestedCVTerm()

int CVTerm_addNestedCVTerm ( CVTerm_t cvt,
const CVTerm_t term 
)

_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tCVTerm_t_t _tto_t _tthe_t _tlist_t _tof_t _tnested_t _tCVTerm_t_t'_ts_t _twithin_t _tthis_t _tCVTerm_t_t _tstructure_t.

@_tparam_t _tcvt_t _tthe_t _tstructure_t _tto_t _tadd_t _tthe_t _tCVTerm_t_t _tto_t. @_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tto_t _tassign_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_addResource()

int CVTerm_addResource ( CVTerm_t term,
const char *  resource 
)

_tAdds_t _ta_t _tresource_t _tto_t _tthe_t _tCVTerm_t_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tresource_t _tstring_t _trepresenting_t _tthe_t _tresource_t _te_t._tg_t. _thttp_t://_twww_t._tgeneontology_t._torg_t/#_tGO_t:_t0005892_t

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

@_tnote_t _tthis_t _tmethod_t _tadds_t _tthe_t _tname_t "_trdf_t:_tresource_t" _tto_t _tthe_t _tattribute_t _tprior_t _tto_t _tadding_t _tit_t _tto_t _tthe_t _tresources_t _tin_t _tthis_t _tCVTerm_t_t.

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_clone()

CVTerm_t * CVTerm_clone ( const CVTerm_t term)

_tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tCVTerm_t_t _tstructure_t

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t _tto_t _tbe_t _tcopied_t.

@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthe_t _tgiven_t _tCVTerm_t_t _tstructure_t.

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_createFromNode()

CVTerm_t * CVTerm_createFromNode ( const XMLNode_t node)

_tCreate_t _ta_t _tnew_t _tCVTerm_t_t _tfrom_t _tthe_t _tgiven_t #_tXMLNode_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

_tRDFAnnotations_t _twithin_t _ta_t _tmodel_t _tare_t _tstored_t _tas_t _ta_t _tList_t_t _tof_t _tCVTerm_t_t'_ts_t. _tThis_t _tallows_t _tthe_t _tuser_t _tto_t _tinteract_t _twith_t _tthe_t _tCVTerm_t_t'_ts_t _tdirectly_t. _tWhen_t _tLibSBML_t _treads_t _tin_t _ta_t _tmodel_t _tcontaining_t _tRDFAnnotations_t _tit_t _tparses_t _tthem_t _tinto_t _ta_t List_t _tof_t _tCVTerm_t_t'_ts_t _tand_t _twhen_t _twriting_t _ta_t _tmodel_t _tit_t _tparses_t _tthe_t _tCVTerm_t_t'_ts_t _tinto_t _tthe_t _tappropriate_t _tannotation_t _tstructure_t. _tThis_t _tfunction_t _tcreates_t _ta_t _tCVTerm_t_t _tfrom_t _tthe_t #_tXMLNode_t_t _tsupplied_t.

@_tparam_t _tnode_t _tan_t #_tXMLNode_t_t _trepresenting_t _ta_t _tCVTerm_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tCVTerm_t_t _tstructure_t.

@_tnote_t _tthis_t _tmethod_t _tassumes_t _tthat_t _tthe_t #_tXMLNode_t_t _tis_t _tof_t _tthe_t _tcorrect_t _tform_t

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_createWithQualifierType()

CVTerm_t * CVTerm_createWithQualifierType ( QualifierType_t  type)

_tCreates_t _ta_t _tnew_t _tCVTerm_t_t _twith_t _tthe_t _tgiven_t #_tQualifierType_t_t _tvalue_t @_tp_t _ttype_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

_tThe_t _tpossible_t _tQualifierTypes_t _tare_t @_tsbmlconstant_t{_tMODEL_QUALIFIER_t, _tQualifierType_t_t} _tand_t @_tsbmlconstant_t{_tBIOLOGICAL_QUALIFIER_t, _tQualifierType_t_t}.

@_tparam_t _ttype_t _ta_t #_tQualifierType_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tCVTerm_t_t _tstructure_t.

@_tmemberof_t _tCVTerm_t_t

_tCreates_t _ta_t _tnew_t _tCVTerm_t_t _twith_t _tthe_t _tgiven_t #_tQualifierType_t_t _tvalue_t @_tp_t _ttype_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tcond_t _tdoxygenIgnored_t

◆ CVTerm_free()

void CVTerm_free ( CVTerm_t c)

_tFrees_t _tthe_t _tgiven_t _tCVTerm_t_t _tstructure_t.

@_tparam_t _tc_t _tthe_t _tCVTerm_t_t _tstructure_t _tto_t _tbe_t _tfreed_t.

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_getBiologicalQualifierType()

BiolQualifierType_t CVTerm_getBiologicalQualifierType ( CVTerm_t term)

_tTakes_t _ta_t _tCVTerm_t_t _tstructure_t _tand_t _treturns_t _tthe_t #_tBiolQualifierType_t_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t _twhose_t #_tBiolQualifierType_t_t _tvalue_t _tis_t _tsought_t.

@_treturn_t _tthe_t #_tBiolQualifierType_t_t _tvalue_t _tof_t _tthis_t _tCVTerm_t_t _tor_t @_tsbmlconstant_t{_tBQB_UNKNOWN_t, _tBiolQualifierType_t_t} (_tdefault_t).

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_getListNestedCVTerms()

const List_t * CVTerm_getListNestedCVTerms ( const CVTerm_t cvt)

_tReturns_t _ta_t _tlist_t _tof_t _tCVTerm_t_t _tstructures_t _tcontained_t _twithin_t _tthis_t _tCVTerm_t_t _tstructure_t.

@_tparam_t _tcvt_t _tthe_t _tstructure_t _tto_t _tgetListNestedCVTerms_t _tfrom_t.

@_treturn_t _tthe_t _tlist_t _tof_t _tCVTerm_t_t'_ts_t _tfor_t _tthis_t _tCVTerm_t_t _tstructure_t.

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_getModelQualifierType()

ModelQualifierType_t CVTerm_getModelQualifierType ( CVTerm_t term)

_tTakes_t _ta_t _tCVTerm_t_t _tstructure_t _tand_t _treturns_t _tthe_t #_tModelQualifierType_t_t _ttype_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t _twhose_t #_tModelQualifierType_t_t _tis_t _tsought_t.

@_treturn_t _tthe_t #_tModelQualifierType_t_t _tvalue_t _tof_t _tthis_t _tCVTerm_t_t _tor_t @_tsbmlconstant_t{_tBQM_UNKNOWN_t, _tModelQualifierType_t_t} (_tdefault_t).

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_getNestedCVTerm()

const CVTerm_t * CVTerm_getNestedCVTerm ( const CVTerm_t cvt,
unsigned int  n 
)

_tReturns_t _tthe_t _tnth_t _tCVTerm_t_t _tin_t _tthe_t _tlist_t _tof_t _tCVTerm_t_t'_ts_t _tof_t _tthis_t _tCVTerm_t_t _tstructure_t.

@_tparam_t _tcvt_t _tthe_t _tstructure_t _tto_t _tget_t _tCVTerm_t_t'_ts_t _tfrom_t. @_tparam_t _tn_t _tunsigned_t _tint_t _tthe_t _tindex_t _tof_t _tthe_t _tCVTerm_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tnth_t _tCVTerm_t_t _tin_t _tthe_t _tlist_t _tof_t _tCVTerm_t_t'_ts_t _tfor_t _tthis_t _tCVTerm_t_t _tstructure_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tobject_t _texists_t.

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_getNumNestedCVTerms()

unsigned int CVTerm_getNumNestedCVTerms ( const CVTerm_t cvt)

_tReturns_t _tthe_t _tnumber_t _tof_t _tCVTerm_t_t _tstructures_t _tnested_t _twithin_t _tthis_t _tCVTerm_t_t _tstructure_t.

@_tparam_t _tcvt_t _tthe_t _tstructure_t _tto_t _tget_t _tthe_t _tnumber_t _tof_t _tnested_t _tCVTerms_t _tfrom_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tCVTerm_t_t _tstructures_t _tnested_t _twithin_t _tthis_t _tCVTerm_t_t _tstructure_t.

@_tnote_t _tthis_t _tdoes_t _tnot_t _trecurse_t _tthrough_t _tpotentially_t _tnested_t _tCVTerm_t _tobjects_t _twithin_t _ta_t _tgiven_t _tnested_t _tCVTerm_t. _tIt_t _treturns_t _tthe_t _tnumber_t _tof_t _tterms_t _timmediately_t _tnested_t _twithin_t _tthis_t _tCVTerm_t_t.

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_getNumResources()

unsigned int CVTerm_getNumResources ( CVTerm_t term)

_tReturns_t _tthe_t _tnumber_t _tof_t _tresources_t _tfor_t _tthis_t CVTerm_t_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t _twhose_t _tresources_t _tare_t _tsought_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tresources_t _tin_t _tthe_t _tset_t _tof_t _tXMLAttributes_t _tof_t _tthis_t CVTerm_t_t.

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_getQualifierType()

QualifierType_t CVTerm_getQualifierType ( CVTerm_t term)

_tTakes_t _ta_t _tCVTerm_t_t _tstructure_t _tand_t _treturns_t _tits_t #_tQualifierType_t_t _ttype_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t _twhose_t #_tQualifierType_t_t _tvalue_t _tis_t _tsought_t.

@_treturn_t _tthe_t #_tQualifierType_t_t _tvalue_t _tof_t _tthis_t _tCVTerm_t_t _tor_t @_tsbmlconstant_t{_tUNKNOWN_QUALIFIER_t, _tQualifierType_t_t} (_tdefault_t).

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_getResources()

XMLAttributes_t * CVTerm_getResources ( CVTerm_t term)

_tTakes_t _ta_t _tCVTerm_t_t _tstructure_t _tand_t _treturns_t _tthe_t _tresources_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t _twhose_t _tresources_t _tare_t _tsought_t.

@_treturn_t _tthe_t _tXMLAttributes_t_t _tthat_t _tstore_t _tthe_t _tresources_t _tof_t _tthis_t _tCVTerm_t_t.

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_getResourceURI()

char * CVTerm_getResourceURI ( CVTerm_t term,
unsigned int  n 
)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t _tnth_t _tresource_t _tfor_t _tthis_t CVTerm_t_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t. @_tparam_t _tn_t _tthe_t _tindex_t _tof_t _tthe_t _tresource_t _tto_t _tquery_t.

@_treturn_t _tstring_t _trepresenting_t _tthe_t _tvalue_t _tof_t _tthe_t _tnth_t _tresource_t _tin_t _tthe_t _tset_t _tof_t _tXMLAttributes_t _tof_t _tthis_t CVTerm_t_t.

@_tnote_t _tSince_t _tthe_t _tvalues_t _tof_t _tthe_t _tresource_t _tattributes_t _tin_t _ta_t _tCVTerm_t_t _tare_t _tURIs_t _tthis_t _tis_t _ta_t _tconvenience_t _tfunction_t _tto_t _tfacilitate_t _tinteraction_t _twith_t _tthe_t _tCVTerm_t_t _tstructure_t.

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_hasRequiredAttributes()

int CVTerm_hasRequiredAttributes ( CVTerm_t term)

_tChecks_t _tif_t _tthe_t _tCVTerm_t_t _thas_t _tall_t _tthe_t _trequired_t _tattributes_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tCVTerm_t_t _thas_t _tall_t _tthe_t _trequired_t _telements_t, _totherwise_t @_tc_t _t0_t (_tfalse_t) _twill_t _tbe_t _treturned_t, _tincluding_t _tif_t _tan_t _tinvalid_t _tCVTerm_t_t _twas_t _tprovided_t.

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_removeNestedCVTerm()

CVTerm_t * CVTerm_removeNestedCVTerm ( CVTerm_t cvt,
unsigned int  n 
)

_tRemoves_t _tthe_t _tnth_t _tCVTerm_t_t _tin_t _tthe_t _tlist_t _tof_t _tCVTerm_t_t'_ts_t _tof_t _tthis_t _tCVTerm_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tcvt_t _tthe_t _tstructure_t _tto_t _tget_t _tCVTerm_t_t'_ts_t _tfrom_t. @_tparam_t _tn_t _tunsigned_t _tint_t _tthe_t _tindex_t _tof_t _tthe_t _tCVTerm_t_t _tto_t _tretrieve_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnth_t _tCVTerm_t_t _tin_t _tthe_t _tlist_t _tof_t _tCVTerm_t_t'_ts_t _tfor_t _tthis_t _tCVTerm_t_t _tstructure_t.

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_removeResource()

int CVTerm_removeResource ( CVTerm_t term,
const char *  resource 
)

_tRemoves_t _ta_t _tresource_t _tfrom_t _tthe_t _tCVTerm_t_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t. @_tparam_t _tresource_t _tstring_t _trepresenting_t _tthe_t _tresource_t _te_t._tg_t. _thttp_t://_twww_t._tgeneontology_t._torg_t/#_tGO_t:_t0005892_t

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

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_setBiologicalQualifierType()

int CVTerm_setBiologicalQualifierType ( CVTerm_t term,
BiolQualifierType_t  type 
)

_tSets_t _tthe_t #_tBiolQualifierType_t_t _tof_t _tthis_t CVTerm_t_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _ttype_t _tthe_t #_tBiolQualifierType_t_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} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tnote_t _tif_t _tthe_t #_tQualifierType_t_t _tfor_t _tthis_t _tstructure_t _tis_t _tnot_t @_tsbmlconstant_t{_tBIOLOGICAL_QUALIFIER_t, _tQualifierType_t_t} _tthen_t _tthe_t #_tBiolQualifierType_t_t _twill_t _tdefault_t _tto_t @_tsbmlconstant_t{_tBQB_UNKNOWN_t, _tBiolQualifierType_t_t}.

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_setBiologicalQualifierTypeByString()

int CVTerm_setBiologicalQualifierTypeByString ( CVTerm_t term,
const char *  qualifier 
)

_tSets_t _tthe_t #_tBiolQualifierType_t_t _tof_t _tthis_t CVTerm_t_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tqualifier_t _tthe_t _tstring_t _trepresenting_t _ta_t _tbiol_t _tqualifier_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} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tnote_t _tif_t _tthe_t #_tQualifierType_t_t _tfor_t _tthis_t _tstructure_t _tis_t _tnot_t @_tsbmlconstant_t{_tBIOLOGICAL_QUALIFIER_t, _tQualifierType_t_t} _tthen_t _tthe_t #_tBiolQualifierType_t_t _twill_t _tdefault_t _tto_t @_tsbmlconstant_t{_tBQB_UNKNOWN_t, _tBiolQualifierType_t_t}.

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_setModelQualifierType()

int CVTerm_setModelQualifierType ( CVTerm_t term,
ModelQualifierType_t  type 
)

_tSets_t _tthe_t #_tModelQualifierType_t_t _tof_t _tthis_t CVTerm_t_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _ttype_t _tthe_t #_tModelQualifierType_t_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} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tnote_t _tif_t _tthe_t #_tQualifierType_t_t _tfor_t _tthis_t _tstructure_t _tis_t _tnot_t @_tsbmlconstant_t{_tMODEL_QUALIFIER_t, _tQualifierType_t_t} _tthen_t _tthe_t #_tModelQualifierType_t_t _twill_t _tdefault_t _tto_t @_tsbmlconstant_t{_tBQM_UNKNOWN_t, _tModelQualifierType_t_t}.

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_setModelQualifierTypeByString()

int CVTerm_setModelQualifierTypeByString ( CVTerm_t term,
const char *  qualifier 
)

_tSets_t _tthe_t #_tModelQualifierType_t_t _tof_t _tthis_t CVTerm_t_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tqualifier_t _tthe_t _tstring_t _trepresenting_t _ta_t _tmodel_t _tqualifier_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} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tnote_t _tif_t _tthe_t #_tQualifierType_t_t _tfor_t _tthis_t _tstructure_t _tis_t _tnot_t @_tsbmlconstant_t{_tMODEL_QUALIFIER_t, _tQualifierType_t_t} _tthen_t _tthe_t #_tModelQualifierType_t_t _twill_t _tdefault_t _tto_t @_tsbmlconstant_t{_tBQM_UNKNOWN_t, _tModelQualifierType_t_t}.

@_tmemberof_t _tCVTerm_t_t

◆ CVTerm_setQualifierType()

int CVTerm_setQualifierType ( CVTerm_t term,
QualifierType_t  type 
)

_tSets_t _tthe_t #_tQualifierType_t_t _tof_t _tthis_t CVTerm_t_t.

@_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _ttype_t _tthe_t _tQualifierType_t_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_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tCVTerm_t_t

◆ ModelQualifierType_fromString()

ModelQualifierType_t ModelQualifierType_fromString ( const char *  s)

_tThis_t _tmethod_t _ttakes_t _ta_t _tstring_t _tand_t _treturns_t _ta_t _tmodel_t _tqualifier_t _trepresenting_t _tthe_t _tstring_t.

_tThis_t _tmethod_t _ttakes_t _ta_t _tstring_t _tas_t _targument_t _tand_t _treturns_t _ta_t _tmodel_t _tqualifier_t _ttype_t _tcorresponding_t _tto_t _tthat_t _tstring_t. _tFor_t _texample_t, _tpassing_t _tit_t _tthe_t _tstring_t <_tcode_t>"_tisDescribedBy_t"</_tcode_t> _twill_t _treturn_t _tthe_t _tqualifier_t @_tsbmlconstant_t{_tBQM_IS_DESCRIBED_BY_t, _tModelQualifierType_t_t}.

@_tparam_t _ts_t _tthe_t _tstring_t _tto_t _ttranslate_t _tto_t _ta_t @_tif_t _tclike_t #_tModelQualifierType_t_t _tvalue_t@_telse_t _tlibSBML_t _tconstant_t _tvalue_t _trepresenting_t _ta_t _tmodel_t _tqualifier_t@_tendif_t.

@_treturn_t _ta_t _tlibSBML_t _tqualifier_t _tenumeration_t _tvalue_t _tfor_t _tthe_t _tgiven_t _thuman_t _treadable_t _tqualifier_t _tname_t.

@_tif_t _tconly_t @_tmemberof_t _tCVTerm_t_t @_tendif_t

◆ ModelQualifierType_toString()

const char * ModelQualifierType_toString ( ModelQualifierType_t  type)

_tThis_t _tmethod_t _ttakes_t _ta_t _tmodel_t _tqualifier_t _ttype_t _tcode_t _tand_t _treturns_t _ta_t _tstring_t _trepresenting_t _tthe_t _tcode_t.

_tThis_t _tmethod_t _ttakes_t _ta_t _tmodel_t _tqualifier_t _ttype_t _tas_t _targument_t _tand_t _treturns_t _ta_t _tstring_t _tname_t _tcorresponding_t _tto_t _tthat_t _tcode_t. _tFor_t _texample_t, _tpassing_t _tit_t _tthe_t _tqualifier_t @_tsbmlconstant_t{_tBQM_IS_DESCRIBED_BY_t, _tModelQualifierType_t_t} _twill_t _treturn_t _tthe_t _tstring_t <_tcode_t>"_tisDescribedBy_t"</_tcode_t>.

@_tparam_t _ttype_t _tthe_t @_tif_t _tclike_t _tModelQualifierType_t_t@_tendif_t _tvalue_t _tto_t _ttranslate_t. @_tifnot_t _tclike_t _tThe_t _tvalue_t _tshould_t _tbe_t _ta_t _tlibSBML_t _tconstant_t _twhose_t _tname_t _tbegins_t _twith_t @_tc_t _tBQM__t, _tsuch_t _tas_t (_tfor_t _texample_t) @_tsbmlconstant_t{_tBQM_IS_t, _tBiolQualifierType_t_t}.@_tendif_t

@_treturn_t _ta_t _thuman_t _treadable_t _tqualifier_t _tname_t _tfor_t _tthe_t _tgiven_t _tqualifier_t _ttype_t.

@_tnote_t _tThe_t _tcaller_t _tdoes_t _tnot_t _town_t _tthe_t _treturned_t _tstring_t _tand_t _tis_t _ttherefore_t _tnot_t _tallowed_t _tto_t _tmodify_t _tit_t.

@_tif_t _tconly_t @_tmemberof_t _tCVTerm_t_t @_tendif_t